Environment (Environment API 0.7.3 API)

```
public interface Environment
```
A general abstract presentation of an environment of an application's runtime in JVM. The environment is a read-only source of key-value pairs in the environment.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACCESS_LOG_FILE_ROTATE_PATTERN` The default suffix for access log files rolling: ".yyyy-MM-dd".
`static String`	`ACCESS_LOG_FILE_SUFFIX` The default access log files extension: "-access.log".
`static String`	`APPLICATION_NAME` Key of the name of the application: "application.name".
`static String`	`AUDIT_LOG_PATTERN` The default value: "%d{ISO8601} %level %msg%n"
`static String`	`ENVIRONMENT_FILE` A Java `Properties` file that can be used to define an `Environment` instance with system property "environment.file".
`static String`	`ENVIRONMENT_NAME` The name that is given to the environment instance; e.g.
`static String`	`ID` A unique ID that is initialized for an `Environment` the first time the environment is initialized.
`static String`	`LOG_FILE_ROTATE_PATTERN_SUFFIX` The pattern suffix to use for Apache Log4j for rolling log files: ".%d{yyyy-MM-dd}".
`static String`	`LOG_FILE_SUFFIX` The default log files extension: ".log".
`static String`	`LOG_PATTERN` The default log pattern: "[%d] [%level] [%thread] %msg (%logger{1}:%L)%n%throwable".
`static String`	`LOG_ROOT_SUFFIX` The application's root directory for logs suffix: ".logs.root".
`static String`	`ROOT_SUFFIX` The application's root directory suffix: ".root".
`static String`	`SERVER_HOST_SUFFIX`
`static String`	`SERVER_PORT_SUFFIX`
`static String`	`SERVER_SHUTDOWN_TOKEN` The default password to use for shutting down a local HTTP server that the application might be running.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static Environment`	`createEnvironment()` Creates an environment populating in order and overriding: `System.getenv()` `System.getProperties()` If `ENVIRONMENT_FILE` points to a readable file and an instance of `Properties` can be loaded.
`static Environment`	`createEnvironment(Map<String,String> environment)` Create an environment.
`String`	`getAccessLogFileName()` The access log file name.
`Path`	`getApplicationLogsRoot()` The path to application logs root.
`String`	`getApplicationName()` The application name.
`Path`	`getApplicationRoot()` The path to application root.
`String`	`getContextPath()` The context path.
`default StringBuilder`	`getDescription()` The description of the environment.
`default String`	`getEnvironmentName()` The name of the environment.
`default String`	`getId()` The ID of the environment.
`String`	`getLogFileName()` The log file name.
`String`	`getRotatingAccessLogFileName()` The rotating access log file name.
`String`	`getRotatingLogFilePattern()` The rotating log file pattern.
`String`	`getServerHost()` The host name of the server.
`int`	`getServerPort()` The port number of the server.
`default String`	`getValue(String key)` The value of a key.
`String`	`getValue(String key, Supplier<String> supplier)` The value of a key with a supplier.

- Field Detail
  - ID
```
static final String ID
```
    A unique ID that is initialized for an Environment the first time the environment is initialized. If multiple Environment instances are used in the same JVM, this is not reliable and should not be used.
  - ENVIRONMENT_FILE
```
static final String ENVIRONMENT_FILE
```
    A Java Properties file that can be used to define an Environment instance with system property "environment.file".
    
    See Also:
    
    Constant Field Values
  - ENVIRONMENT_NAME
```
static final String ENVIRONMENT_NAME
```
    The name that is given to the environment instance; e.g. development, test, production.
    
    See Also:
    
    Constant Field Values
  - APPLICATION_NAME
```
static final String APPLICATION_NAME
```
    Key of the name of the application: "application.name".
    
    See Also:
    
    Constant Field Values
  - ROOT_SUFFIX
```
static final String ROOT_SUFFIX
```
    The application's root directory suffix: ".root".
    
    See Also:
    
    Constant Field Values
  - LOG_ROOT_SUFFIX
```
static final String LOG_ROOT_SUFFIX
```
    The application's root directory for logs suffix: ".logs.root".
    
    See Also:
    
    Constant Field Values
  - LOG_FILE_SUFFIX
```
static final String LOG_FILE_SUFFIX
```
    The default log files extension: ".log".
    
    See Also:
    
    Constant Field Values
  - ACCESS_LOG_FILE_SUFFIX
```
static final String ACCESS_LOG_FILE_SUFFIX
```
    The default access log files extension: "-access.log".
    
    See Also:
    
    Constant Field Values
  - LOG_FILE_ROTATE_PATTERN_SUFFIX
```
static final String LOG_FILE_ROTATE_PATTERN_SUFFIX
```
    The pattern suffix to use for Apache Log4j for rolling log files: ".%d{yyyy-MM-dd}".
    
    See Also:
    
    Constant Field Values
  - ACCESS_LOG_FILE_ROTATE_PATTERN
```
static final String ACCESS_LOG_FILE_ROTATE_PATTERN
```
    The default suffix for access log files rolling: ".yyyy-MM-dd".
    
    See Also:
    
    Constant Field Values
  - LOG_PATTERN
```
static final String LOG_PATTERN
```
    The default log pattern: "[%d] [%level] [%thread] %msg (%logger{1}:%L)%n%throwable".
    
    See Also:
    
    Constant Field Values
  - AUDIT_LOG_PATTERN
```
static final String AUDIT_LOG_PATTERN
```
    The default value: "%d{ISO8601} %level %msg%n"
    
    See Also:
    
    Constant Field Values
  - SERVER_HOST_SUFFIX
```
static final String SERVER_HOST_SUFFIX
```
    See Also:
    
    Constant Field Values
  - SERVER_PORT_SUFFIX
```
static final String SERVER_PORT_SUFFIX
```
    See Also:
    
    Constant Field Values
  - SERVER_SHUTDOWN_TOKEN
```
static final String SERVER_SHUTDOWN_TOKEN
```
    The default password to use for shutting down a local HTTP server that the application might be running.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getId
```
default String getId()
```
    The ID of the environment.
    
    Returns:
    
    the id of the environment
  - getEnvironmentName
```
default String getEnvironmentName()
```
    The name of the environment. The default value is development
    
    Returns:
    
    the name of the environment
    
    See Also:
    
    RuntimeMode
  - getApplicationName
```
String getApplicationName()
```
    The application name.
    
    Returns:
    
    the name of the application configured as application.name.
  - getApplicationRoot
```
Path getApplicationRoot()
```
    The path to application root.
    
    Returns:
    
    the root of the application configured as ${application.name}.root. Can be null.
  - getApplicationLogsRoot
```
Path getApplicationLogsRoot()
```
    The path to application logs root. By default, the implementations might choose to fall back to ${application.name}.root/logs.
    
    Returns:
    
    the root of the application logs. Can be null.
  - getLogFileName
```
String getLogFileName()
```
    The log file name. By default, the implementations might choose to fall back to ${application.name}.log
    
    Returns:
    
    the name of the log files for the application.
  - getRotatingLogFilePattern
```
String getRotatingLogFilePattern()
```
    The rotating log file pattern.
    
    Returns:
    
    the rotating log file pattern potentially include a date/time pattern.
  - getAccessLogFileName
```
String getAccessLogFileName()
```
    The access log file name. By default, implementations might choose to use getLogFileName()- access.log
    
    Returns:
    
    the log file name for access logs of the application.
  - getRotatingAccessLogFileName
```
String getRotatingAccessLogFileName()
```
    The rotating access log file name.
    
    Returns:
    
    the name pattern for rotating access log files.
  - getContextPath
```
String getContextPath()
```
    The context path. By default, it falls back to /${application.name}.
    
    Returns:
    
    the context path at which the application is accessible through HTTP.
  - getServerHost
```
String getServerHost()
```
    The host name of the server.
    
    Returns:
    
    the host name of the server running the application.
  - getServerPort
```
int getServerPort()
```
    The port number of the server.
    
    Returns:
    
    the port number of the server running the application.
  - getValue
```
default String getValue(String key)
```
    The value of a key.
    
    Parameters:
    
    key - the environment key
    
    Returns:
    
    the value for the key or null
  - getValue
```
String getValue(String key,
                Supplier<String> supplier)
```
    The value of a key with a supplier.
    
    Parameters:
    
    key - the environment key
    
    supplier - a Supplier for the key in case there is no value available
    
    Returns:
    
    the value for the key or delegates to the supplier
  - getDescription
```
default StringBuilder getDescription()
```
    The description of the environment.
    
    Returns:
    
    a formatted StringBuilder to describe the environment instance.
  - createEnvironment
```
static Environment createEnvironment()
```
    Creates an environment populating in order and overriding:
    - System.getenv()
    - System.getProperties()
    - If ENVIRONMENT_FILE points to a readable file and an instance of Properties can be loaded. Throw an IllegalArgumentException if an IOException occurs.
    Returns:
    
    an instance of Environment
  - createEnvironment
```
static Environment createEnvironment(Map<String,String> environment)
```
    Create an environment.
    
    Parameters:
    
    environment - the base environment to use. Values will be over-written first by System.getenv(), then System.getProperties(), and then finally if ENVIRONMENT_FILE provides any.
    
    Returns:
    
    the created Environment instance.

Interface Environment

Field Summary

Method Summary

Field Detail

ID

ENVIRONMENT_FILE

ENVIRONMENT_NAME

APPLICATION_NAME

ROOT_SUFFIX

LOG_ROOT_SUFFIX

LOG_FILE_SUFFIX

ACCESS_LOG_FILE_SUFFIX

LOG_FILE_ROTATE_PATTERN_SUFFIX

ACCESS_LOG_FILE_ROTATE_PATTERN

LOG_PATTERN

AUDIT_LOG_PATTERN

SERVER_HOST_SUFFIX

SERVER_PORT_SUFFIX

SERVER_SHUTDOWN_TOKEN

Method Detail

getId

getEnvironmentName

getApplicationName

getApplicationRoot

getApplicationLogsRoot

getLogFileName

getRotatingLogFilePattern

getAccessLogFileName

getRotatingAccessLogFileName

getContextPath

getServerHost

getServerPort

getValue

getValue

getDescription

createEnvironment

createEnvironment