Environment (Nuxeo ECM Projects 7.2 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
`static String`	`BUNDLES`
`static String`	`BUNDLES_DIR` The application layout (optional): directory containing nuxeo runtime osgi bundles.
`static String`	`CONFIG_DIR` Deprecated. never defined; use `NUXEO_CONFIG_DIR`
`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_NAME`
`static String`	`DISTRIBUTION_VERSION`
`static String`	`HOME_DIR` Deprecated. never defined; use `NUXEO_HOME_DIR`
`static String`	`JBOSS_HOST` Constants that identifies possible hosts for the framework.
`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`	`TOMCAT_HOST`
`static String`	`WEB_DIR` Deprecated. never defined; use `NUXEO_WEB_DIR`

Constructor Summary

Constructors
Constructor and Description

Environment(File home)

Environment(File home, Properties properties)

Constructors
Constructor and Description
`Environment(File home)`
`Environment(File home, Properties properties)`

Method Summary

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()`
`Properties`	`getProperties()`
`String`	`getProperty(String key)`
`String`	`getProperty(String key, String defaultValue)`
`File`	`getRuntimeHome()`
`File`	`getServerHome()` This method always returns the server home (or null if `NUXEO_HOME_DIR` is not set), whereas `getHome()` may return runtime home.
`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`	`setConfigurationProvider(Iterable<URL> configProvider)`
`void`	`setData(File data)`
`static void`	`setDefault(Environment env)`
`void`	`setHostApplicationName(String name)`
`void`	`setHostApplicationVersion(String version)`
`void`	`setIsApplicationServer(boolean isAppServer)`
`void`	`setLog(File log)`
`void`	`setProperty(String key, String value)`
`void`	`setRuntimeHome(File runtimeHome)`
`void`	`setServerHome(File serverHome)`
`void`	`setTemp(File temp)`
`void`	`setWeb(File web)`
`String`	`toString()`

Methods inherited from class java.lang.Object
equals, 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
- 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
- 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

Constructor Detail

Environment
```
public Environment(File home)
```

Environment

public Environment(File home,
           Properties properties)

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(File temp)
```

getConfig
```
public File getConfig()
```

setConfig
```
public void setConfig(File config)
```

getLog
```
public File getLog()
```

setLog
```
public void setLog(File log)
```

getData
```
public File getData()
```

setData
```
public void setData(File data)
```

getWeb
```
public File getWeb()
```

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)

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.

Since:

5.4.1

getServerHome
```
public File getServerHome()
```
This method always returns the server home (or null if NUXEO_HOME_DIR is not set), whereas getHome() may return runtime home.

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

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

DISTRIBUTION_NAME

DISTRIBUTION_VERSION

NUXEO_HTTP_PROXY_HOST

NUXEO_HTTP_PROXY_PORT

NUXEO_HTTP_PROXY_LOGIN

NUXEO_HTTP_PROXY_PASSWORD

Constructor Detail

Environment

Environment

Method Detail

setDefault

getDefault

getHome

isApplicationServer

setIsApplicationServer

getHostApplicationName

getHostApplicationVersion

setHostApplicationName

setHostApplicationVersion

getTemp

setTemp

getConfig

setConfig

getLog

setLog

getData

setData

getWeb

setWeb

getRuntimeHome

setRuntimeHome

getCommandLineArguments

setCommandLineArguments

getProperty

getProperty

setProperty

getProperties

loadProperties

isJBoss

isJetty

isTomcat

init

getServerHome

setServerHome

setConfigurationProvider

getConfigurationProvider

toString