Environment (Nuxeo ECM Projects 8.10 API)

java.lang.Object
- org.nuxeo.common.Environment

```
public class Environment
extends Object
```
Author:

Bogdan Stefanescu

Field Summary

Fields
Modifier and Type	Field and Description
`protected String[]`	`args`
`static String`	`BUNDLES`
`static String`	`BUNDLES_DIR` The application layout (optional): directory containing nuxeo runtime osgi bundles.
`protected File`	`config`
`static String`	`CONFIG_DIR` Deprecated. never defined; use `NUXEO_CONFIG_DIR`
`protected Iterable<URL>`	`configProvider`
`static String`	`CRYPT_ALGO`
`static String`	`CRYPT_KEY`
`static String`	`CRYPT_KEYALIAS`
`static String`	`CRYPT_KEYSTORE_PASS`
`static String`	`CRYPT_KEYSTORE_PATH`
`protected File`	`data`
`static String`	`DATA_DIR` Deprecated. never defined; use `NUXEO_DATA_DIR`
`static String`	`DEFAULT_CONFIG_DIR`
`static String`	`DEFAULT_DATA_DIR`
`static String`	`DEFAULT_LOG_DIR`
`static String`	`DEFAULT_MP_DIR`
`static String`	`DEFAULT_TMP_DIR`
`static String`	`DEFAULT_WEB_DIR`
`static String`	`DISTRIBUTION_DATE`
`static String`	`DISTRIBUTION_NAME`
`static String`	`DISTRIBUTION_PACKAGE`
`static String`	`DISTRIBUTION_SERVER`
`static String`	`DISTRIBUTION_VERSION`
`protected File`	`home`
`static String`	`HOME_DIR` Deprecated. never defined; use `NUXEO_HOME_DIR`
`protected String`	`hostAppName`
`protected String`	`hostAppVersion`
`protected boolean`	`isAppServer`
`static String`	`JAVA_DEFAULT_KEYSTORE`
`static String`	`JAVA_DEFAULT_KEYSTORE_PASS`
`static String`	`JBOSS_HOST` Constants that identifies possible hosts for the framework.
`protected File`	`log`
`static String`	`LOG_DIR` Deprecated. never defined; use `NUXEO_LOG_DIR`
`static String`	`NUXEO_CONFIG_DIR`
`static String`	`NUXEO_CONTEXT_PATH`
`static String`	`NUXEO_DATA_DIR`
`static String`	`NUXEO_HOME`
`static String`	`NUXEO_HOME_DIR`
`static String`	`NUXEO_HTTP_PROXY_HOST`
`static String`	`NUXEO_HTTP_PROXY_LOGIN`
`static String`	`NUXEO_HTTP_PROXY_PASSWORD`
`static String`	`NUXEO_HTTP_PROXY_PORT`
`static String`	`NUXEO_LOG_DIR`
`static String`	`NUXEO_MP_DIR`
`static String`	`NUXEO_PID_DIR`
`static String`	`NUXEO_RUNTIME_HOME`
`static String`	`NUXEO_TMP_DIR`
`static String`	`NUXEO_WEB_DIR`
`static String`	`NXSERVER_HOST`
`static String`	`PRODUCT_NAME`
`static String`	`PRODUCT_VERSION`
`protected Properties`	`properties`
`static String`	`SERVER_STATUS_KEY`
`protected File`	`temp`
`static String`	`TOMCAT_HOST`
`protected File`	`web`
`static String`	`WEB_DIR` Deprecated. never defined; use `NUXEO_WEB_DIR`

Constructor Summary

Constructors
Constructor and Description
`Environment(File home)` Call to that constructor should be followed by a call to `init()`.
`Environment(File home, Properties properties)` Call to that constructor should be followed by a call to `init()`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String[]`	`getCommandLineArguments()`
`File`	`getConfig()`
`Iterable<URL>`	`getConfigurationProvider()`
`File`	`getData()`
`static Environment`	`getDefault()`
`File`	`getHome()`
`String`	`getHostApplicationName()`
`String`	`getHostApplicationVersion()`
`File`	`getLog()`
`File`	`getPath(String key)`
`File`	`getPath(String key, String defaultValue)`
`Properties`	`getProperties()`
`String`	`getProperty(String key)`
`String`	`getProperty(String key, String defaultValue)`
`File`	`getRuntimeHome()`
`File`	`getServerHome()` This method always returns the server home (or `getHome()` if `NUXEO_HOME_DIR` is not set).
`File`	`getTemp()`
`File`	`getWeb()`
`void`	`init()` Initialization with System properties to avoid issues due to home set with runtime home instead of server home.
`boolean`	`isApplicationServer()`
`boolean`	`isJBoss()`
`boolean`	`isJetty()`
`boolean`	`isTomcat()`
`void`	`loadProperties(Properties props)`
`void`	`setCommandLineArguments(String[] args)`
`void`	`setConfig(File config)`
`void`	`setConfig(String config)` Resolve the path against `runtimeHome` if not absolute.
`void`	`setConfigurationProvider(Iterable<URL> configProvider)`
`void`	`setData(File data)`
`void`	`setData(String data)` Resolve the path against `runtimeHome` if not absolute.
`static void`	`setDefault(Environment env)`
`void`	`setHostApplicationName(String name)`
`void`	`setHostApplicationVersion(String version)`
`void`	`setIsApplicationServer(boolean isAppServer)`
`void`	`setLog(File log)`
`void`	`setLog(String log)` Resolve the path against `serverHome` if not absolute.
`void`	`setPath(String key, File value)` Add a file path as a property
`void`	`setPath(String key, File value, File baseDir)` Add a file path as a property
`void`	`setPath(String key, String value)` Add a file path as a property
`void`	`setPath(String key, String value, File baseDir)` Add a file path as a property
`void`	`setProperty(String key, String value)` If setting a path property, consider using `setPath(String, String)`
`void`	`setRuntimeHome(File runtimeHome)`
`void`	`setServerHome(File serverHome)`
`void`	`setTemp(File temp)`
`void`	`setTemp(String temp)` Resolve the path against `serverHome` if not absolute.
`void`	`setWeb(File web)`
`void`	`setWeb(String web)` Resolve the path against `runtimeHome` if not absolute.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - JBOSS_HOST
```
public static final String JBOSS_HOST
```
    Constants that identifies possible hosts for the framework.
    
    See Also:
    
    Constant Field Values
  - NXSERVER_HOST
```
public static final String NXSERVER_HOST
```
    See Also:
    
    Constant Field Values
  - TOMCAT_HOST
```
public static final String TOMCAT_HOST
```
    See Also:
    
    Constant Field Values
  - NUXEO_HOME_DIR
```
public static final String NUXEO_HOME_DIR
```
    See Also:
    
    Constant Field Values
  - NUXEO_HOME
```
public static final String NUXEO_HOME
```
    Since:
    
    5.6
    
    See Also:
    
    Constant Field Values
  - NUXEO_RUNTIME_HOME
```
public static final String NUXEO_RUNTIME_HOME
```
    Since:
    
    5.4.2
    
    See Also:
    
    Constant Field Values
  - NUXEO_DATA_DIR
```
public static final String NUXEO_DATA_DIR
```
    See Also:
    
    Constant Field Values
  - DEFAULT_DATA_DIR
```
public static final String DEFAULT_DATA_DIR
```
    Since:
    
    5.9.4
    
    See Also:
    
    Constant Field Values
  - NUXEO_LOG_DIR
```
public static final String NUXEO_LOG_DIR
```
    See Also:
    
    Constant Field Values
  - DEFAULT_LOG_DIR
```
public static final String DEFAULT_LOG_DIR
```
    Since:
    
    5.9.4
    
    See Also:
    
    Constant Field Values
  - NUXEO_PID_DIR
```
public static final String NUXEO_PID_DIR
```
    See Also:
    
    Constant Field Values
  - NUXEO_TMP_DIR
```
public static final String NUXEO_TMP_DIR
```
    See Also:
    
    Constant Field Values
  - DEFAULT_TMP_DIR
```
public static final String DEFAULT_TMP_DIR
```
    Since:
    
    5.9.4
    
    See Also:
    
    Constant Field Values
  - NUXEO_CONFIG_DIR
```
public static final String NUXEO_CONFIG_DIR
```
    See Also:
    
    Constant Field Values
  - DEFAULT_CONFIG_DIR
```
public static final String DEFAULT_CONFIG_DIR
```
    Since:
    
    5.9.4
    
    See Also:
    
    Constant Field Values
  - NUXEO_WEB_DIR
```
public static final String NUXEO_WEB_DIR
```
    See Also:
    
    Constant Field Values
  - DEFAULT_WEB_DIR
```
public static final String DEFAULT_WEB_DIR
```
    Since:
    
    5.9.4
    
    See Also:
    
    Constant Field Values
  - NUXEO_MP_DIR
```
public static final String NUXEO_MP_DIR
```
    Since:
    
    5.9.4
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MP_DIR
```
public static final String DEFAULT_MP_DIR
```
    Since:
    
    5.9.4
    
    See Also:
    
    Constant Field Values
  - NUXEO_CONTEXT_PATH
```
public static final String NUXEO_CONTEXT_PATH
```
    Since:
    
    5.6
    
    See Also:
    
    Constant Field Values
  - HOME_DIR
```
@Deprecated
public static final String HOME_DIR
```
    Deprecated. never defined; use NUXEO_HOME_DIR
    
    The home directory.
    
    See Also:
    
    Constant Field Values
  - WEB_DIR
```
@Deprecated
public static final String WEB_DIR
```
    Deprecated. never defined; use NUXEO_WEB_DIR
    
    The web root.
    
    See Also:
    
    Constant Field Values
  - CONFIG_DIR
```
@Deprecated
public static final String CONFIG_DIR
```
    Deprecated. never defined; use NUXEO_CONFIG_DIR
    
    The config directory.
    
    See Also:
    
    Constant Field Values
  - DATA_DIR
```
@Deprecated
public static final String DATA_DIR
```
    Deprecated. never defined; use NUXEO_DATA_DIR
    
    The data directory.
    
    See Also:
    
    Constant Field Values
  - LOG_DIR
```
@Deprecated
public static final String LOG_DIR
```
    Deprecated. never defined; use NUXEO_LOG_DIR
    
    The log directory.
    
    See Also:
    
    Constant Field Values
  - BUNDLES_DIR
```
public static final String BUNDLES_DIR
```
    The application layout (optional): directory containing nuxeo runtime osgi bundles.
    
    See Also:
    
    Constant Field Values
  - BUNDLES
```
public static final String BUNDLES
```
    See Also:
    
    Constant Field Values
  - home
```
protected final File home
```
  - data
```
protected File data
```
  - log
```
protected File log
```
  - config
```
protected File config
```
  - web
```
protected File web
```
  - temp
```
protected File temp
```
  - properties
```
protected final Properties properties
```
  - args
```
protected String[] args
```
  - isAppServer
```
protected boolean isAppServer
```
  - hostAppName
```
protected String hostAppName
```
  - hostAppVersion
```
protected String hostAppVersion
```
  - configProvider
```
protected Iterable<URL> configProvider
```
  - SERVER_STATUS_KEY
```
public static final String SERVER_STATUS_KEY
```
    See Also:
    
    Constant Field Values
  - DISTRIBUTION_NAME
```
public static final String DISTRIBUTION_NAME
```
    See Also:
    
    Constant Field Values
  - DISTRIBUTION_VERSION
```
public static final String DISTRIBUTION_VERSION
```
    See Also:
    
    Constant Field Values
  - DISTRIBUTION_SERVER
```
public static final String DISTRIBUTION_SERVER
```
    Since:
    
    7.10
    
    See Also:
    
    Constant Field Values
  - DISTRIBUTION_DATE
```
public static final String DISTRIBUTION_DATE
```
    Since:
    
    7.10
    
    See Also:
    
    Constant Field Values
  - DISTRIBUTION_PACKAGE
```
public static final String DISTRIBUTION_PACKAGE
```
    Since:
    
    7.10
    
    See Also:
    
    Constant Field Values
  - PRODUCT_NAME
```
public static final String PRODUCT_NAME
```
    Since:
    
    7.10
    
    See Also:
    
    Constant Field Values
  - PRODUCT_VERSION
```
public static final String PRODUCT_VERSION
```
    Since:
    
    7.10
    
    See Also:
    
    Constant Field Values
  - NUXEO_HTTP_PROXY_HOST
```
public static final String NUXEO_HTTP_PROXY_HOST
```
    Since:
    
    6.0
    
    See Also:
    
    Constant Field Values
  - NUXEO_HTTP_PROXY_PORT
```
public static final String NUXEO_HTTP_PROXY_PORT
```
    Since:
    
    6.0
    
    See Also:
    
    Constant Field Values
  - NUXEO_HTTP_PROXY_LOGIN
```
public static final String NUXEO_HTTP_PROXY_LOGIN
```
    Since:
    
    6.0
    
    See Also:
    
    Constant Field Values
  - NUXEO_HTTP_PROXY_PASSWORD
```
public static final String NUXEO_HTTP_PROXY_PASSWORD
```
    Since:
    
    6.0
    
    See Also:
    
    Constant Field Values
  - CRYPT_ALGO
```
public static final String CRYPT_ALGO
```
    Since:
    
    7.4
    
    See Also:
    
    Constant Field Values
  - CRYPT_KEY
```
public static final String CRYPT_KEY
```
    Since:
    
    7.4
    
    See Also:
    
    Constant Field Values
  - CRYPT_KEYALIAS
```
public static final String CRYPT_KEYALIAS
```
    Since:
    
    7.4
    
    See Also:
    
    Constant Field Values
  - CRYPT_KEYSTORE_PATH
```
public static final String CRYPT_KEYSTORE_PATH
```
    Since:
    
    7.4
    
    See Also:
    
    Constant Field Values
  - CRYPT_KEYSTORE_PASS
```
public static final String CRYPT_KEYSTORE_PASS
```
    Since:
    
    7.4
    
    See Also:
    
    Constant Field Values
  - JAVA_DEFAULT_KEYSTORE
```
public static final String JAVA_DEFAULT_KEYSTORE
```
    Since:
    
    7.4
    
    See Also:
    
    Constant Field Values
  - JAVA_DEFAULT_KEYSTORE_PASS
```
public static final String JAVA_DEFAULT_KEYSTORE_PASS
```
    Since:
    
    7.4
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Environment
```
public Environment(File home)
```
    Call to that constructor should be followed by a call to init(). Depending on the available System properties, you may want to also call loadProperties(Properties) or setServerHome(File) methods before init(); here is the recommended order:
```
 Environment env = new Environment(home);
 Environment.setDefault(env);
 env.loadProperties(properties);
 env.setServerHome(home);
 env.init();
 
```
    Parameters:
    
    home - Root path used for most defaults. It is recommended to make it match the server home rather than the runtime home.
    
    See Also:
    
    init()
  - Environment
```
public Environment(File home,
                   Properties properties)
```
    Call to that constructor should be followed by a call to init(). Depending on the available System properties, you may want to also call setServerHome(File) method before init(); here is the recommended order:
```
 Environment env = new Environment(home, properties);
 Environment.setDefault(env);
 env.setServerHome(home);
 env.init();
 
```
    Parameters:
    
    home - Root path used for most defaults. It is recommended to make it match the server home rather than the runtime home.
    
    properties - Source properties for initialization. It is used as an Hashtable: ie only the custom values are read, the properties default values are ignored if any.
    
    See Also:
    
    init()
- Method Detail
  - setDefault
```
public static void setDefault(Environment env)
```
  - getDefault
```
public static Environment getDefault()
```
  - getHome
```
public File getHome()
```
  - isApplicationServer
```
public boolean isApplicationServer()
```
  - setIsApplicationServer
```
public void setIsApplicationServer(boolean isAppServer)
```
  - getHostApplicationName
```
public String getHostApplicationName()
```
  - getHostApplicationVersion
```
public String getHostApplicationVersion()
```
  - setHostApplicationName
```
public void setHostApplicationName(String name)
```
  - setHostApplicationVersion
```
public void setHostApplicationVersion(String version)
```
  - getTemp
```
public File getTemp()
```
  - setTemp
```
public void setTemp(String temp)
```
    Resolve the path against serverHome if not absolute.
    
    Parameters:
    
    temp -
    
    Since:
    
    8.1
  - setTemp
```
public void setTemp(File temp)
```
  - getConfig
```
public File getConfig()
```
  - setConfig
```
public void setConfig(String config)
```
    Resolve the path against runtimeHome if not absolute.
    
    Parameters:
    
    config -
    
    Since:
    
    8.1
  - setConfig
```
public void setConfig(File config)
```
  - getLog
```
public File getLog()
```
  - setLog
```
public void setLog(String log)
```
    Resolve the path against serverHome if not absolute.
    
    Parameters:
    
    log -
    
    Since:
    
    8.1
  - setLog
```
public void setLog(File log)
```
  - getData
```
public File getData()
```
  - setData
```
public void setData(String data)
```
    Resolve the path against runtimeHome if not absolute.
    
    Parameters:
    
    data -
    
    Since:
    
    8.1
  - setData
```
public void setData(File data)
```
  - getWeb
```
public File getWeb()
```
  - setWeb
```
public void setWeb(String web)
```
    Resolve the path against runtimeHome if not absolute.
    
    Parameters:
    
    web -
    
    Since:
    
    8.1
  - setWeb
```
public void setWeb(File web)
```
  - getRuntimeHome
```
public File getRuntimeHome()
```
    Since:
    
    5.4.2
  - setRuntimeHome
```
public void setRuntimeHome(File runtimeHome)
```
    Since:
    
    5.4.2
  - getCommandLineArguments
```
public String[] getCommandLineArguments()
```
  - setCommandLineArguments
```
public void setCommandLineArguments(String[] args)
```
  - getProperty
```
public String getProperty(String key)
```
  - getProperty
```
public String getProperty(String key,
                          String defaultValue)
```
  - setProperty
```
public void setProperty(String key,
                        String value)
```
    If setting a path property, consider using setPath(String, String)
  - getProperties
```
public Properties getProperties()
```
  - loadProperties
```
public void loadProperties(Properties props)
```
  - isJBoss
```
public boolean isJBoss()
```
  - isJetty
```
public boolean isJetty()
```
  - isTomcat
```
public boolean isTomcat()
```
  - init
```
public void init()
```
    Initialization with System properties to avoid issues due to home set with runtime home instead of server home. If NUXEO_HOME System property is not set, or if you want to set a custom server home, then you should call setServerHome(File) before.
    
    Since:
    
    5.4.1
  - getServerHome
```
public File getServerHome()
```
    This method always returns the server home (or getHome() if NUXEO_HOME_DIR is not set).
    
    Returns:
    
    Server home
    
    Since:
    
    5.4.2
  - setServerHome
```
public void setServerHome(File serverHome)
```
    Since:
    
    5.4.2
  - setConfigurationProvider
```
public void setConfigurationProvider(Iterable<URL> configProvider)
```
  - getConfigurationProvider
```
public Iterable<URL> getConfigurationProvider()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - setPath
```
public void setPath(String key,
                    File value,
                    File baseDir)
```
    Add a file path as a property
    
    Parameters:
    
    key - Property key
    
    value - Property value: an absolute or relative file
    
    baseDir - The directory against which the file will be resolved if not absolute
    
    Since:
    
    8.1
    
    See Also:
    
    setProperty(String, String), setPath(String, String, File), setPath(String, File)
  - setPath
```
public void setPath(String key,
                    String value,
                    File baseDir)
```
    Add a file path as a property
    
    Parameters:
    
    key - Property key
    
    value - Property value: an absolute or relative file path
    
    baseDir - The directory against which the file will be resolved if not absolute
    
    Since:
    
    8.1
    
    See Also:
    
    setProperty(String, String), setPath(String, File, File), setPath(String, File)
  - setPath
```
public void setPath(String key,
                    File value)
```
    Add a file path as a property
    
    Parameters:
    
    key - Property key
    
    value - Property value: an absolute or relative file; if relative, it will be resolved against home
    
    Since:
    
    8.1
    
    See Also:
    
    setProperty(String, String), setPath(String, File, File)
  - setPath
```
public void setPath(String key,
                    String value)
```
    Add a file path as a property
    
    Parameters:
    
    key - Property key
    
    value - Property value: an absolute or relative file path; if relative, it will be resolved against home
    
    Since:
    
    8.1
    
    See Also:
    
    setProperty(String, String), setPath(String, String, File)
  - getPath
```
public File getPath(String key)
```
    Parameters:
    
    key -
    
    Returns:
    
    the file which path is associated with the given key. The file is guaranteed to be absolute if it has been set with setPath(String, File)
    
    Since:
    
    8.1
  - getPath
```
public File getPath(String key,
                    String defaultValue)
```
    Parameters:
    
    key - the property key
    
    defaultValue - the default path, absolute or relative to server home
    
    Returns:
    
    the file which path is associated with the given key. The file is guaranteed to be absolute if it has been set with setPath(String, File)
    
    Since:
    
    8.1

Class Environment

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JBOSS_HOST

NXSERVER_HOST

TOMCAT_HOST

NUXEO_HOME_DIR

NUXEO_HOME

NUXEO_RUNTIME_HOME

NUXEO_DATA_DIR

DEFAULT_DATA_DIR

NUXEO_LOG_DIR

DEFAULT_LOG_DIR

NUXEO_PID_DIR

NUXEO_TMP_DIR

DEFAULT_TMP_DIR

NUXEO_CONFIG_DIR

DEFAULT_CONFIG_DIR

NUXEO_WEB_DIR

DEFAULT_WEB_DIR

NUXEO_MP_DIR

DEFAULT_MP_DIR

NUXEO_CONTEXT_PATH

HOME_DIR

WEB_DIR

CONFIG_DIR

DATA_DIR

LOG_DIR

BUNDLES_DIR

BUNDLES

home

data

log

config

web

temp

properties

args

isAppServer

hostAppName

hostAppVersion

configProvider

SERVER_STATUS_KEY

DISTRIBUTION_NAME

DISTRIBUTION_VERSION

DISTRIBUTION_SERVER

DISTRIBUTION_DATE

DISTRIBUTION_PACKAGE

PRODUCT_NAME

PRODUCT_VERSION

NUXEO_HTTP_PROXY_HOST

NUXEO_HTTP_PROXY_PORT

NUXEO_HTTP_PROXY_LOGIN

NUXEO_HTTP_PROXY_PASSWORD

CRYPT_ALGO

CRYPT_KEY

CRYPT_KEYALIAS

CRYPT_KEYSTORE_PATH

CRYPT_KEYSTORE_PASS

JAVA_DEFAULT_KEYSTORE

JAVA_DEFAULT_KEYSTORE_PASS

Constructor Detail

Environment

Environment

Method Detail

setDefault

getDefault

getHome

isApplicationServer

setIsApplicationServer

getHostApplicationName

getHostApplicationVersion

setHostApplicationName

setHostApplicationVersion

getTemp

setTemp

setTemp