SystemPropertyConstants (Common Utilities 4.1 API)

java.lang.Object
- com.sun.enterprise.util.SystemPropertyConstants

public class SystemPropertyConstants
extends Object

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACCESSLOG_PROPERTY`
`static String`	`ADMIN_REALM`
`static String`	`AGENT_CERT_NICKNAME` The certificate nick name specified in the System-Jmx-Conenctor of the DAS with which a Node Agent synchronizes
`static String`	`AGENT_NAME_PROPERTY`
`static String`	`AGENT_ROOT_PROPERTY`
`static String`	`ANT_LIB_PROPERTY`
`static String`	`ANT_ROOT_PROPERTY`
`static String`	`CLIENT_TRUSTSTORE_PASSWORD_PROPERTY`
`static String`	`CLIENT_TRUSTSTORE_PROPERTY`
`static String`	`CLOSE`
`static String`	`CLUSTER_AWARE_FEATURE_FACTORY_CLASS`
`static String`	`CLUSTER_NAME` name of the server's cluster
`static String`	`CONFIG_NAME_PROPERTY`
`static String`	`CONFIG_ROOT_PROPERTY` Field
`static String`	`DAS_SERVER_CONFIG`
`static String`	`DAS_SERVER_NAME`
`static String`	`DEFAULT_ADMIN_PASSWORD`
`static String`	`DEFAULT_ADMIN_USER`
`static String`	`DEFAULT_LOCALE_PROPERTY` Field
`static String`	`DEFAULT_SERVER_INSTANCE_NAME` Deprecated.
`static String`	`DEFAULT_SERVER_SOCKET_ADDRESS`
`static String`	`DERBY_ROOT_PROPERTY`
`static String`	`DOCROOT_PROPERTY`
`static String`	`DOMAIN_NAME` name of the domain key
`static String`	`DOMAINS_ROOT_PROPERTY` Field
`static String`	`DROP_INTERRUPTED_COMMANDS`
`static String`	`HADB_ROOT_PROPERTY` name of the HADB location property
`static String`	`HOST_NAME_PROPERTY`
`static String`	`ICU_LIB_PROPERTY` Field
`static String`	`IMQ_BIN_PROPERTY` Field
`static String`	`IMQ_LIB_PROPERTY` Field
`static String`	`INSTALL_ROOT_PROPERTY` Field
`static String`	`INSTANCE_ROOT_PROPERTY` Field
`static String`	`JATO_ROOT_PROPERTY`
`static String`	`JAVA_ROOT_PROPERTY` Field
`static String`	`JAVA_ROOT_PROPERTY_ASENV`
`static String`	`JDMK_HOME_PROPERTY`
`static String`	`JHELP_ROOT_PROPERTY`
`static String`	`JKS_KEYSTORE`
`static String`	`JKS_TRUSTSTORE`
`static String`	`KEYSTORE_PROPERTY`
`static String`	`KILL_SERV_OS`
`static String`	`KILL_SERV_UNIX`
`static String`	`KILL_SERV_WIN`
`static String`	`KILLSERV_SCRIPT`
`static String`	`MFWK_HOME_PROPERTY` Java ES Monitoring Framework install directory
`static String`	`MONDOT`
`static String`	`NATIVE_LAUNCHER`
`static String`	`NATIVE_LAUNCHER_LIB_PREFIX`
`static String`	`NSS_BIN_PROPERTY`
`static String`	`NSS_DB_PASSWORD_PROPERTY`
`static String`	`NSS_DB_PROPERTY`
`static String`	`NSS_ROOT_PROPERTY`
`static String`	`OPEN`
`static String`	`PERL_ROOT_PROPERTY` Field
`static String`	`PID_FILE`
`static String`	`PRODUCT_ROOT_PROPERTY` Field
`static String`	`REF_TS_FILE`
`static String`	`SERVER_NAME` name of the server instance key
`static String`	`SLASH` Field used by Monitoring to encode a forward slash and/or dot
`static String`	`TEMPLATE_CONFIG_NAME` Name of the default config that determines the configuration for the instances
`static String`	`TRUSTSTORE_PROPERTY`
`static String`	`UNIX_ASENV_FILENAME` Field
`static String`	`WEB_SERVICES_LIB_PROPERTY` Field
`static String`	`WEBCONSOLE_APP_PROPERTY`
`static String`	`WEBCONSOLE_LIB_PROPERTY` Field
`static String`	`WINDOWS_ASENV_FILENAME` Field

Constructor Summary

Constructors
Constructor and Description

SystemPropertyConstants()

Constructors
Constructor and Description
`SystemPropertyConstants()`

Method Summary

Methods
Modifier and Type	Method and Description
`static String`	`getAccessLogDefaultValue()` Returns the default value (as would appear in the domain.xml on installation) of file where the acess log of a virtual server is stored, as a String.
`static String`	`getAdminScriptLocation(String installRoot)`
`static String`	`getAsAdminScriptLocation()` Returns the system specific file.separator delimited path to the asadmin script.
`static String`	`getAsAdminScriptLocation(String installRoot)`
`static String`	`getComponentName()` Returns the component identifier associated with the INSTALL_ROOT.
`static String`	`getDocRootDefaultValue()` Returns the default value (as would appear in the domain.xml on installation) of docroot of a virtual server, as a String.
`static String`	`getPropertyAsValue(String name)` A method that returns the passed String as a property that can be replaced at run time.
`static boolean`	`isSystemPropertySyntax(String s)`
`static String`	`unSystemProperty(String sp)` Returns the string removing the "system-property syntax" from it.

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

- Field Detail
  - SLASH
```
public static final String SLASH
```
    Field used by Monitoring to encode a forward slash and/or dot
    
    See Also:
    Constant Field Values
  - MONDOT
```
public static final String MONDOT
```
    See Also:
    Constant Field Values
  - UNIX_ASENV_FILENAME
```
public static final String UNIX_ASENV_FILENAME
```
    Field
    
    See Also:
    Constant Field Values
  - WINDOWS_ASENV_FILENAME
```
public static final String WINDOWS_ASENV_FILENAME
```
    Field
    
    See Also:
    Constant Field Values
  - WEB_SERVICES_LIB_PROPERTY
```
public static final String WEB_SERVICES_LIB_PROPERTY
```
    Field
    
    See Also:
    Constant Field Values
  - PERL_ROOT_PROPERTY
```
public static final String PERL_ROOT_PROPERTY
```
    Field
    
    See Also:
    Constant Field Values
  - IMQ_LIB_PROPERTY
```
public static final String IMQ_LIB_PROPERTY
```
    Field
    
    See Also:
    Constant Field Values
  - IMQ_BIN_PROPERTY
```
public static final String IMQ_BIN_PROPERTY
```
    Field
    
    See Also:
    Constant Field Values
  - CONFIG_ROOT_PROPERTY
```
public static final String CONFIG_ROOT_PROPERTY
```
    Field
    
    See Also:
    Constant Field Values
  - INSTALL_ROOT_PROPERTY
```
public static final String INSTALL_ROOT_PROPERTY
```
    Field
    
    See Also:
    Constant Field Values
  - PRODUCT_ROOT_PROPERTY
```
public static final String PRODUCT_ROOT_PROPERTY
```
    Field
    
    See Also:
    Constant Field Values
  - JAVA_ROOT_PROPERTY
```
public static final String JAVA_ROOT_PROPERTY
```
    Field
    
    See Also:
    Constant Field Values
  - JAVA_ROOT_PROPERTY_ASENV
```
public static final String JAVA_ROOT_PROPERTY_ASENV
```
    See Also:
    Constant Field Values
  - ICU_LIB_PROPERTY
```
public static final String ICU_LIB_PROPERTY
```
    Field
    
    See Also:
    Constant Field Values
  - DEFAULT_LOCALE_PROPERTY
```
public static final String DEFAULT_LOCALE_PROPERTY
```
    Field
    
    See Also:
    Constant Field Values
  - DOMAINS_ROOT_PROPERTY
```
public static final String DOMAINS_ROOT_PROPERTY
```
    Field
    
    See Also:
    Constant Field Values
  - INSTANCE_ROOT_PROPERTY
```
public static final String INSTANCE_ROOT_PROPERTY
```
    Field
    
    See Also:
    Constant Field Values
  - AGENT_CERT_NICKNAME
```
public static final String AGENT_CERT_NICKNAME
```
    The certificate nick name specified in the System-Jmx-Conenctor of the DAS with which a Node Agent synchronizes
    
    See Also:
    Constant Field Values
  - AGENT_ROOT_PROPERTY
```
public static final String AGENT_ROOT_PROPERTY
```
    See Also:
    Constant Field Values
  - AGENT_NAME_PROPERTY
```
public static final String AGENT_NAME_PROPERTY
```
    See Also:
    Constant Field Values
  - WEBCONSOLE_LIB_PROPERTY
```
public static final String WEBCONSOLE_LIB_PROPERTY
```
    Field
    
    See Also:
    Constant Field Values
  - WEBCONSOLE_APP_PROPERTY
```
public static final String WEBCONSOLE_APP_PROPERTY
```
    See Also:
    Constant Field Values
  - JATO_ROOT_PROPERTY
```
public static final String JATO_ROOT_PROPERTY
```
    See Also:
    Constant Field Values
  - ANT_ROOT_PROPERTY
```
public static final String ANT_ROOT_PROPERTY
```
    See Also:
    Constant Field Values
  - ANT_LIB_PROPERTY
```
public static final String ANT_LIB_PROPERTY
```
    See Also:
    Constant Field Values
  - JHELP_ROOT_PROPERTY
```
public static final String JHELP_ROOT_PROPERTY
```
    See Also:
    Constant Field Values
  - SERVER_NAME
```
public static final String SERVER_NAME
```
    name of the server instance key
    
    See Also:
    Constant Field Values
  - CLUSTER_NAME
```
public static final String CLUSTER_NAME
```
    name of the server's cluster
    
    See Also:
    Constant Field Values
  - HADB_ROOT_PROPERTY
```
public static final String HADB_ROOT_PROPERTY
```
    name of the HADB location property
    
    See Also:
    Constant Field Values
  - NSS_ROOT_PROPERTY
```
public static final String NSS_ROOT_PROPERTY
```
    See Also:
    Constant Field Values
  - NSS_BIN_PROPERTY
```
public static final String NSS_BIN_PROPERTY
```
    See Also:
    Constant Field Values
  - NATIVE_LAUNCHER
```
public static final String NATIVE_LAUNCHER
```
    See Also:
    Constant Field Values
  - NATIVE_LAUNCHER_LIB_PREFIX
```
public static final String NATIVE_LAUNCHER_LIB_PREFIX
```
    See Also:
    Constant Field Values
  - KEYSTORE_PROPERTY
```
public static final String KEYSTORE_PROPERTY
```
    See Also:
    Constant Field Values
  - JKS_KEYSTORE
```
public static final String JKS_KEYSTORE
```
  - TRUSTSTORE_PROPERTY
```
public static final String TRUSTSTORE_PROPERTY
```
    See Also:
    Constant Field Values
  - JKS_TRUSTSTORE
```
public static final String JKS_TRUSTSTORE
```
  - ADMIN_REALM
```
public static final String ADMIN_REALM
```
    See Also:
    Constant Field Values
  - NSS_DB_PROPERTY
```
public static final String NSS_DB_PROPERTY
```
    See Also:
    Constant Field Values
  - NSS_DB_PASSWORD_PROPERTY
```
public static final String NSS_DB_PASSWORD_PROPERTY
```
    See Also:
    Constant Field Values
  - CLIENT_TRUSTSTORE_PROPERTY
```
public static final String CLIENT_TRUSTSTORE_PROPERTY
```
    See Also:
    Constant Field Values
  - CLIENT_TRUSTSTORE_PASSWORD_PROPERTY
```
public static final String CLIENT_TRUSTSTORE_PASSWORD_PROPERTY
```
    See Also:
    Constant Field Values
  - PID_FILE
```
public static final String PID_FILE
```
    See Also:
    Constant Field Values
  - REF_TS_FILE
```
public static final String REF_TS_FILE
```
    See Also:
    Constant Field Values
  - KILLSERV_SCRIPT
```
public static final String KILLSERV_SCRIPT
```
    See Also:
    Constant Field Values
  - KILL_SERV_UNIX
```
public static final String KILL_SERV_UNIX
```
    See Also:
    Constant Field Values
  - KILL_SERV_WIN
```
public static final String KILL_SERV_WIN
```
    See Also:
    Constant Field Values
  - KILL_SERV_OS
```
public static final String KILL_SERV_OS
```
  - DEFAULT_SERVER_INSTANCE_NAME
```
@Deprecated
public static final String DEFAULT_SERVER_INSTANCE_NAME
```
    Deprecated.
    
    See Also:
    Constant Field Values
  - DAS_SERVER_NAME
```
public static final String DAS_SERVER_NAME
```
    See Also:
    Constant Field Values
  - DAS_SERVER_CONFIG
```
public static final String DAS_SERVER_CONFIG
```
    See Also:
    Constant Field Values
  - JDMK_HOME_PROPERTY
```
public static final String JDMK_HOME_PROPERTY
```
    See Also:
    Constant Field Values
  - DERBY_ROOT_PROPERTY
```
public static final String DERBY_ROOT_PROPERTY
```
    See Also:
    Constant Field Values
  - MFWK_HOME_PROPERTY
```
public static final String MFWK_HOME_PROPERTY
```
    Java ES Monitoring Framework install directory
    
    See Also:
    Constant Field Values
  - DOMAIN_NAME
```
public static final String DOMAIN_NAME
```
    name of the domain key
    
    See Also:
    Constant Field Values
  - HOST_NAME_PROPERTY
```
public static final String HOST_NAME_PROPERTY
```
    See Also:
    Constant Field Values
  - CONFIG_NAME_PROPERTY
```
public static final String CONFIG_NAME_PROPERTY
```
    See Also:
    Constant Field Values
  - DOCROOT_PROPERTY
```
public static final String DOCROOT_PROPERTY
```
    See Also:
    Constant Field Values
  - ACCESSLOG_PROPERTY
```
public static final String ACCESSLOG_PROPERTY
```
    See Also:
    Constant Field Values
  - DEFAULT_SERVER_SOCKET_ADDRESS
```
public static final String DEFAULT_SERVER_SOCKET_ADDRESS
```
    See Also:
    Constant Field Values
  - CLUSTER_AWARE_FEATURE_FACTORY_CLASS
```
public static final String CLUSTER_AWARE_FEATURE_FACTORY_CLASS
```
    See Also:
    Constant Field Values
  - DROP_INTERRUPTED_COMMANDS
```
public static final String DROP_INTERRUPTED_COMMANDS
```
    See Also:
    Constant Field Values
  - TEMPLATE_CONFIG_NAME
```
public static final String TEMPLATE_CONFIG_NAME
```
    Name of the default config that determines the configuration for the instances
    
    See Also:
    Constant Field Values
  - DEFAULT_ADMIN_USER
```
public static final String DEFAULT_ADMIN_USER
```
    See Also:
    Constant Field Values
  - DEFAULT_ADMIN_PASSWORD
```
public static final String DEFAULT_ADMIN_PASSWORD
```
    See Also:
    Constant Field Values
  - OPEN
```
public static final String OPEN
```
    See Also:
    Constant Field Values
  - CLOSE
```
public static final String CLOSE
```
    See Also:
    Constant Field Values
- Constructor Detail
  - SystemPropertyConstants
```
public SystemPropertyConstants()
```
- Method Detail
  - getPropertyAsValue
```
public static final String getPropertyAsValue(String name)
```
    A method that returns the passed String as a property that can be replaced at run time.
    
    Parameters:
    name - String that represents a property, e.g INSTANCE_ROOT_PROPERTY in this class. The String may not be null.
    
    Returns:
    a String that represents the replaceable value of passed String. Generally speaking it will be decorated with a pair of braces with $ in the front (e.g. "a" will be returned as "${a}").
    
    Throws:
    
    IllegalArgumentException - if the passed String is null
  - unSystemProperty
```
public static final String unSystemProperty(String sp)
```
    Returns the string removing the "system-property syntax" from it. If the given string is not in "system-property syntax" the same string is returned. The "system-propery syntax" is "${...}" The given String may not be null. The returned String may be an empty String, if it is of the form "${}" (rarely so).
  - isSystemPropertySyntax
```
public static final boolean isSystemPropertySyntax(String s)
```
  - getDocRootDefaultValue
```
public static final String getDocRootDefaultValue()
```
    Returns the default value (as would appear in the domain.xml on installation) of docroot of a virtual server, as a String. Never returns a null. Returned String contains no backslashes. Note that it is not the absolute value of the path on a file system.
  getAccessLogDefaultValue
  
  public static final String getAccessLogDefaultValue()
  
  Returns the default value (as would appear in the domain.xml on installation) of file where the acess log of a virtual server is stored, as a String. Never returns a null. Returned String contains no backslashes. Note that it is not the absolute value of the path on a file system.
  
  getAsAdminScriptLocation
  
  public static final String getAsAdminScriptLocation()
  
  Returns the system specific file.separator delimited path to the asadmin script. Any changes to file layout should be reflected here. The path will contain '/' as the separator character, regardless of operating platform. Never returns a null. Assumes the the property "INSTALL_ROOT_PROPERTY" is set in the VM before calling this. As of now (September 2005) all the server instances and asadmin VM itself has this property set. The method does not guarantee that the script exists on the given system. It should only be used when caller wants to know the location of the script. Caller should make sure it exists.
  
  Returns:
  String representing the Path to asadmin script. Might return a string beginning with "null", if the INSTALL_ROOT_PROPERTY is not defined
  
  getAsAdminScriptLocation
  
  public static final String getAsAdminScriptLocation(String installRoot)
  
  getAdminScriptLocation
  
  public static final String getAdminScriptLocation(String installRoot)
  
  getComponentName
  
  public static final String getComponentName()
  
  Returns the component identifier associated with the INSTALL_ROOT. For example if INSTALL_ROOT is /home/glassfish4/glassfish the component name will "glassfish".
  
  Returns:
  String representing the component identifier.

Class SystemPropertyConstants

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SLASH

MONDOT

UNIX_ASENV_FILENAME

WINDOWS_ASENV_FILENAME

WEB_SERVICES_LIB_PROPERTY

PERL_ROOT_PROPERTY

IMQ_LIB_PROPERTY

IMQ_BIN_PROPERTY

CONFIG_ROOT_PROPERTY

INSTALL_ROOT_PROPERTY

PRODUCT_ROOT_PROPERTY

JAVA_ROOT_PROPERTY

JAVA_ROOT_PROPERTY_ASENV

ICU_LIB_PROPERTY

DEFAULT_LOCALE_PROPERTY

DOMAINS_ROOT_PROPERTY

INSTANCE_ROOT_PROPERTY

AGENT_CERT_NICKNAME

AGENT_ROOT_PROPERTY

AGENT_NAME_PROPERTY

WEBCONSOLE_LIB_PROPERTY

WEBCONSOLE_APP_PROPERTY

JATO_ROOT_PROPERTY

ANT_ROOT_PROPERTY

ANT_LIB_PROPERTY

JHELP_ROOT_PROPERTY

SERVER_NAME

CLUSTER_NAME

HADB_ROOT_PROPERTY

NSS_ROOT_PROPERTY

NSS_BIN_PROPERTY

NATIVE_LAUNCHER

NATIVE_LAUNCHER_LIB_PREFIX

KEYSTORE_PROPERTY

JKS_KEYSTORE

TRUSTSTORE_PROPERTY

JKS_TRUSTSTORE

ADMIN_REALM

NSS_DB_PROPERTY

NSS_DB_PASSWORD_PROPERTY

CLIENT_TRUSTSTORE_PROPERTY

CLIENT_TRUSTSTORE_PASSWORD_PROPERTY

PID_FILE

REF_TS_FILE

KILLSERV_SCRIPT

KILL_SERV_UNIX

KILL_SERV_WIN

KILL_SERV_OS

DEFAULT_SERVER_INSTANCE_NAME

DAS_SERVER_NAME

DAS_SERVER_CONFIG

JDMK_HOME_PROPERTY

DERBY_ROOT_PROPERTY

MFWK_HOME_PROPERTY

DOMAIN_NAME

HOST_NAME_PROPERTY

CONFIG_NAME_PROPERTY

DOCROOT_PROPERTY

ACCESSLOG_PROPERTY

DEFAULT_SERVER_SOCKET_ADDRESS

CLUSTER_AWARE_FEATURE_FACTORY_CLASS

DROP_INTERRUPTED_COMMANDS

TEMPLATE_CONFIG_NAME

DEFAULT_ADMIN_USER

DEFAULT_ADMIN_PASSWORD

OPEN

CLOSE

Constructor Detail

SystemPropertyConstants

Method Detail

getPropertyAsValue

unSystemProperty

isSystemPropertySyntax

getDocRootDefaultValue