Index (Environment API 0.7.3 API)

A C D E F G I L P R S T V

A

AbstractLifeCycle - Class in com.fredhopper.lifecycle: A base implementation structure for LifeCycle.
AbstractLifeCycle() - Constructor for class com.fredhopper.lifecycle.AbstractLifeCycle
ACCESS_LOG_FILE_ROTATE_PATTERN - Static variable in interface com.fredhopper.environment.Environment: The default suffix for access log files rolling: ".yyyy-MM-dd".
ACCESS_LOG_FILE_SUFFIX - Static variable in interface com.fredhopper.environment.Environment: The default access log files extension: "-access.log".
addStateListener(StateListener) - Method in class com.fredhopper.lifecycle.AbstractLifeCycle: Add a new StateListener
APPLICATION_NAME - Static variable in interface com.fredhopper.environment.Environment: Key of the name of the application: "application.name".
apply(State, State) - Method in interface com.fredhopper.lifecycle.StateListener
AUDIT_LOG_PATTERN - Static variable in interface com.fredhopper.environment.Environment: The default value: "%d{ISO8601} %level %msg%n"

C

changeState(State, State) - Method in class com.fredhopper.lifecycle.AbstractLifeCycle: First changes the state from a current value to a target value.
com.fredhopper.environment - package com.fredhopper.environment
com.fredhopper.lifecycle - package com.fredhopper.lifecycle
Container - Class in com.fredhopper.lifecycle: A container manages an instance of LifeCycle through its stages potentially in different Threads.
Container(LifeCycle) - Constructor for class com.fredhopper.lifecycle.Container: By default, container uses separate threads for life cycle stages and installs a JVM shutdown hook.See Container.Container(LifeCycle, boolean, boolean).
Container(LifeCycle, boolean, boolean) - Constructor for class com.fredhopper.lifecycle.Container: C'tor.
createEnvironment() - Static method in interface com.fredhopper.environment.Environment: Creates an environment populating in order and overriding: System.getenv() System.getProperties() If Environment.ENVIRONMENT_FILE points to a readable file and an instance of Properties can be loaded.
createEnvironment(Map<String, String>) - Static method in interface com.fredhopper.environment.Environment: Create an environment.

D

doInitLifeCycle() - Method in class com.fredhopper.lifecycle.AbstractLifeCycle: Similar to AbstractLifeCycle.initLifeCycle() for inherited classes.
doInitLifeCycle() - Method in class com.fredhopper.lifecycle.Container
doPause() - Method in class com.fredhopper.lifecycle.AbstractLifeCycle: Similar to AbstractLifeCycle.pause() for inherited classes.
doPause() - Method in class com.fredhopper.lifecycle.Container
doResume() - Method in class com.fredhopper.lifecycle.AbstractLifeCycle: Similar to AbstractLifeCycle.resume() for inherited classes.
doResume() - Method in class com.fredhopper.lifecycle.Container
doStartLifeCycle() - Method in class com.fredhopper.lifecycle.AbstractLifeCycle: Similar to AbstractLifeCycle.startLifeCycle() for inherited classes.
doStartLifeCycle() - Method in class com.fredhopper.lifecycle.Container
doStopLifeCycle() - Method in class com.fredhopper.lifecycle.AbstractLifeCycle: Similar to AbstractLifeCycle.stopLifeCycle() for inherited classes.
doStopLifeCycle() - Method in class com.fredhopper.lifecycle.Container

E

Environment - Interface in com.fredhopper.environment: A general abstract presentation of an environment of an application's runtime in JVM.
ENVIRONMENT_FILE - Static variable in interface com.fredhopper.environment.Environment: A Java Properties file that can be used to define an Environment instance with system property "environment.file".
ENVIRONMENT_NAME - Static variable in interface com.fredhopper.environment.Environment: The name that is given to the environment instance; e.g.

F

fromEnvironment(Environment) - Static method in enum com.fredhopper.environment.RuntimeMode: Determine the runtime mode.
fromEnvironmentName(String) - Static method in enum com.fredhopper.environment.RuntimeMode

G

get() - Method in interface com.fredhopper.lifecycle.Stateful
getAccessLogFileName() - Method in interface com.fredhopper.environment.Environment: The access log file name.
getApplicationLogsRoot() - Method in interface com.fredhopper.environment.Environment: The path to application logs root.
getApplicationName() - Method in interface com.fredhopper.environment.Environment: The application name.
getApplicationRoot() - Method in interface com.fredhopper.environment.Environment: The path to application root.
getContextPath() - Method in interface com.fredhopper.environment.Environment: The context path.
getDescription() - Method in interface com.fredhopper.environment.Environment: The description of the environment.
getEnvironmentName() - Method in interface com.fredhopper.environment.Environment: The name of the environment.
getId() - Method in interface com.fredhopper.environment.Environment: The ID of the environment.
getLogFileName() - Method in interface com.fredhopper.environment.Environment: The log file name.
getRotatingAccessLogFileName() - Method in interface com.fredhopper.environment.Environment: The rotating access log file name.
getRotatingLogFilePattern() - Method in interface com.fredhopper.environment.Environment: The rotating log file pattern.
getServerHost() - Method in interface com.fredhopper.environment.Environment: The host name of the server.
getServerPort() - Method in interface com.fredhopper.environment.Environment: The port number of the server.
getState() - Method in class com.fredhopper.lifecycle.AbstractLifeCycle
getState() - Method in class com.fredhopper.lifecycle.Container
getState() - Method in interface com.fredhopper.lifecycle.Stateful
getStateListeners() - Method in class com.fredhopper.lifecycle.AbstractLifeCycle
getStateListeners() - Method in interface com.fredhopper.lifecycle.Stateful
getValue(String) - Method in interface com.fredhopper.environment.Environment: The value of a key.
getValue(String, Supplier<String>) - Method in interface com.fredhopper.environment.Environment: The value of a key with a supplier.

I

ID - Static variable in interface com.fredhopper.environment.Environment: A unique ID that is initialized for an Environment the first time the environment is initialized.
initLifeCycle() - Method in class com.fredhopper.lifecycle.AbstractLifeCycle
initLifeCycle() - Method in interface com.fredhopper.lifecycle.LifeCycle: Initializes the life cycle before invoking LifeCycle.startLifeCycle().

L

LifeCycle - Interface in com.fredhopper.lifecycle: A LifeCycle is an abstraction that owns a State, potentially owns a collection of StateListener to publish changes of state to, changes its state through life cycle methods LifeCycle.initLifeCycle(), LifeCycle.startLifeCycle(), and LifeCycle.stopLifeCycle().
LOG_FILE_ROTATE_PATTERN_SUFFIX - Static variable in interface com.fredhopper.environment.Environment: The pattern suffix to use for Apache Log4j for rolling log files: ".%d{yyyy-MM-dd}".
LOG_FILE_SUFFIX - Static variable in interface com.fredhopper.environment.Environment: The default log files extension: ".log".
LOG_PATTERN - Static variable in interface com.fredhopper.environment.Environment: The default log pattern: "[%d] [%level] [%thread] %msg (%logger{1}:%L)%n%throwable".
LOG_ROOT_SUFFIX - Static variable in interface com.fredhopper.environment.Environment: The application's root directory for logs suffix: ".logs.root".

P

pause() - Method in class com.fredhopper.lifecycle.AbstractLifeCycle
pause() - Method in interface com.fredhopper.lifecycle.Resumable: Makes an attempt to pause the resumable.
publishState(State, State) - Method in class com.fredhopper.lifecycle.AbstractLifeCycle: Propagates a change of State to all the StateListenerregistered with this life cycle object.

R

removeStateListener(StateListener) - Method in class com.fredhopper.lifecycle.AbstractLifeCycle: Remove a registered StateListener
Resumable - Interface in com.fredhopper.lifecycle: A resumable can be paused and resumed.
resume() - Method in class com.fredhopper.lifecycle.AbstractLifeCycle
resume() - Method in interface com.fredhopper.lifecycle.Resumable: Makes an attempt to resume a paused resumable.
ROOT_SUFFIX - Static variable in interface com.fredhopper.environment.Environment: The application's root directory suffix: ".root".
RuntimeMode - Enum in com.fredhopper.environment: A general notion of the mode of the runtime of the application.

S

SERVER_HOST_SUFFIX - Static variable in interface com.fredhopper.environment.Environment
SERVER_PORT_SUFFIX - Static variable in interface com.fredhopper.environment.Environment
SERVER_SHUTDOWN_TOKEN - Static variable in interface com.fredhopper.environment.Environment: The default password to use for shutting down a local HTTP server that the application might be running.
startLifeCycle() - Method in class com.fredhopper.lifecycle.AbstractLifeCycle
startLifeCycle() - Method in interface com.fredhopper.lifecycle.LifeCycle: Starts the life cycle.
State - Enum in com.fredhopper.lifecycle
stateChanged(State, State) - Method in interface com.fredhopper.lifecycle.StateListener: Published a change of State to the listener implementation.
Stateful - Interface in com.fredhopper.lifecycle: Owner of a State.
StateListener - Interface in com.fredhopper.lifecycle: An event listener for a change of State.
stopLifeCycle() - Method in class com.fredhopper.lifecycle.AbstractLifeCycle
stopLifeCycle() - Method in interface com.fredhopper.lifecycle.LifeCycle: Stops the life cycle.

T

toString() - Method in class com.fredhopper.lifecycle.AbstractLifeCycle
toString() - Method in class com.fredhopper.lifecycle.Container

V

valueOf(String) - Static method in enum com.fredhopper.environment.RuntimeMode: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.fredhopper.lifecycle.State: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.fredhopper.environment.RuntimeMode: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.fredhopper.lifecycle.State: Returns an array containing the constants of this enum type, in the order they are declared.

A C D E F G I L P R S T V