EnvironmentUtility (ecmsdk-api 3.4.0 API)

java.lang.Object
- oracle.ifs.admin.tools.config.EnvironmentUtility

```
public class EnvironmentUtility
extends Object
```
UOA environment utility class to obtain classpath and folder information derived from xml configuration file.
Notes: 1) values for path/subpath attributes of folder element in xml config file should specify paths in unix notation 2) paths in folder map are formatted specific to OS leveraged by JVM

Author:

Matt Shannon

(Published)

Field Summary

Fields
Modifier and Type	Field and Description
`protected static String`	`APPLICABLE_BOTH` Value for "applicable" attribute in xml configuration file to indicate both development and installation environments.
`protected static String`	`APPLICABLE_DEV_ENV` Value for "applicable" attribute in xml configuration file to indicate development environment only.
`protected static String`	`APPLICABLE_INSTALL_ENV` Value for "applicable" attribute in xml configuration file to indicate install environment only.
`static String`	`DATASOURCE_REGEX_JDBC_SERVICE` Datasource regular expression to match jdbc connection style string with service name specified group 1 should be host, 2 should be port, 3 should be servicename
`static String`	`DATASOURCE_REGEX_JDBC_SID` Datasource regular expression to match jdbc connection style string with SID specified group 1 should be host, 2 should be port, 3 should be sid
`static String`	`DATASOURCE_REGEX_TNS` Datasource regular expression to match TNS style string group 1 should be host, 2 should be port, 3 should be servicename
`static String`	`IFS_INSTALL_ENVIRONMENT_VARIABLE` Environment variable to lookup to determine if running a dev environment
`protected Map`	`m_Classpaths` a map containing classpathGroup name/classpath value tuples
`protected Map`	`m_Commands` a map containing command name/value tuples
`protected String`	`m_DirSep` Operating system specific directory separator string to leverage
`protected static Map`	`m_Environment` Operating System environment variable map
`protected Map`	`m_Folders` a map containing folder name/path tuples
`protected boolean`	`m_IsInstallEnvironment` Runtime configuration mode being leveraged: A value of false indicates utility leveraging dev environment configuration, a value of true indicates install environment configuration.
`protected SAXParser`	`m_Parser` XML SAX parser instance
`protected String`	`m_PathSep` Operating system specific path separator string to leverage
`static String`	`UOA_JDBC_DATASOURCE` UOA JDBC Data Source name.

Constructor Summary

Constructors
Constructor and Description

EnvironmentUtility(boolean isInstallEnvironment)
Constructor

Constructors
Constructor and Description
`EnvironmentUtility(boolean isInstallEnvironment)` Constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected String`	`addTrailingDirSep(String path)` Adds trailing directory separator to supplied path if required.
`protected String`	`addTrailingPathSep(String classpath)` Adds trailing path separator to supplied classpath if required.
`static void`	`closeStream(InputStream is)` Close the specified inputstream if non-null, consuming any exception
`static void`	`closeWriter(Writer w)` Flush and close the specified writer if non-null, consuming any exception
`protected String`	`convertPath(String value)` Return a path string derived from the specified path potentially replacing occurrences of unix directory separator with the windows directory separator should the windows directory seaparator be in use.
`static Map`	`getAttributes(Attributes atts)` Converts the specified Attributes instance in to a map of attribute qname (the key)/value pairs.
`Map`	`getClasspaths()` Returns a map containing classpath group name/classpath value tuples Note: classpath value always end with trailing path separator; Note: by convention keys starting with a bang "!"
`String`	`getClasspathValue(String name)` Return classpath value for specified classpath group from classpath map.
`Map`	`getCommands()` Returns a map containing command name/value tuples Note: by convention keys starting with a bang "!"
`String`	`getCommandValue(String name)` Return command value for specified command name from commands map.
`String`	`getConsoleInputString(String prompt, String defValue, boolean required, boolean echoInput)` Get input string from the console, and return the result
`static String`	`getDatabaseUrl(String ifsDomain)` Synthesizes a basic database connection URL from the supplied IFS domain string.
`static String`	`getDatabaseUrl(String ifsDomain, boolean asSID)` Synthesizes a basic database connection URL from the supplied IFS domain string.
`static String`	`getEnvironmentValue(String name)` Return value for specified environment variable.
`static Map`	`getEnvironmentVariables()` Returns a Map containing environment variable name-value pairs for the current executing environment.
`Map`	`getFolders()` Returns a map containing folder name/path tuples Note: by convention keys starting with a bang "!"
`String`	`getFolderValue(String name)` Return value for specified folder from folder map.
`static String`	`getIfsDomain(String databaseUrl, String ifsSchema)` Attempts to synthesize an IFS domain string from the supplied database connection URL and IFS schema name.
`static String`	`getIfsSchema(String ifsDomain)` Retrieves the IFS schema name connection component of the supplied IFS domain string.
`protected Properties`	`getInstallEnvironmentCommonSettings()` Retrieves the 11g Installation environment settings from mbean server.
`protected Properties`	`getInternalProperties()` Derives a set of properties specific to the particular runtime mode (development/install).
`protected boolean`	`isApplicable(String applicability)` Determine if the provided applicability attribute value should result in processing continuing or being skipped.
`static boolean`	`isDevelopmentEnvironment()` Returns true if the runtime environment appears to be a development environment.
`protected static boolean`	`isEmptyTrimmed(String value)` Utility method to determine if a String instance is empty post trimming
`static boolean`	`isInstallEnvironment()` Returns true if the runtime environment appears to be an installation environment.
`static boolean`	`isWindows()` Returns a boolean indicating whether this JVM appear to be running in a Windows based environment.
`protected void`	`log(oracle.ifs.admin.tools.config.EnvironmentUtility.Classpath group)` Log the specified classpath group instance if non-null
`protected void`	`log(oracle.ifs.admin.tools.config.EnvironmentUtility.Command command)` Log the specified command instance if non-null
`protected void`	`log(oracle.ifs.admin.tools.config.EnvironmentUtility.Folder f)` Log the specified folder instance if non-null
`static void`	`main(String[] args)` Initializes the utility.
`void`	`parseXmlStream(InputStream is)`
`protected String`	`removeTrailingDirSepIfNotRoot(String path)` Removes the trailing directory separator if applicable from supplied paths that are not root folders
`protected String`	`removeTrailingPathSep(String classpath)` Removes the trailing path separator if applicable from supplied classpath
`protected void`	`saveClasspath(oracle.ifs.admin.tools.config.EnvironmentUtility.Classpath group)` Store name/value of classpath group instance in the classpath map.
`protected void`	`saveCommand(oracle.ifs.admin.tools.config.EnvironmentUtility.Command command)` Store name/value of command instance in the commands map.
`protected void`	`saveFolder(oracle.ifs.admin.tools.config.EnvironmentUtility.Folder folder)` Store name/value of folder instance in the folder map.
`void`	`setClasspathValue(String name, String value)` Store value for classpath with specified group name in the classpath map.
`void`	`setCommandValue(String name, String value)` Store value for command with specified name in the commands map.
`void`	`setFolderValue(String name, String value)` Store value for folder with specified name in the folder map.
`protected void`	`setPropertyAndWarnIfEmpty(Properties props, String propName, String propValue, String warnMsg2)` Sets the property in the provided Properties instance only if the associated property value is not null or empty.
`protected void`	`writeEnvironment(BufferedWriter w)` Write exportable classpath entries and commands out.
`protected void`	`writeProperties(BufferedWriter w)` Write folder and internal property entries out.

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

- Field Detail
  - IFS_INSTALL_ENVIRONMENT_VARIABLE
```
public static final String IFS_INSTALL_ENVIRONMENT_VARIABLE
```
    Environment variable to lookup to determine if running a dev environment
    
    See Also:
    
    Constant Field Values
  - UOA_JDBC_DATASOURCE
```
public static final String UOA_JDBC_DATASOURCE
```
    UOA JDBC Data Source name.
    
    See Also:
    
    Constant Field Values
  - DATASOURCE_REGEX_TNS
```
public static final String DATASOURCE_REGEX_TNS
```
    Datasource regular expression to match TNS style string group 1 should be host, 2 should be port, 3 should be servicename
    
    See Also:
    
    Constant Field Values
  - DATASOURCE_REGEX_JDBC_SID
```
public static final String DATASOURCE_REGEX_JDBC_SID
```
    Datasource regular expression to match jdbc connection style string with SID specified group 1 should be host, 2 should be port, 3 should be sid
    
    See Also:
    
    Constant Field Values
  - DATASOURCE_REGEX_JDBC_SERVICE
```
public static final String DATASOURCE_REGEX_JDBC_SERVICE
```
    Datasource regular expression to match jdbc connection style string with service name specified group 1 should be host, 2 should be port, 3 should be servicename
    
    See Also:
    
    Constant Field Values
  - APPLICABLE_DEV_ENV
```
protected static final String APPLICABLE_DEV_ENV
```
    Value for "applicable" attribute in xml configuration file to indicate development environment only.
    
    See Also:
    
    Constant Field Values
  - APPLICABLE_INSTALL_ENV
```
protected static final String APPLICABLE_INSTALL_ENV
```
    Value for "applicable" attribute in xml configuration file to indicate install environment only.
    
    See Also:
    
    Constant Field Values
  - APPLICABLE_BOTH
```
protected static final String APPLICABLE_BOTH
```
    Value for "applicable" attribute in xml configuration file to indicate both development and installation environments.
    
    See Also:
    
    Constant Field Values
  - m_Environment
```
protected static Map m_Environment
```
    Operating System environment variable map
  - m_Commands
```
protected final Map m_Commands
```
    a map containing command name/value tuples
  - m_Classpaths
```
protected final Map m_Classpaths
```
    a map containing classpathGroup name/classpath value tuples
  - m_Folders
```
protected final Map m_Folders
```
    a map containing folder name/path tuples
  - m_IsInstallEnvironment
```
protected final boolean m_IsInstallEnvironment
```
    Runtime configuration mode being leveraged: A value of false indicates utility leveraging dev environment configuration, a value of true indicates install environment configuration.
  - m_DirSep
```
protected String m_DirSep
```
    Operating system specific directory separator string to leverage
  - m_PathSep
```
protected String m_PathSep
```
    Operating system specific path separator string to leverage
  - m_Parser
```
protected SAXParser m_Parser
```
    XML SAX parser instance
- Constructor Detail
  - EnvironmentUtility
```
public EnvironmentUtility(boolean isInstallEnvironment)
```
    Constructor
    
    Parameters:
    
    isInstallEnvironment - runtime configuration mode to be leveraged true=install environment, false=development
- Method Detail
  - main
```
public static void main(String[] args)
```
    Initializes the utility.
    
    Parameters:
    
    args - command-line arguments
  - parseXmlStream
```
public void parseXmlStream(InputStream is)
```
  - writeEnvironment
```
protected void writeEnvironment(BufferedWriter w)
                         throws IOException
```
    Write exportable classpath entries and commands out.
    
    Parameters:
    
    w - buffered [file] writer
    
    Throws:
    
    IOException
  - writeProperties
```
protected void writeProperties(BufferedWriter w)
                        throws IOException
```
    Write folder and internal property entries out.
    
    Parameters:
    
    w - buffered [file] writer
    
    Throws:
    
    IOException
  - getInternalProperties
```
protected Properties getInternalProperties()
```
    Derives a set of properties specific to the particular runtime mode (development/install).
    
    Returns:
    
    set of derived internal properties, with some properties having potentially null values if no value could be obtained.
  - getInstallEnvironmentCommonSettings
```
protected Properties getInstallEnvironmentCommonSettings()
```
    Retrieves the 11g Installation environment settings from mbean server.
    
    Returns:
    
    set of properties
  - getCommands
```
public Map getCommands()
```
    Returns a map containing command name/value tuples Note: by convention keys starting with a bang "!" should not be externally output
    
    Returns:
    
    map with key command [export] name, value the command-value
  - getClasspaths
```
public Map getClasspaths()
```
    Returns a map containing classpath group name/classpath value tuples Note: classpath value always end with trailing path separator; Note: by convention keys starting with a bang "!" should not be externally output
    
    Returns:
    
    map with key classpath group name, value classpath
  - getFolders
```
public Map getFolders()
```
    Returns a map containing folder name/path tuples Note: by convention keys starting with a bang "!" should not be externally output
    
    Returns:
    
    map with key folder-name, value folder-path
  - setCommandValue
```
public void setCommandValue(String name,
                            String value)
```
    Store value for command with specified name in the commands map.
    
    Parameters:
    
    name - name of command
    
    value - value for specified command
  - getCommandValue
```
public String getCommandValue(String name)
```
    Return command value for specified command name from commands map. Note, returns null if specified command name not found in commands map
    
    Parameters:
    
    name - name of command
    
    Returns:
    
    value for specified command in map
  - setClasspathValue
```
public void setClasspathValue(String name,
                              String value)
```
    Store value for classpath with specified group name in the classpath map.
    
    Parameters:
    
    name - group name of classpath
    
    value - value for specified classpath
  - getClasspathValue
```
public String getClasspathValue(String name)
```
    Return classpath value for specified classpath group from classpath map. Note, returns null if specified classpath group not found in classpath map
    
    Parameters:
    
    name - group name of classpath
    
    Returns:
    
    classpath value for specified group in map
  - setFolderValue
```
public void setFolderValue(String name,
                           String value)
```
    Store value for folder with specified name in the folder map.
    
    Parameters:
    
    name - name of folder
    
    value - value for specified folder
  - getFolderValue
```
public String getFolderValue(String name)
```
    Return value for specified folder from folder map. Note, returns null if specified folder not found in folder map
    
    Parameters:
    
    name - name of folder
    
    Returns:
    
    value for specified folder in folder map
  - isApplicable
```
protected boolean isApplicable(String applicability)
```
    Determine if the provided applicability attribute value should result in processing continuing or being skipped. The runtime environment mode may be taken in to account.
    For example, if we are running in installation mode, and the provided applicability value is dev, then this method should return false indicating that processing should not take place.
    
    Parameters:
    
    applicability - should be one of both/dev/install
    
    Returns:
    
    true if processing should continue, false if processing should be skipped.
  - saveCommand
```
protected void saveCommand(oracle.ifs.admin.tools.config.EnvironmentUtility.Command command)
```
    Store name/value of command instance in the commands map.
    
    Parameters:
    
    command - command instance
  - saveClasspath
```
protected void saveClasspath(oracle.ifs.admin.tools.config.EnvironmentUtility.Classpath group)
```
    Store name/value of classpath group instance in the classpath map.
    
    Parameters:
    
    group - classpath group instance
  - saveFolder
```
protected void saveFolder(oracle.ifs.admin.tools.config.EnvironmentUtility.Folder folder)
```
    Store name/value of folder instance in the folder map.
    
    Parameters:
    
    folder - folder instance
  - log
```
protected void log(oracle.ifs.admin.tools.config.EnvironmentUtility.Command command)
```
    Log the specified command instance if non-null
    
    Parameters:
    
    command - the command instance to log.
  - log
```
protected void log(oracle.ifs.admin.tools.config.EnvironmentUtility.Classpath group)
```
    Log the specified classpath group instance if non-null
    
    Parameters:
    
    group - the classpath group instance to log.
  - log
```
protected void log(oracle.ifs.admin.tools.config.EnvironmentUtility.Folder f)
```
    Log the specified folder instance if non-null
    
    Parameters:
    
    f - the folder instance to log.
  - convertPath
```
protected String convertPath(String value)
```
    Return a path string derived from the specified path potentially replacing occurrences of unix directory separator with the windows directory separator should the windows directory seaparator be in use.
    
    Parameters:
    
    value - input path string
    
    Returns:
    
    operating system specific version of path string
  - addTrailingDirSep
```
protected String addTrailingDirSep(String path)
```
    Adds trailing directory separator to supplied path if required.
    
    Parameters:
    
    path - path to process
    
    Returns:
    
    supplied path guaranteed to termine with trailing directory separator
  - removeTrailingDirSepIfNotRoot
```
protected String removeTrailingDirSepIfNotRoot(String path)
```
    Removes the trailing directory separator if applicable from supplied paths that are not root folders
    
    Parameters:
    
    path - path to process
    
    Returns:
    
    supplied path trimmed of any trailing directory separator unless a root folder
  - addTrailingPathSep
```
protected String addTrailingPathSep(String classpath)
```
    Adds trailing path separator to supplied classpath if required.
    
    Parameters:
    
    classpath - classpath to process
    
    Returns:
    
    supplied classpath guaranteed to termine with trailing path separator
  - removeTrailingPathSep
```
protected String removeTrailingPathSep(String classpath)
```
    Removes the trailing path separator if applicable from supplied classpath
    
    Parameters:
    
    classpath - classpath to process
    
    Returns:
    
    supplied classpath trimmed of any trailing path separator
  - setPropertyAndWarnIfEmpty
```
protected void setPropertyAndWarnIfEmpty(Properties props,
                                         String propName,
                                         String propValue,
                                         String warnMsg2)
```
    Sets the property in the provided Properties instance only if the associated property value is not null or empty. If the value is empty, a warning message is logged.
    
    Parameters:
    
    props - Properties instance
    
    propName - Property Name
    
    propValue - Property Value
    
    warnMsg2 - Secondary warning message to be logged
  - closeStream
```
public static void closeStream(InputStream is)
```
    Close the specified inputstream if non-null, consuming any exception
    
    Parameters:
    
    is - the input stream.
  - closeWriter
```
public static void closeWriter(Writer w)
```
    Flush and close the specified writer if non-null, consuming any exception
    
    Parameters:
    
    w - the writer.
  - getAttributes
```
public static Map getAttributes(Attributes atts)
```
    Converts the specified Attributes instance in to a map of attribute qname (the key)/value pairs. Should an attribute of the same name occur more than once for the element, the value for the last instance is leveraged.
    Note, leading/trailing whitespace is trimmed from attribute name and value tuples.
    
    Parameters:
    
    atts - an Attributes instance
    
    Returns:
    
    A map containing attribute qname/value pairs
  - getEnvironmentValue
```
public static String getEnvironmentValue(String name)
```
    Return value for specified environment variable. Note, returns null if specified environment variable not found
    
    Parameters:
    
    name - name of environment variable
    
    Returns:
    
    value for specified environment variable
  - getEnvironmentVariables
```
public static Map getEnvironmentVariables()
```
    Returns a Map containing environment variable name-value pairs for the current executing environment.
    
    Returns:
    
    a Map containing env variable name-value pairs
  - getConsoleInputString
```
public String getConsoleInputString(String prompt,
                                    String defValue,
                                    boolean required,
                                    boolean echoInput)
```
    Get input string from the console, and return the result
    
    Parameters:
    
    prompt - the prompt
    
    defValue - the value to use if no input is specified
    
    required - boolean indication as to whether a value is required
    
    echoInput - boolean indication as to whether to echo the user's input
    
    Returns:
    
    the string result
  - getIfsDomain
```
public static String getIfsDomain(String databaseUrl,
                                  String ifsSchema)
```
    Attempts to synthesize an IFS domain string from the supplied database connection URL and IFS schema name. The database URL must be in a recognized format in order for the regular expression pattern matching to succeed. The current supported formats are (DESCRIPTION=(ADDRESS=... (HOST=xxxx)(PORT=xxxx)) (CONNECT_DATA=...(SERVICE_NAME=xxxx))) @:/ example jdbc:oracle:thin:@staml16.us.oracle.com:1521/orcl2.us.oracle.com @::
    
    Parameters:
    
    databaseUrl - database connection url
    
    ifsSchema - IFS schema name
    
    Returns:
    
    IFS domain string synthesized from the supplied database URL and IFS schema name; in the format ifs://host:port:servicename:schema
  - getIfsSchema
```
public static String getIfsSchema(String ifsDomain)
```
    Retrieves the IFS schema name connection component of the supplied IFS domain string.
    
    Parameters:
    
    ifsDomain - IFS domain string
    
    Returns:
    
    IFS schema name
  - getDatabaseUrl
```
public static String getDatabaseUrl(String ifsDomain)
```
    Synthesizes a basic database connection URL from the supplied IFS domain string. Note, the supplied IFS domain string value is assumed to be a database service-based connection. If the value instead represents a database SID-based connection, the variant getDatabaseUrl method must be leveraged supplying a true value for the asSID parameter.
    
    Parameters:
    
    ifsDomain - IFS domain string
    
    Returns:
    
    Database URL
  - getDatabaseUrl
```
public static String getDatabaseUrl(String ifsDomain,
                                    boolean asSID)
```
    Synthesizes a basic database connection URL from the supplied IFS domain string. The asSID property dictactes whether to generate a database connection string based on a SERVICE_NAME (false) or SID (true) interpretation of the IFS domain string.
    
    Parameters:
    
    ifsDomain - IFS domain string
    
    asSID - a true value indicates SID-based domain string interpretation, a false value indicates a SERVICE-based domain string interpretation
    
    Returns:
    
    Database URL
  - isEmptyTrimmed
```
protected static boolean isEmptyTrimmed(String value)
```
    Utility method to determine if a String instance is empty post trimming
    
    Parameters:
    
    value - String instance
    
    Returns:
    
    true if the String instance is null or empty string post trim, false otherwise.
  - isDevelopmentEnvironment
```
public static boolean isDevelopmentEnvironment()
```
    Returns true if the runtime environment appears to be a development environment.
    
    Returns:
    
    true if IFS_INSTALL_ENVIRONMENT=false, false otherwise
  - isInstallEnvironment
```
public static boolean isInstallEnvironment()
```
    Returns true if the runtime environment appears to be an installation environment.
    
    Returns:
    
    Currently returns !isDevelopmentEnvironment()
  - isWindows
```
public static boolean isWindows()
```
    Returns a boolean indicating whether this JVM appear to be running in a Windows based environment.
    
    Returns:
    
    true if the java system property os.name contains the string 'windows', false otherwise.

Class EnvironmentUtility

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

IFS_INSTALL_ENVIRONMENT_VARIABLE

UOA_JDBC_DATASOURCE

DATASOURCE_REGEX_TNS

DATASOURCE_REGEX_JDBC_SID

DATASOURCE_REGEX_JDBC_SERVICE

APPLICABLE_DEV_ENV

APPLICABLE_INSTALL_ENV

APPLICABLE_BOTH

m_Environment

m_Commands

m_Classpaths

m_Folders

m_IsInstallEnvironment

m_DirSep

m_PathSep

m_Parser

Constructor Detail

EnvironmentUtility

Method Detail

main

parseXmlStream

writeEnvironment

writeProperties

getInternalProperties

getInstallEnvironmentCommonSettings

getCommands

getClasspaths

getFolders

setCommandValue

getCommandValue

setClasspathValue

getClasspathValue

setFolderValue

getFolderValue

isApplicable

saveCommand

saveClasspath

saveFolder

log

log

log

convertPath

addTrailingDirSep

removeTrailingDirSepIfNotRoot

addTrailingPathSep

removeTrailingPathSep

setPropertyAndWarnIfEmpty

closeStream

closeWriter

getAttributes

getEnvironmentValue

getEnvironmentVariables

getConsoleInputString

getIfsDomain

getIfsSchema

getDatabaseUrl

getDatabaseUrl

isEmptyTrimmed

isDevelopmentEnvironment

isInstallEnvironment

isWindows