com.eibus.util.system

Class EIBProperties

java.lang.Object

com.eibus.util.system.EIBProperties

public class EIBProperties
extends java.lang.Object

Gives access to properties defined in a file named 'wcp.properties', merged with the System properties.
The file is searched in %CORDYS_INSTALL_DIR%/config This class supports access to the WCP properties and the system properties. EIBProperties is nothing more than a thin wrapper around the system properties. It makes sure the wcp.properties file is loaded before properties are accessed.

The properties can be defined in the following way:

1. System properties, e.g. using the java -D flag (use java -DpropertyName=value class.to.start).
2. Define the property in the properties file in the directory defined above.
3. Using EIBProperties.getProperties().put("name", "value")

The properties are searched in the above order. The first definition overrides later ones. As an example, a property that is defined using the -D option, overrides definitions from the wcp.properties file.

Author:

Han Kessels, Johan Rosman

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CACHE_SIZE Deprecated.
static java.lang.String	CACHE_TIMEOUT Deprecated.
static java.lang.String	COMPONENT Determines the name of the current component.
static java.lang.String	CONFIG_DIRECTORY_NAME Name of the directory containing the wcp.properties file inside CORDYS_INSTALL_DIR
static java.lang.String	CORDYS_INSTANCE_NAME Determines the Cordys instance name
static java.lang.String	DEFAULT_BACKEND Determines the name of the System Property denoting what the default backend name is for new business document managers
static java.lang.String	DEFAULT_CONNECTION_POINT Determines the name of the System Property denoting what the default uri is that should be used when starting an anonymous client
static java.lang.String	DEFAULT_ITERATOR_SIZE Determines the name of the System Property denoting what the default value is for the initial size of new iterators
static java.lang.String	DEFAULT_PROTOCOL Determines the name of the System Property denoting which class should be used for the middleware connection
static java.lang.String	DEFAULT_TIMEOUT Determines the name of the System Property denoting what the default value is for the timeout for synchronous calls in BusinessDocumentManagers
static java.lang.String	DIRECTORY_PORT Deprecated.
static java.lang.String	DIRECTORY_ROOT Deprecated.
static java.lang.String	GUID_FACTORY Determines the name of the System Property denoting which class should be used for the Guid Factory
static java.lang.String	INSTALL_DIR Determines the name of the Systems Environment variable where in the name of the EIB install directory is saved
static java.lang.String	LDAP_CACHE_SIZE Size of LDAP cache
static java.lang.String	LDAP_CACHE_TIMEOUT Lifetime of objects in LDAP cache
static java.lang.String	LDAP_PASSWORD Password with which to connect to the LDAP server
static java.lang.String	LDAP_PORT Port on which LDAP server can be reached
static java.lang.String	LDAP_ROOT Determines the root object in the directory service
static java.lang.String	LDAP_SERVER Server on which LDAP can be reached
static java.lang.String	LDAP_USER User name with which to connect to the LDAP server
static Logger	LOGGER
static java.lang.String	MAX_READERS Determines the name of the System Property denoting the maximum number of reading connections can be active at the same time (e.g.
static java.lang.String	PROPERTIES_FILE The name of the properties file to search for.
static java.lang.String	QUEUE_READ_TIMEOUT Deprecated. please use the connection point specific settings for this
static java.lang.String	SAX_PARSER Determines the name of the System Property denoting which class should be used for the SAX parser
static java.lang.String	SPY_FILE Deprecated. use com.eibus.util.logger.CordysLogger instead.
static java.lang.String	SPY_PUBLISH Deprecated. use com.eibus.util.logger.CordysLogger instead.
static java.lang.String	UNICODE_FONT
static java.lang.String	USER Determines the name of the System Property denoting what the User name is.
static java.lang.String	WEB_DIR Determines the name of the Systems Environment variable where in the name of the EIB web directory is saved

Constructor Summary

Constructors

Constructor and Description
EIBProperties()

Method Summary

Modifier and Type	Method and Description
static java.util.Locale	_localeFromString(java.lang.String strLocale)
static java.util.Locale	get_ManagementLocale() Provides Locale object prepared from language, country code specified using property com.eibus.management.locale .
static java.util.Locale	get_SystemDefaultLocale() Provides Locale object prepared from language, country code specified using property com.eibus.defaultLocale.
static boolean	getBoolean(java.lang.String name) Returns is true if and only if the (system) property named by the argument exists and is equal to the string "true".
static boolean	getBoolean(java.lang.String name, boolean defaultValue) Returns is true if and only if the (system) property named by the argument exists and is equal to the string "true".
static java.lang.String	getDefaultPropertiesFileName()
static java.lang.String	getFontName()
static java.lang.String	getInstallDir() Get the Cordys Installation directory: Read from environment variable, if fail then read it from CORDYS_HOME or CORDYS_INSTALL_DIR
static java.lang.Integer	getInteger(java.lang.String name) Determines the integer value of the (system) property with the specified name.
static java.lang.Integer	getInteger(java.lang.String name, int defaultValue) Determines the integer value of the system property with the specified name.
static java.lang.Integer	getInteger(java.lang.String name, java.lang.Integer defaultValue) Determines the integer value of the (system) property with the specified name.
static java.lang.String	getLDAPServer() Deprecated.
static java.lang.String	getLoadedPropertiesFileName()
static java.lang.Long	getLong(java.lang.String name) Determines the long value of the (system) property with the specified name.
static java.lang.Long	getLong(java.lang.String name, java.lang.Long defaultValue) Determines the long value of the (system) property with the specified name.
static java.util.Properties	getProperties() The current effective set of properties is returned as a Properties object.
static java.lang.String	getProperty(java.lang.String propertyName) Gets the (system) property indicated by the specified key.
static java.lang.String	getProperty(java.lang.String propertyName, java.lang.String defaultValue) Gets the (system) property indicated by the specified key.
static java.lang.String	getSystemRoot() Get OSInstallation Directory
static java.lang.String	getWebDir() Get the Cordys Web directory as defined by the wcp property 'web.root'.
static boolean	isValidFileEncoding()
protected static boolean	loadProperties(java.lang.String filePath) Method that loads the properties from filesystem.
static java.util.Properties	loadPropertiesFromFile(java.lang.String fileName) Load only the Eib Properties from a file without merging with default and system properties
static void	saveProperties(java.util.Properties np) Save a set of wcp property in the runtime properties as well in the properties file.
static void	savePropertiesToFile(java.util.Properties np, java.lang.String fileName) Save only the Eib Properties to a file without merging with default and system properties
static void	saveProperty(java.lang.String name, java.lang.String value) Save a particular wcp property in the runtime properties as well in the properties file.
static void	setInstallDir(java.lang.String installDir) Set the value of the Install Dir in the environment.
static void	setLDAPServer(java.lang.String ldapServer) Set the value of the LDAP Server in the environment.
static void	setLoader(com.eibus.util.system.EIBProperties.PropertiesLoader ignored) Deprecated.
static void	setUserName(java.lang.String username)
static void	setWebDir(java.lang.String webDir) Set the value of the Web Dir in the environment.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CONFIG_DIRECTORY_NAME

public static final java.lang.String CONFIG_DIRECTORY_NAME

Name of the directory containing the wcp.properties file inside CORDYS_INSTALL_DIR

See Also:

Constant Field Values

PROPERTIES_FILE

public static final java.lang.String PROPERTIES_FILE

The name of the properties file to search for.

See Also:

Constant Field Values

LDAP_SERVER

public static final java.lang.String LDAP_SERVER

Server on which LDAP can be reached

See Also:

Constant Field Values

LDAP_PORT

public static final java.lang.String LDAP_PORT

Port on which LDAP server can be reached

See Also:

Constant Field Values

LDAP_USER

public static final java.lang.String LDAP_USER

User name with which to connect to the LDAP server

See Also:

Constant Field Values

LDAP_PASSWORD

public static final java.lang.String LDAP_PASSWORD

Password with which to connect to the LDAP server

See Also:

Constant Field Values

LDAP_CACHE_SIZE

public static final java.lang.String LDAP_CACHE_SIZE

Size of LDAP cache

See Also:

Constant Field Values

LDAP_CACHE_TIMEOUT

public static final java.lang.String LDAP_CACHE_TIMEOUT

Lifetime of objects in LDAP cache

See Also:

Constant Field Values

LDAP_ROOT

public static final java.lang.String LDAP_ROOT

Determines the root object in the directory service

See Also:

Constant Field Values

CACHE_SIZE

@Deprecated
public static final java.lang.String CACHE_SIZE

Deprecated.

Size of LDAP cache

See Also:

Constant Field Values

CACHE_TIMEOUT

@Deprecated
public static final java.lang.String CACHE_TIMEOUT

Deprecated.

Lifetime of objects in LDAP cache

See Also:

Constant Field Values

DIRECTORY_PORT

@Deprecated
public static final java.lang.String DIRECTORY_PORT

Deprecated.

Port on which LDAP server can be reached

See Also:

Constant Field Values

DIRECTORY_ROOT

@Deprecated
public static final java.lang.String DIRECTORY_ROOT

Deprecated.

Determines the root object in the directory service

See Also:

Constant Field Values

COMPONENT

public static final java.lang.String COMPONENT

Determines the name of the current component. If none is specified, B3 defaults to the current machine name (inclusive domain name).

See Also:

Constant Field Values

SAX_PARSER

public static final java.lang.String SAX_PARSER

Determines the name of the System Property denoting which class should be used for the SAX parser

See Also:

Constant Field Values

GUID_FACTORY

public static final java.lang.String GUID_FACTORY

Determines the name of the System Property denoting which class should be used for the Guid Factory

See Also:

Constant Field Values

MAX_READERS

public static final java.lang.String MAX_READERS

Determines the name of the System Property denoting the maximum number of reading connections can be active at the same time (e.g. how many clients may make a connection to a socket server)

See Also:

Constant Field Values

DEFAULT_PROTOCOL

public static final java.lang.String DEFAULT_PROTOCOL

Determines the name of the System Property denoting which class should be used for the middleware connection

See Also:

Constant Field Values

DEFAULT_CONNECTION_POINT

public static final java.lang.String DEFAULT_CONNECTION_POINT

Determines the name of the System Property denoting what the default uri is that should be used when starting an anonymous client

See Also:

Constant Field Values

DEFAULT_TIMEOUT

public static final java.lang.String DEFAULT_TIMEOUT

Determines the name of the System Property denoting what the default value is for the timeout for synchronous calls in BusinessDocumentManagers

See Also:

Constant Field Values

DEFAULT_ITERATOR_SIZE

public static final java.lang.String DEFAULT_ITERATOR_SIZE

Determines the name of the System Property denoting what the default value is for the initial size of new iterators

See Also:

Constant Field Values

QUEUE_READ_TIMEOUT

@Deprecated
public static final java.lang.String QUEUE_READ_TIMEOUT

Deprecated. please use the connection point specific settings for this

Determines the name of the System Property denoting what the timeout in milliseconds is for reading messages from a queue.

See Also:

Constant Field Values

DEFAULT_BACKEND

public static final java.lang.String DEFAULT_BACKEND

Determines the name of the System Property denoting what the default backend name is for new business document managers

See Also:

Constant Field Values

USER

public static final java.lang.String USER

Determines the name of the System Property denoting what the User name is.

See Also:

Constant Field Values

INSTALL_DIR

public static final java.lang.String INSTALL_DIR

Determines the name of the Systems Environment variable where in the name of the EIB install directory is saved

See Also:

Constant Field Values

WEB_DIR

public static final java.lang.String WEB_DIR

Determines the name of the Systems Environment variable where in the name of the EIB web directory is saved

See Also:

Constant Field Values

SPY_PUBLISH

@Deprecated
public static final java.lang.String SPY_PUBLISH

Deprecated. use com.eibus.util.logger.CordysLogger instead.

Spy properties

See Also:

Constant Field Values

SPY_FILE

@Deprecated
public static final java.lang.String SPY_FILE

Deprecated. use com.eibus.util.logger.CordysLogger instead.

Spy properties

See Also:

Constant Field Values

UNICODE_FONT

public static final java.lang.String UNICODE_FONT

See Also:

Constant Field Values

CORDYS_INSTANCE_NAME

public static final java.lang.String CORDYS_INSTANCE_NAME

Determines the Cordys instance name

See Also:

Constant Field Values

LOGGER

public static final Logger LOGGER

Constructor Detail

EIBProperties

public EIBProperties()

Method Detail

loadProperties

protected static boolean loadProperties(java.lang.String filePath)

Method that loads the properties from filesystem. The properties are added to the given set of default properties. No new properties object is created, the same Properties object is returned.

Parameters:

filePath - the name of the property file.

Returns:

true if new properties are loaded

setLoader

@Deprecated
public static void setLoader(com.eibus.util.system.EIBProperties.PropertiesLoader ignored)

Deprecated.

getProperty

public static java.lang.String getProperty(java.lang.String propertyName)

Gets the (system) property indicated by the specified key. Note: This method returns null for system properties that can't be accessed. No security exceptions are thrown.

Parameters:

key - the name of the system property.

Returns:

the string value of the (system) property, or null if there is no property with that key.

getProperty

public static java.lang.String getProperty(java.lang.String propertyName,
                                           java.lang.String defaultValue)

Gets the (system) property indicated by the specified key.

If there is no current set of system properties, a set of system properties is first created and initialized in the same manner as for the getProperties method. Note: This method returns the default for system properties that can't be accessed. No security exceptions are thrown.

Parameters:

key - the name of the (system) property.

defaultValue - a default value.

Returns:

the string value of the (system) property, or the default value if there is no property with that key.

getProperties

public static java.util.Properties getProperties()

The current effective set of properties is returned as a Properties object.

Returns:

the wcp properties.

getBoolean

public static boolean getBoolean(java.lang.String name)

Returns is true if and only if the (system) property named by the argument exists and is equal to the string "true".

Parameters:

name - the (system) property name.

Returns:

the boolean value of the system property.

getBoolean

public static boolean getBoolean(java.lang.String name,
                                 boolean defaultValue)

Returns is true if and only if the (system) property named by the argument exists and is equal to the string "true".

Parameters:

name - the (system) property name.

defaultValue - the default value

Returns:

the boolean value of the system property.

getInteger

public static java.lang.Integer getInteger(java.lang.String name)

Determines the integer value of the (system) property with the specified name.

The first argument is treated as the name of a (system) property. The string value of this property is then interpreted as an integer value and an Integer object representing this value is returned. Details of possible numeric formats can be found with the definition of getProperty.

If there is no property with the specified name, or if the property does not have the correct numeric format, then null is returned.

Parameters:

name - property name.

Returns:

the Integer value of the property.

See Also:

System.getProperty(java.lang.String), System.getProperty(java.lang.String, java.lang.String)

getInteger

public static java.lang.Integer getInteger(java.lang.String name,
                                           int defaultValue)

Determines the integer value of the system property with the specified name.

The first argument is treated as the name of a (system) property. Properties are accessible through getProperty The string value of this property is then interpreted as an integer value and an Integer object representing this value is returned. Details of possible numeric formats can be found with the definition of getProperty.

If there is no property with the specified name, or if the property does not have the correct numeric format, then an Integer object that represents the value of the second argument is returned.

Deprecation notice: This method might get deprecated in the future, so use getInteger(String,Integer) instead.

Parameters:

name - property name.

defaultValue - default value.

Returns:

the Integer value of the property.

getInteger

public static java.lang.Integer getInteger(java.lang.String name,
                                           java.lang.Integer defaultValue)

Determines the integer value of the (system) property with the specified name.

The first argument is treated as the name of a (system) property. The string value of this property is then interpreted as an integer value and an Integer object representing this value is returned.

If the property value begins with "0x" or "#", not followed by a minus sign, the rest of it is parsed as a hexadecimal integer exactly as for the method Integer.valueOf with radix 16.

If the property value begins with "0" then it is parsed as an octal integer exactly as for the method Integer.valueOf with radix 8.

Otherwise the property value is parsed as a decimal integer exactly as for the method Integer.valueOf with radix 10.

The second argument is the default value. If there is no property of the specified name, or if the property does not have the correct numeric format, then the second argument is returned.

Parameters:

name - property name.

defaultValue - default value.

Returns:

the Integer value of the property.

getLong

public static java.lang.Long getLong(java.lang.String name)

Determines the long value of the (system) property with the specified name.

The first argument is treated as the name of a (system) property. The string value of this property is then interpreted as a long value and a Long object representing this value is returned. Details of possible numeric formats can be found with the definition of getProperty.

If there is no property with the specified name, or if the property does not have the correct numeric format, then null is returned.

Parameters:

name - property name.

Returns:

the Long value of the property.

See Also:

System.getProperty(java.lang.String), System.getProperty(java.lang.String, java.lang.String)

getLong

public static java.lang.Long getLong(java.lang.String name,
                                     java.lang.Long defaultValue)

Determines the long value of the (system) property with the specified name.

The first argument is treated as the name of a (system) property. The string value of this property is then interpreted as a long value and a Long object representing this value is returned.

If the property value begins with "0x" or "#", not followed by a minus sign, the rest of it is parsed as a hexadecimal long exactly as for the method Long.valueOf with radix 16.

If the property value begins with "0" then it is parsed as an octal long exactly as for the method Long.valueOf with radix 8.

Otherwise the property value is parsed as a decimal long exactly as for the method Long.valueOf with radix 10.

The second argument is the default value. If there is no property of the specified name, or if the property does not have the correct numeric format, then the second argument is returned.

Parameters:

name - property name.

defaultValue - default value.

Returns:

the Long value of the property.

loadPropertiesFromFile

public static java.util.Properties loadPropertiesFromFile(java.lang.String fileName)
                                                   throws java.io.IOException

Load only the Eib Properties from a file without merging with default and system properties

Throws:

java.io.IOException

savePropertiesToFile

public static void savePropertiesToFile(java.util.Properties np,
                                        java.lang.String fileName)
                                 throws java.io.IOException

Save only the Eib Properties to a file without merging with default and system properties

Throws:

java.io.IOException

saveProperty

public static void saveProperty(java.lang.String name,
                                java.lang.String value)
                         throws java.io.IOException

Save a particular wcp property in the runtime properties as well in the properties file. If there is no properties file it will be created.

Parameters:

name - the name of the property

value - if the value if the property == null the property will be deleted

Throws:

java.io.IOException

saveProperties

public static void saveProperties(java.util.Properties np)
                           throws java.io.IOException

Save a set of wcp property in the runtime properties as well in the properties file. When there is no properties file present it will be created.

Throws:

java.io.IOException

getInstallDir

public static java.lang.String getInstallDir()

Get the Cordys Installation directory: Read from environment variable, if fail then read it from CORDYS_HOME or CORDYS_INSTALL_DIR

setInstallDir

public static void setInstallDir(java.lang.String installDir)

Set the value of the Install Dir in the environment. Works only if the Windows Registry is used.

getSystemRoot

public static java.lang.String getSystemRoot()

Get OSInstallation Directory

getWebDir

public static java.lang.String getWebDir()

Get the Cordys Web directory as defined by the wcp property 'web.root'.

setWebDir

public static void setWebDir(java.lang.String webDir)

Set the value of the Web Dir in the environment.

getLDAPServer

@Deprecated
public static java.lang.String getLDAPServer()

Deprecated.

Get the LDAP Servername.

setLDAPServer

public static void setLDAPServer(java.lang.String ldapServer)

Set the value of the LDAP Server in the environment.

getDefaultPropertiesFileName

public static java.lang.String getDefaultPropertiesFileName()

getLoadedPropertiesFileName

public static java.lang.String getLoadedPropertiesFileName()

getFontName

public static java.lang.String getFontName()

get_ManagementLocale

public static java.util.Locale get_ManagementLocale()

Provides Locale object prepared from language, country code specified using property com.eibus.management.locale .
Syntax for the property <language>[[_<country>][_<variant>]]
Examples: com.eibus.management.locale=en , com.eibus.management.language.locale=en_US , com.eibus.management.locale=es_ES_Traditional_WIN
If com.eibus.management.locale is not defined, it returns the system default locale. This can be configured through the property com.eibus.defaultLocale. If this property is not set either, Locale.US is returned as default.

Returns:

Locale

get_SystemDefaultLocale

public static java.util.Locale get_SystemDefaultLocale()

Provides Locale object prepared from language, country code specified using property com.eibus.defaultLocale.
Syntax for the property <language>[[_<country>][_<variant>]]
Examples: com.eibus.defaultLocale=en , com.eibus.defaultLocale=en_US , com.eibus.defaultLocale=es_ES_Traditional_WIN
If com.eibus.defaultLocale is not defined, it returns Locale.US as default.
NOTE: When running in the context of a SOAP transaction, one should call SOAPTransaction.getLocale instead of using the system wide default locale.

Returns:

Returns default locale for the whole system

_localeFromString

public static java.util.Locale _localeFromString(java.lang.String strLocale)

setUserName

public static void setUserName(java.lang.String username)

isValidFileEncoding

public static boolean isValidFileEncoding()