Environment (Punch Common Core Library 6.4.5 API)

java.lang.Object
- org.thales.punch.platform.api.Environment

public final class Environment
extends Object

This class is the single entry point to access the several environment variables.

Here is an example :


        import org.thales.punch.platform.api.Environnement;
        ...
        String sparkInstallDir = Environnement.getSparkInstallDir();

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`PEX_ROOT` This ENV var should match PUNCHPLATFORM_PEX_CACHE_DIR.
`static String`	`PUNCHPLATFORM_APP_NAME` The active app/job for this environment (applies by default to processes, tasks and commands)
`static String`	`PUNCHPLATFORM_APPLICATION_ENV` A DICTIONNARY (JSON) string passed to each application that are executed by shiva as ENV.
`static String`	`PUNCHPLATFORM_CHANNEL` The active channel for this environment (applies by default to processes, tasks and commands)
`static String`	`PUNCHPLATFORM_CONF_DIR` The local file system folder containing the tenant(s) and channels configuration files.
`static String`	`PUNCHPLATFORM_GATEWAY_INSTALL_DIR` There you have the gateway installation directory.
`static String`	`PUNCHPLATFORM_INSTALL_DIR` The installation directory contains the various punch binaries.
`static String`	`PUNCHPLATFORM_LOG4J_CONF_DIR` The directory containing the required log4j2.xml and log4j2.properties.This variable takes different values depending on the runtime context : Shiva, Gateway, Operator.
`static String`	`PUNCHPLATFORM_OPERATOR_INSTALL_DIR` Unix operator are equipped with the operator role.
`static String`	`PUNCHPLATFORM_PEX_CACHE_DIR` The directory containing pex cache files
`static String`	`PUNCHPLATFORM_PROPERTIES_FILE` The properties file is generated at deploy time and contains information required at runtime to resolve target cluster addresses, and make it easier to keep punchline and channel configuration files lightweigth.
`static String`	`PUNCHPLATFORM_RESOLV_FILE` The resolv.json file is provided at deploy time by the user.
`static String`	`PUNCHPLATFORM_RUNTIME_SECRETS` The credential file is provided at deploy time by the user.
`static String`	`PUNCHPLATFORM_SECRETS_DIR` The directory which contains all SSL / credentials informations (certs, keys, secret files ..) for punch commands.
`static String`	`PUNCHPLATFORM_SHIVA_CHILD_PREFIX` Environement variable to tag a shiva child process.
`static String`	`PUNCHPLATFORM_SHIVA_INSTALL_DIR` The shiva installation directory.
`static String`	`PUNCHPLATFORM_SPARK_INSTALL_DIR` Spark installation directory.
`static String`	`PUNCHPLATFORM_TENANT` The active tenant for this environment (applies by default to processes, tasks and commands)
`static String`	`PUNCHPLATFORM_TERM_WIDTH` The default width for printing cli lines.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static ISettingsMap`	`getApplicationEnv()` The PUNCHPLATFORM_APPLICATION_ENV variable is used to provide punch applications or application launchers a json document that contains useful settings such as uuids or exit conditions.
`static ISettingsMap`	`getApplicationEnvFromString(String jsonStr)`
`static String`	`getAppName()`
`static String`	`getChannel()`
`static String`	`getConfDir()`
`static String`	`getGatewayInstallDir()`
`static String`	`getHostIp()`
`static String`	`getHostName()`
`static String`	`getInstallDir()`
`static IPlatform`	`getLocalPlatform()` Retrieve a platform handle to access the local filesystem configuration directory content.
`static String`	`getLog4jConfDir()`
`static String`	`getOperatorInstallDir()`
`static String`	`getOptionalEnv(String name)`
`static String`	`getPexCacheDir()`
`static ISettingsMap`	`getProperties()`
`static String`	`getPropertiesFile()`
`static String`	`getResolvFile()`
`static String`	`getSecrets()`
`static String`	`getSecretsDir()`
`static String`	`getShivaInstallDir()`
`static String`	`getSparkInstallDir()`
`static String`	`getTenant()`
`static int`	`getTerminalLineWidth()`
`static String`	`setEnv(String name, String value)`

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

- Field Detail
  - PEX_ROOT
```
public static final String PEX_ROOT
```
    This ENV var should match PUNCHPLATFORM_PEX_CACHE_DIR. In case we are running pex files directly (without calling a shell) which can set PEX_ROOT, this ENV must be set
    
    See Also:
    
    Constant Field Values
  - PUNCHPLATFORM_CONF_DIR
```
public static final String PUNCHPLATFORM_CONF_DIR
```
    The local file system folder containing the tenant(s) and channels configuration files.
    
    See Also:
    
    Constant Field Values
  - PUNCHPLATFORM_INSTALL_DIR
```
public static final String PUNCHPLATFORM_INSTALL_DIR
```
    The installation directory contains the various punch binaries. Each punch node (operator, shiva, gateway etc..) has such directory.
    
    See Also:
    
    Constant Field Values
  - PUNCHPLATFORM_PROPERTIES_FILE
```
public static final String PUNCHPLATFORM_PROPERTIES_FILE
```
    The properties file is generated at deploy time and contains information required at runtime to resolve target cluster addresses, and make it easier to keep punchline and channel configuration files lightweigth.
    It is not a deployment file, it is completely generated from the deployment settings file.
    
    See Also:
    
    Constant Field Values
  - PUNCHPLATFORM_SHIVA_INSTALL_DIR
```
public static final String PUNCHPLATFORM_SHIVA_INSTALL_DIR
```
    The shiva installation directory. Shiva acts as an completly autonomous application launcher. It is equivalent to an operator profile but has no home directory.
    It contains only a few configuration files, not the binaries themselves that are provided by the binary dir pointed to by PUNCHPLATFORM_INSTALL_DIR
    
    See Also:
    
    Constant Field Values
  - PUNCHPLATFORM_SHIVA_CHILD_PREFIX
```
public static final String PUNCHPLATFORM_SHIVA_CHILD_PREFIX
```
    Environement variable to tag a shiva child process.
    
    See Also:
    
    Constant Field Values
  - PUNCHPLATFORM_OPERATOR_INSTALL_DIR
```
public static final String PUNCHPLATFORM_OPERATOR_INSTALL_DIR
```
    Unix operator are equipped with the operator role. There you have the operator installation directory.
    It contains only a few configuration files, not the binaries themselves that are provided by the binary dir pointed to by PUNCHPLATFORM_INSTALL_DIR
    
    See Also:
    
    Constant Field Values
  - PUNCHPLATFORM_GATEWAY_INSTALL_DIR
```
public static final String PUNCHPLATFORM_GATEWAY_INSTALL_DIR
```
    There you have the gateway installation directory.
    It contains only a few configuration files, not the binaries themselves that are provided by the binary dir pointed to by PUNCHPLATFORM_INSTALL_DIR
    
    See Also:
    
    Constant Field Values
  - PUNCHPLATFORM_SPARK_INSTALL_DIR
```
public static final String PUNCHPLATFORM_SPARK_INSTALL_DIR
```
    Spark installation directory.
    
    See Also:
    
    Constant Field Values
  - PUNCHPLATFORM_RESOLV_FILE
```
public static final String PUNCHPLATFORM_RESOLV_FILE
```
    The resolv.json file is provided at deploy time by the user. It helps reducing the verbosity of channel and punchline files and provides for automatic address resolution and completion.
    
    See Also:
    
    Constant Field Values
  - PUNCHPLATFORM_RUNTIME_SECRETS
```
public static final String PUNCHPLATFORM_RUNTIME_SECRETS
```
    The credential file is provided at deploy time by the user. It contains all SSL / credentials informations for punch commands. Could contains multiple files, one global and one user specific for example
    
    See Also:
    
    Constant Field Values
  - PUNCHPLATFORM_SECRETS_DIR
```
public static final String PUNCHPLATFORM_SECRETS_DIR
```
    The directory which contains all SSL / credentials informations (certs, keys, secret files ..) for punch commands. The directory is located in $HOME/.secrets for operators and in $COMPONENT_INSTALL_DIR/.secrets for shiva & gateway
    
    See Also:
    
    Constant Field Values
  - PUNCHPLATFORM_LOG4J_CONF_DIR
```
public static final String PUNCHPLATFORM_LOG4J_CONF_DIR
```
    The directory containing the required log4j2.xml and log4j2.properties.This variable takes different values depending on the runtime context : Shiva, Gateway, Operator.
    
    See Also:
    
    Constant Field Values
  - PUNCHPLATFORM_TENANT
```
public static final String PUNCHPLATFORM_TENANT
```
    The active tenant for this environment (applies by default to processes, tasks and commands)
    
    See Also:
    
    Constant Field Values
  - PUNCHPLATFORM_CHANNEL
```
public static final String PUNCHPLATFORM_CHANNEL
```
    The active channel for this environment (applies by default to processes, tasks and commands)
    
    See Also:
    
    Constant Field Values
  - PUNCHPLATFORM_APP_NAME
```
public static final String PUNCHPLATFORM_APP_NAME
```
    The active app/job for this environment (applies by default to processes, tasks and commands)
    
    See Also:
    
    Constant Field Values
  - PUNCHPLATFORM_PEX_CACHE_DIR
```
public static final String PUNCHPLATFORM_PEX_CACHE_DIR
```
    The directory containing pex cache files
    
    See Also:
    
    Constant Field Values
  - PUNCHPLATFORM_TERM_WIDTH
```
public static final String PUNCHPLATFORM_TERM_WIDTH
```
    The default width for printing cli lines.
    
    See Also:
    
    Constant Field Values
  - PUNCHPLATFORM_APPLICATION_ENV
```
public static final String PUNCHPLATFORM_APPLICATION_ENV
```
    A DICTIONNARY (JSON) string passed to each application that are executed by shiva as ENV. Value of this ENV is expected to differ between each application...
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getOptionalEnv
```
public static String getOptionalEnv(String name)
```
  - getInstallDir
```
public static String getInstallDir()
```
    Returns:
    
    the value of PUNCHPLATFORM_INSTALL_DIR
  - getPropertiesFile
```
public static String getPropertiesFile()
```
    Returns:
    
    the value of PUNCHPLATFORM_PROPERTIES_FILE
  - getProperties
```
public static ISettingsMap getProperties()
```
    Returns:
    
    the platform properties
  - getOperatorInstallDir
```
public static String getOperatorInstallDir()
```
    Returns:
    
    the value of PUNCHPLATFORM_OPERATOR_INSTALL_DIR
  - getGatewayInstallDir
```
public static String getGatewayInstallDir()
```
    Returns:
    
    the value of PUNCHPLATFORM_GATEWAY_INSTALL_DIR
  - getShivaInstallDir
```
public static String getShivaInstallDir()
```
    Returns:
    
    the value of $PUNCHPLATFORM_SHIVA_INSTALL_DIR
  - getSparkInstallDir
```
public static String getSparkInstallDir()
```
    Returns:
    
    the value PUNCHPLATFORM_SPARK_INSTALL_DIR
  - getTenant
```
public static String getTenant()
```
    Returns:
    
    the value of the optional PUNCHPLATFORM_TENANT variable, null if not found.
  - getChannel
```
public static String getChannel()
```
    Returns:
    
    the value of the optional PUNCHPLATFORM_CHANNEL variable, null if not found.
  - getAppName
```
public static String getAppName()
```
    Returns:
    
    the value of the optional PUNCHPLATFORM_APP_NAME (job/application name) variable, null if not found.
  - getResolvFile
```
public static String getResolvFile()
```
    Returns:
    
    vthe value of PUNCHPLATFORM_RESOLV_FILE
  - getSecrets
```
public static String getSecrets()
```
    Returns:
    
    the value of the optional PUNCHPLATFORM_RUNTIME_SECRETS
  - getSecretsDir
```
public static String getSecretsDir()
```
    Returns:
    
    the value of the optional PUNCHPLATFORM_SECRETS_DIR
  - getConfDir
```
public static String getConfDir()
```
    Returns:
    
    the value of PUNCHPLATFORM_CONF_DIR
  - getLog4jConfDir
```
public static String getLog4jConfDir()
```
    Returns:
    
    the value of PUNCHPLATFORM_INSTALL_DIR
  - getPexCacheDir
```
public static String getPexCacheDir()
```
    Returns:
    
    the value of PUNCHPLATFORM_INSTALL_DIR
  - getLocalPlatform
```
public static IPlatform getLocalPlatform()
```
    Retrieve a platform handle to access the local filesystem configuration directory content.
    Watchout : use this with caution : it requires you are running on a server equipped with a mounted (git) configuration directory.
    
    Returns:
    
    your platform handle
  - getHostName
```
public static String getHostName()
```
    Returns:
    
    the local host name
  - getHostIp
```
public static String getHostIp()
```
    Returns:
    
    the ip address associated to the local host name
  - getApplicationEnv
```
public static ISettingsMap getApplicationEnv()
                                      throws EnvironmentConfigurationException
```
    The PUNCHPLATFORM_APPLICATION_ENV variable is used to provide punch applications or application launchers a json document that contains useful settings such as uuids or exit conditions.
    
    Returns:
    
    the map, empty if there is no such environment variable.
    
    Throws:
    
    EnvironmentConfigurationException
  - getApplicationEnvFromString
```
public static ISettingsMap getApplicationEnvFromString(String jsonStr)
                                                throws EnvironmentConfigurationException
```
    Throws:
    
    EnvironmentConfigurationException
  - setEnv
```
public static String setEnv(String name,
                            String value)
```
    Returns:
    
    set environment.
  - getTerminalLineWidth
```
public static int getTerminalLineWidth()
```
    Returns:
    
    the line width to be used for printing stdout temrinal infos to the user

Class Environment

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PEX_ROOT

PUNCHPLATFORM_CONF_DIR

PUNCHPLATFORM_INSTALL_DIR

PUNCHPLATFORM_PROPERTIES_FILE

PUNCHPLATFORM_SHIVA_INSTALL_DIR

PUNCHPLATFORM_SHIVA_CHILD_PREFIX

PUNCHPLATFORM_OPERATOR_INSTALL_DIR

PUNCHPLATFORM_GATEWAY_INSTALL_DIR

PUNCHPLATFORM_SPARK_INSTALL_DIR

PUNCHPLATFORM_RESOLV_FILE

PUNCHPLATFORM_RUNTIME_SECRETS

PUNCHPLATFORM_SECRETS_DIR

PUNCHPLATFORM_LOG4J_CONF_DIR

PUNCHPLATFORM_TENANT

PUNCHPLATFORM_CHANNEL

PUNCHPLATFORM_APP_NAME

PUNCHPLATFORM_PEX_CACHE_DIR

PUNCHPLATFORM_TERM_WIDTH

PUNCHPLATFORM_APPLICATION_ENV

Method Detail

getOptionalEnv

getInstallDir

getPropertiesFile

getProperties

getOperatorInstallDir

getGatewayInstallDir

getShivaInstallDir

getSparkInstallDir

getTenant

getChannel

getAppName

getResolvFile

getSecrets

getSecretsDir

getConfDir

getLog4jConfDir

getPexCacheDir

getLocalPlatform

getHostName

getHostIp

getApplicationEnv

getApplicationEnvFromString

setEnv

getTerminalLineWidth