org.productivity.java.habitat4j
Class PropertyListManager

java.lang.Object
  java.util.Dictionary<K,V>
      java.util.Hashtable
          org.productivity.java.habitat4j.common.AbstractPropertyListManager
              org.productivity.java.habitat4j.PropertyListManager

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map, Habitat4JConstants

public class PropertyListManager
extends AbstractPropertyListManager

PropertyListManager provides access to application-wide properties that are loaded contextually based on information gained from the ServerIdentityManager.

The use of Habitat4J starts with the initialization of this Singleton class by your application using the initialize method.

PropertyListManager can manage one or more lists, accessed by a PropertyList symbolic name.

## LICENSE INFORMATION ##

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

Version:

$Id: PropertyListManager.html,v 1.2 2008/11/24 15:15:20 cvs Exp $

Author:

Justin Yunke <habitat4j@productivity.org>

See Also:

Serialized Form

Field Summary

Fields inherited from class org.productivity.java.habitat4j.common.AbstractPropertyListManager

logger

Fields inherited from interface org.productivity.java.habitat4j.common.Habitat4JConstants

EOL_SEQUENCE, HABITAT4J_APPNAME_ATTRIBUTE_NAME, HABITAT4J_APPNAME_DEFAULT, HABITAT4J_CONTEXT_APPLICATION_NAME, HABITAT4J_CONTEXT_ENVIRONMENT, HABITAT4J_CONTEXT_INSTANCE_DESCRIPTION, HABITAT4J_CONTEXT_INSTANCE_ENUMERATION, HABITAT4J_CONTEXT_INSTANCE_NAME, HABITAT4J_CONTEXT_INSTANCE_OS, HABITAT4J_CONTEXT_LEGAL_ROLE_NAMES, HABITAT4J_CONTEXT_PREFIX, HABITAT4J_CONTEXT_ROLE_NAME, HABITAT4J_CONTEXT_ROLE_PATCH_LEVEL, HABITAT4J_CONTEXT_ROLE_PRODUCT, HABITAT4J_CONTEXT_ROLE_TYPE, HABITAT4J_CONTEXT_ROLE_VENDOR, HABITAT4J_CONTEXT_ROLE_VERSION, HABITAT4J_DEFINITIONS_PACKAGE, HABITAT4J_GENERIC_VALUE_DEFAULT, HABITAT4J_GENERIC_VALUE_EMPTY_STRING, HABITAT4J_GENERIC_VALUE_FALSE, HABITAT4J_GENERIC_VALUE_NO, HABITAT4J_GENERIC_VALUE_OFF, HABITAT4J_GENERIC_VALUE_ON, HABITAT4J_GENERIC_VALUE_ONE, HABITAT4J_GENERIC_VALUE_TRUE, HABITAT4J_GENERIC_VALUE_YES, HABITAT4J_GENERIC_VALUE_ZERO, HABITAT4J_HIDDEN_FIELD_DECODED, HABITAT4J_HIDDEN_FIELD_DECODED_DECRYPTED, HABITAT4J_HIDDEN_FIELD_DECRYPTED, HABITAT4J_LOG4J_LOGGER, HABITAT4J_LOG4J_LOGMANAGER_CLASS, HABITAT4J_LOG4J_LOGMANAGER_GETLOGGER_METHOD, HABITAT4J_PRAGMA_ATTRIBUTE_NAME, HABITAT4J_PRAGMA_ATTRIBUTE_VALUE, HABITAT4J_PROPERTY_ARRAY_INSTANCE_ATTRIBUTE_NAME, HABITAT4J_PROPERTY_ARRAY_INSTANCE_ATTRIBUTE_VALUE_APPEND, HABITAT4J_PROPERTY_ARRAY_INSTANCE_ATTRIBUTE_VALUE_DEFAULT, HABITAT4J_PROPERTY_ARRAY_INSTANCE_ATTRIBUTE_VALUE_PREPEND, HABITAT4J_PROPERTY_ARRAY_INSTANCE_ATTRIBUTE_VALUE_REPLACE, HABITAT4J_PROPERTY_ARRAY_ITEM_METHOD_PREFIX, HABITAT4J_PROPERTY_BEAN_ARRAY_INIT_METHOD_PREFIX, HABITAT4J_PROPERTY_BEAN_ARRAY_INSTANCE_ATTRIBUTE_VALUE_APPEND, HABITAT4J_PROPERTY_BEAN_ARRAY_INSTANCE_ATTRIBUTE_VALUE_DEFAULT, HABITAT4J_PROPERTY_BEAN_ARRAY_INSTANCE_ATTRIBUTE_VALUE_PREPEND, HABITAT4J_PROPERTY_BEAN_ARRAY_INSTANCE_ATTRIBUTE_VALUE_REPLACE, HABITAT4J_PROPERTY_BEAN_ARRAY_ITEM_INIT_METHOD_PREFIX, HABITAT4J_PROPERTY_BEAN_ARRAY_ITEM_SETTER_METHOD_PREFIX, HABITAT4J_PROPERTY_BEAN_ARRAY_SETTER_METHOD_PREFIX, HABITAT4J_PROPERTY_BEAN_DESCRIPTOR_CLASS_ATTRIBUTE_NAME, HABITAT4J_PROPERTY_BEAN_DESCRIPTOR_COPY_METHOD_ATTRIBUTE_NAME, HABITAT4J_PROPERTY_BEAN_DESCRIPTOR_COPY_METHOD_VALUE_DEFAULT, HABITAT4J_PROPERTY_BEAN_DESCRIPTOR_COPY_METHOD_VALUE_REFLECT, HABITAT4J_PROPERTY_BEAN_DESCRIPTOR_COPY_METHOD_VALUE_SERIALIZE, HABITAT4J_PROPERTY_BEAN_DESCRIPTOR_ID_ATTRIBUTE_NAME, HABITAT4J_PROPERTY_BEAN_HASH_INIT_METHOD_PREFIX, HABITAT4J_PROPERTY_BEAN_HASH_INSTANCE_ATTRIBUTE_VALUE_DEFAULT, HABITAT4J_PROPERTY_BEAN_HASH_INSTANCE_ATTRIBUTE_VALUE_REPLACE, HABITAT4J_PROPERTY_BEAN_HASH_INSTANCE_ATTRIBUTE_VALUE_REVISE, HABITAT4J_PROPERTY_BEAN_HASH_ITEM_INIT_METHOD_PREFIX, HABITAT4J_PROPERTY_BEAN_HASH_ITEM_SETTER_METHOD_PREFIX, HABITAT4J_PROPERTY_BEAN_HASH_SETTER_METHOD_PREFIX, HABITAT4J_PROPERTY_BEAN_ID_ATTRIBUTE_NAME, HABITAT4J_PROPERTY_BEAN_INIT_METHOD_PREFIX, HABITAT4J_PROPERTY_BEAN_INSTANCE_ATTRIBUTE_NAME, HABITAT4J_PROPERTY_BEAN_INSTANCE_ATTRIBUTE_VALUE_DEFAULT, HABITAT4J_PROPERTY_BEAN_INSTANCE_ATTRIBUTE_VALUE_REPLACE, HABITAT4J_PROPERTY_BEAN_INSTANCE_ATTRIBUTE_VALUE_REVISE, HABITAT4J_PROPERTY_BEAN_NAME_ATTRIBUTE_NAME, HABITAT4J_PROPERTY_BEAN_SETTER_METHOD_PREFIX, HABITAT4J_PROPERTY_BEAN_VALUE_ATTRIBUTE_NAME, HABITAT4J_PROPERTY_DECODING_ATTRIBUTE_NAME, HABITAT4J_PROPERTY_DECRYPTING_ATTRIBUTE_NAME, HABITAT4J_PROPERTY_HASH_INSTANCE_ATTRIBUTE_NAME, HABITAT4J_PROPERTY_HASH_INSTANCE_ATTRIBUTE_VALUE_DEFAULT, HABITAT4J_PROPERTY_HASH_INSTANCE_ATTRIBUTE_VALUE_REPLACE, HABITAT4J_PROPERTY_HASH_INSTANCE_ATTRIBUTE_VALUE_REVISE, HABITAT4J_PROPERTY_HASH_ITEM_METHOD_PREFIX, HABITAT4J_PROPERTY_HASH_KEY_ATTRIBUTE_NAME, HABITAT4J_PROPERTY_HASH_TYPE_ATTRIBUTE_NAME, HABITAT4J_PROPERTY_KIND_HABITAT4J, HABITAT4J_PROPERTY_KIND_SECURITY, HABITAT4J_PROPERTY_KIND_SYSTEM, HABITAT4J_PROPERTY_LIST_NAME_DEFAULT, HABITAT4J_PROPERTY_LIST_TO_STRING_ITEMS_PER_LINE_DEFAULT, HABITAT4J_PROPERTY_LIST_XSD_RESOURCE_PATH_DEFAULT, HABITAT4J_PROPERTY_NAME_ATTRIBUTE_NAME, HABITAT4J_PROPERTY_TYPE_DELIMITER, HABITAT4J_PROPERTY_VALUE_ATTRIBUTE_NAME, HABITAT4J_PROPERTY_VALUE_SUBSTITUTION_DELIMITER, HABITAT4J_PROPERTY_VALUE_SUBSTITUTION_PREFIX, HABITAT4J_PROPERTY_VALUE_SUBSTITUTION_SUFFIX, HABITAT4J_ROLE_ATTRIBUTE_NAME, HABITAT4J_SAX_DRIVER_DEFAULT, HABITAT4J_SAX_DRIVER_SYSTEM_PROPERTY_NAME, HABITAT4J_SAX_SCHEMA_FEATURE, HABITAT4J_SAX_VALIDATION_FEATURE, HABITAT4J_SAX_XSD_LOCATION, HABITAT4J_SERVER_IDENTITY_FILE_PATH_DEFAULT, HABITAT4J_SERVER_IDENTITY_FILE_PATH_SYSTEM_PROPERTY_NAME, HABITAT4J_SERVER_IDENTITY_XSD_RESOURCE_PATH_DEFAULT, HABITAT4J_TEMP_PROPERTY_LIST_PREFIX, HABITAT4J_UNIX_OS_NAME_LIST_PROPERTY_NAME, HABITAT4J_VERSION, HABITAT4J_WINDOWS_OS_NAME_LIST_PROPERTY_NAME, HABITAT4J_XML_ELEMENT_DELIMITER, SAX_DRIVER_SYSTEM_PROPERTY_NAME, SERVER_IDENTITY_INSTANCE_OS_OTHER, SERVER_IDENTITY_INSTANCE_OS_UNIX, SERVER_IDENTITY_INSTANCE_OS_WINDOWS, SERVER_IDENTITY_MODE_FILE, SERVER_IDENTITY_MODE_JVM, SERVER_IDENTITY_MODE_JVM_ENVIRONMENT, SERVER_IDENTITY_MODE_JVM_INSTANCE_DESCRIPTION, SERVER_IDENTITY_MODE_JVM_INSTANCE_ENUMERATION, SERVER_IDENTITY_MODE_JVM_INSTANCE_NAME, SERVER_IDENTITY_MODE_NULL, SYSTEM_PROPERTY_OS_NAME

Method Summary

static void	addGlobalDecoderDefinition(java.lang.String id, java.lang.Class decoderClass)
static void	addGlobalDecoderDefinition(java.lang.String id, java.lang.Object decoderObject)
static void	addGlobalDecryptorDefinition(java.lang.String id, java.lang.Object decryptorObject)
static void	addGlobalDecrytorDefinition(java.lang.String id, java.lang.Class decryptorClass)
static void	addGlobalPropertyBeanDefinition(java.lang.String id, java.lang.Class propertyBeanClass)
static void	addReloadablePropertyList(java.lang.String propertyListName)
static void	clearReloadablePropertyLists()
static java.util.Enumeration	getProperties() This method returns an Enumeration of properties for the default PropertyList.
static java.util.Enumeration	getProperties(java.lang.String propertyListName) This method returns an Enumeration of properties for a particular PropertyList.
static java.lang.String	getProperty(java.lang.String name) This method is used to obtain a property's String value from the default PropertyList.
static java.lang.String	getProperty(java.lang.String propertyListName, java.lang.String name) This method is used to obtain properties from a particular PropertyList.
static java.lang.String[]	getPropertyArray(java.lang.String name) This method is used to obtain a property's array of String values from the default PropertyList.
static java.lang.String[]	getPropertyArray(java.lang.String propertyListName, java.lang.String name) This method is used to obtain a property's array of String values from a particular PropertyList.
static int	getPropertyAsInt(java.lang.String name) This method is used to obtain a property's primitive int value from the default PropertyList.
static int	getPropertyAsInt(java.lang.String propertyListName, java.lang.String name) This method is used to obtain a property's primitive int value from a particular PropertyList.
static java.lang.Object	getPropertyBean(java.lang.String name) This method is used to obtain a PropertyBean Object from the default PropertyList.
static java.lang.Object	getPropertyBean(java.lang.String propertyListName, java.lang.String name) This method is used to obtain a PropertyBean Object from a particular PropertyList.
static java.lang.Object[]	getPropertyBeanArray(java.lang.String name) This method is used to obtain a property's array of PropertyBean Objects from the default PropertyList.
static java.lang.Object[]	getPropertyBeanArray(java.lang.String propertyListName, java.lang.String name) This method is used to obtain a property's array of PropertyBean Objects from a particular PropertyList.
static java.lang.Object[]	getPropertyBeanArrayCopy(java.lang.String name) This method is used to obtain a copy (clone) of a property's array of PropertyBean Objects from the default PropertyList.
static java.lang.Object[]	getPropertyBeanArrayCopy(java.lang.String propertyListName, java.lang.String name) This method is used to obtain a copy (clone) of a property's array of PropertyBean Objects from a particular PropertyList.
static java.lang.Object	getPropertyBeanCopy(java.lang.String name) This method is used to obtain a PropertyBean Object from the default PropertyList.
static java.lang.Object	getPropertyBeanCopy(java.lang.String propertyListName, java.lang.String name) This method is used to obtain a PropertyBean Object from a particular PropertyList.
static PropertyBeanHash	getPropertyBeanHash(java.lang.String name) This method is used to obtain a property's hash of PropertyBean Objects from the default PropertyList.
static PropertyBeanHash	getPropertyBeanHash(java.lang.String propertyListName, java.lang.String name) This method is used to obtain a property's hash of PropertyBean Objects from a particular PropertyList.
static PropertyBeanHash	getPropertyBeanHashCopy(java.lang.String name) This method is used to obtain a copy (clone) of a property's hash of PropertyBean Objects from the default PropertyList.
static PropertyBeanHash	getPropertyBeanHashCopy(java.lang.String propertyListName, java.lang.String name) This method is used to obtain a copy (clone) of a property's hash of PropertyBean Objects from a particular PropertyList.
static java.lang.Object	getPropertyBeanHashValue(java.lang.String name, java.lang.String key) This method is used to obtain a specific hash value from a PropertyHash in the default PropertyList.
static java.lang.Object	getPropertyBeanHashValue(java.lang.String propertyListName, java.lang.String name, java.lang.String key) This method is used to obtain a specific hash value from a PropertyHash in a particular PropertyList.
static java.lang.Object	getPropertyBeanHashValueCopy(java.lang.String name, java.lang.String key) This method is used to obtain a copy (clone) of a PropertyBean Object from a property hash in the default PropertyList.
static java.lang.Object	getPropertyBeanHashValueCopy(java.lang.String propertyListName, java.lang.String name, java.lang.String key) This method is used to obtain a copy (clone) of a PropertyBean Object from a property hash in a particular PropertyList.
static java.lang.Class	getPropertyClass(java.lang.String name) This method gets a property's class from the default PropertyList.
static java.lang.Class	getPropertyClass(java.lang.String propertyListName, java.lang.String name) This method gets a property's class from a particular PropertyList.
static java.lang.String	getPropertyClassName(java.lang.String name) This method gets a property's class name from the default PropertyList.
static java.lang.String	getPropertyClassName(java.lang.String propertyListName, java.lang.String name) This method gets a property's class name from a particular PropertyList.
static PropertyHash	getPropertyHash(java.lang.String name) This method is used to obtain a property's hash of String values from the default PropertyList.
static PropertyHash	getPropertyHash(java.lang.String propertyListName, java.lang.String name) This method is used to obtain a property's hash of String values from a particular PropertyList.
static java.util.Properties	getPropertyHashAsJavaProperties(java.lang.String name) This method returns a java.util.Properties object derived from the hash of String values in a PropertyHash from the default PropertyList.
static java.util.Properties	getPropertyHashAsJavaProperties(java.lang.String propertyListName, java.lang.String name) This method returns a java.util.Properties object derived from the hash of String values in a PropertyHash from the default PropertyList.
static java.lang.String	getPropertyHashValue(java.lang.String name, java.lang.String key) This method is used to obtain a String value from a PropertyHash in a particular PropertyList.
static java.lang.String	getPropertyHashValue(java.lang.String propertyListName, java.lang.String name, java.lang.String key) This method is used to obtain a String value from a PropertyHash in a particular PropertyList.
static PropertyList	getPropertyList() This method returns the default PropertyList instance.
static PropertyList	getPropertyList(java.lang.String propertyListName) This method returns a particular PropertyList instance.
static PropertyListManager	getPropertyListManager() This method returns the singleton instance of PropertyListManager.
static java.lang.String	getPropertyListModifiedBy() This method returns the "modified by" of the default PropertyList.
static java.lang.String	getPropertyListModifiedBy(java.lang.String propertyListName) This method returns the "modified by" of the PropertyList.
static int	getPropertyListReloadSerial() This method returns the reload serial enumeration of the default PropertyList.
static int	getPropertyListReloadSerial(java.lang.String propertyListName) This method returns the reload serial enumeration of a particular PropertyList.
static java.lang.String	getPropertyListVersion() This method returns the version of the default PropertyList.
static java.lang.String	getPropertyListVersion(java.lang.String propertyListName) This method returns the version of the PropertyList.
static ServerIdentity	getServerIdentity() This method returns the one and only ServerIdentity instance.
static void	inhibitReload() This method forces Habitat4J to inhibit all reload actions.
static void	inhibitReload(long expiration) This method forces Habitat4J to inhibit all reload actions.
static PropertyListManager	initialize(java.lang.String applicationName) This method initializes the PropertyListManager singleton object.
static PropertyListManager	initialize(java.lang.String applicationName, java.lang.String mode)
static PropertyListManager	initialize(java.lang.String applicationName, java.lang.String mode, ServerIdentityXMLMap map) This method initializes the PropertyListManager singleton object.
static boolean	isInitialized() This method returns whether this singleton instance of PropertyListManager is initialized for the default PropertyList.
static boolean	isInitialized(java.lang.String propertyListName) This method returns whether this singleton instance of PropertyListManager is initialized for a particular Propertylist.
static boolean	isPropertyABean(java.lang.String name) This method returns whether a property contains an instance of a PropertyBean Object.
static boolean	isPropertyABean(java.lang.String propertyListName, java.lang.String name) This method returns whether a property contains an instance of a PropertyBean Object.
static boolean	isPropertyABeanArray(java.lang.String name) This method returns whether a property contains an array of PropertyBean Objects.
static boolean	isPropertyABeanArray(java.lang.String propertyListName, java.lang.String name) This method returns whether a property contains an array of PropertyBean Objects.
static boolean	isPropertyABeanHash(java.lang.String name) This method returns whether a property contains a hash of PropertyBean Objects.
static boolean	isPropertyABeanHash(java.lang.String propertyListName, java.lang.String name) This method returns whether a property contains an hash of PropertyBean Objects.
static boolean	isPropertyAHash(java.lang.String name) This method returns whether a property from the default PropertyList contains a hash of String values.
static boolean	isPropertyAHash(java.lang.String propertyListName, java.lang.String name) This method returns whether a property from a particular PropertyList contains a hash of String values.
static boolean	isPropertyAnArray(java.lang.String name) This method returns whether a property from the default PropertyList contains an array of String values.
static boolean	isPropertyAnArray(java.lang.String propertyListName, java.lang.String name) This method returns whether a property from a particular PropertyList contains an array of String values.
static boolean	isPropertyAString(java.lang.String name) This method returns whether a property contains a String value.
static boolean	isPropertyAString(java.lang.String propertyListName, java.lang.String name) This method returns whether a property contains a String value.
static boolean	isPropertyHashValueSet(java.lang.String name, java.lang.String key) This method is used to indicate whether a PropertyHash value is set in the default PropertyList.
static boolean	isPropertyHashValueSet(java.lang.String propertyListName, java.lang.String name, java.lang.String key) This method is used to indicate whether a PropertyHash value is set for a particular PropertyList.
static boolean	isPropertyTrue(java.lang.String name) This method is used to obtain a property's primitive boolean value from the default PropertyList.
static boolean	isPropertyTrue(java.lang.String propertyListName, java.lang.String name) This method is used to obtain a property's primitive boolean value from a particular PropertyList.
static boolean	isReloadablePropertyList(java.lang.String propertyListName)
static void	loadPropertyList(java.lang.String propertyListPath) This wrapper method tries to find a given propertyListPath as a classpath resource, then as a file resource, and then loads it.
static void	loadPropertyList(java.lang.String propertyListPath, PropertyListXMLMap map) This wrapper method tries to find a given propertyListPath as a classpath resource, then as a file resource, and then loads it.
static void	loadPropertyList(java.lang.String propertyListName, java.lang.String propertyListPath) This wrapper method tries to find a given propertyListPath as a classpath resource, then as a file resource, and then loads it.
static void	loadPropertyList(java.lang.String propertyListName, java.lang.String propertyListPath, PropertyListXMLMap map) This wrapper method tries to find a given propertyListPath as a classpath resource, then as a file resource, and then loads it.
static void	loadPropertyListFromFile(java.lang.String propertyListFilePath) This method loads a PropertyList from the contents of an XML file.
static void	loadPropertyListFromFile(java.lang.String propertyListFilePath, PropertyListXMLMap map) This method loads a PropertyList from the contents of an XML file using a PropertyListXMLMap.
static void	loadPropertyListFromFile(java.lang.String propertyListName, java.lang.String propertyListFilePath) This method loads a PropertyList from the contents of an XML file.
static void	loadPropertyListFromFile(java.lang.String propertyListName, java.lang.String propertyListFilePath, PropertyListXMLMap map) This method loads a PropertyList from the contents of an XML file using a PropertyListXMLMap.
static void	loadPropertyListFromResource(java.lang.String propertyListResourcePath) This method loads a PropertyList from the contents of an XML classpath resource.
static void	loadPropertyListFromResource(java.lang.String propertyListResourcePath, PropertyListXMLMap map) This method loads a PropertyList from the contents of an XML classpath resource using a PropertyListXML map.
static void	loadPropertyListFromResource(java.lang.String propertyListName, java.lang.String propertyListResourcePath) This method loads a PropertyList from the contents of an XML classpath resource.
static void	loadPropertyListFromResource(java.lang.String propertyListName, java.lang.String propertyListResourcePath, PropertyListXMLMap map) This method loads a PropertyList from the contents of an XML classpath resource using a PropertyListXMLMap.
static void	reloadOnFileChange() This method reloads a file-based XML document based on file change.
static void	reloadOnFileChange(java.lang.String propertyListName) This method reloads a file-based XML document based on file change.
static void	removePropertyList(java.lang.String propertyListName) This method removes a PropertyList.
static void	removeReloadablePropertyList(java.lang.String propertyListName)
static void	renamePropertyList(java.lang.String oldPropertyListName, java.lang.String newPropertyListName) This method renames a particular PropertyList instance.
static void	reset() This method resets this singleton instance.
static void	setFeature(java.lang.String name, boolean value) This method sets a Habitat4J feature.
static void	setFeature(java.lang.String name, int value) This method sets a Habitat4J feature.
static void	setFeature(java.lang.String name, java.lang.String value) This method sets a Habitat4J feature.
static void	setPragmaDefinition(java.lang.String name, java.lang.String value)
static void	setPragmaDefinition(java.lang.String propertyListName, java.lang.String name, java.lang.String value)
static java.lang.String	toDisplayString() This method is used for debugging purposes.
static void	uninhibitReload() This method releases Habitat4J's reload inhibition.

Methods inherited from class org.productivity.java.habitat4j.common.AbstractPropertyListManager

_addGlobalDecoderDefinition, _addGlobalDecoderDefinition, _addGlobalDecryptorDefinition, _addGlobalDecrytorDefinition, _addGlobalPropertyBeanDefinition, _addReloadablePropertyList, _clearReloadablePropertyLists, _getGlobalReloadEventHandler, _getProperties, _getProperties, _getProperty, _getProperty, _getPropertyArray, _getPropertyArray, _getPropertyAsInt, _getPropertyAsInt, _getPropertyBean, _getPropertyBean, _getPropertyBeanArray, _getPropertyBeanArray, _getPropertyBeanArrayCopy, _getPropertyBeanArrayCopy, _getPropertyBeanCopy, _getPropertyBeanCopy, _getPropertyBeanHash, _getPropertyBeanHash, _getPropertyBeanHashCopy, _getPropertyBeanHashCopy, _getPropertyBeanHashValue, _getPropertyBeanHashValue, _getPropertyBeanHashValueCopy, _getPropertyBeanHashValueCopy, _getPropertyClass, _getPropertyClass, _getPropertyClassName, _getPropertyClassName, _getPropertyHash, _getPropertyHash, _getPropertyHashAsJavaProperties, _getPropertyHashAsJavaProperties, _getPropertyHashValue, _getPropertyHashValue, _getPropertyList, _getPropertyList, _getPropertyListModifiedBy, _getPropertyListModifiedBy, _getPropertyListReloadSerial, _getPropertyListReloadSerial, _getPropertyListVersion, _getPropertyListVersion, _getServerIdentity, _inhibitReload, _inhibitReload, _initialize, _initialize, _initialize, _isInitialized, _isInitialized, _isPropertyABean, _isPropertyABean, _isPropertyABeanArray, _isPropertyABeanArray, _isPropertyABeanHash, _isPropertyABeanHash, _isPropertyAHash, _isPropertyAHash, _isPropertyAnArray, _isPropertyAnArray, _isPropertyAString, _isPropertyAString, _isPropertyHashValueSet, _isPropertyHashValueSet, _isPropertyTrue, _isPropertyTrue, _isReloadablePropertyList, _loadPropertyList, _loadPropertyList, _loadPropertyList, _loadPropertyList, _loadPropertyListFromFile, _loadPropertyListFromFile, _loadPropertyListFromFile, _loadPropertyListFromFile, _loadPropertyListFromFile, _loadPropertyListFromResource, _loadPropertyListFromResource, _loadPropertyListFromResource, _loadPropertyListFromResource, _reloadOnFileChange, _reloadOnFileChange, _removePropertyList, _removeReloadablePropertyList, _renamePropertyList, _setFeature, _setFeature, _setFeature, _setGlobalReloadEventHandler, _setPragmaDefinition, _setPragmaDefinition, _toDisplayString, _uninhibitReload, checkThatPropertyListExists, checkThatPropertyListExists, throwPropertyNotAvailableExceptionBecauseListNotInitialized

Methods inherited from class java.util.Hashtable

clear, clone, contains, containsKey, containsValue, elements, entrySet, equals, get, hashCode, isEmpty, keys, keySet, put, putAll, rehash, remove, size, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getProperties

public static java.util.Enumeration getProperties()

This method returns an Enumeration of properties for the default PropertyList.

Returns:

Returns an Enumeration of properties for the default PropertyList.

getProperties

public static java.util.Enumeration getProperties(java.lang.String propertyListName)

This method returns an Enumeration of properties for a particular PropertyList.

Parameters:

propertyListName - - the name of the PropertyList

Returns:

Returns an Enumeration of properties for a particular PropertyList.

getProperty

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

This method is used to obtain a property's String value from the default PropertyList.

Parameters:

name - - the name of the property

Returns:

Returns the value of a property from the default PropertyList.

getProperty

public static java.lang.String getProperty(java.lang.String propertyListName,
                                           java.lang.String name)

This method is used to obtain properties from a particular PropertyList.

Parameters:

propertyListName - - the name of the PropertyList

name - - the name of the property

Returns:

Returns the value of a property from a particular PropertyList.

getPropertyAsInt

public static int getPropertyAsInt(java.lang.String name)

This method is used to obtain a property's primitive int value from the default PropertyList.

Parameters:

name - - the name of the property

Returns:

Returns the primitive int value of a property from the default PropertyList.

getPropertyAsInt

public static int getPropertyAsInt(java.lang.String propertyListName,
                                   java.lang.String name)

This method is used to obtain a property's primitive int value from a particular PropertyList.

Parameters:

propertyListName - - the name of the PropertyList

name - - the name of the property

Returns:

Returns the primitive int value of a property from a particular PropertyList.

isPropertyTrue

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

This method is used to obtain a property's primitive boolean value from the default PropertyList.

Parameters:

name - - the name of the property

Returns:

Returns the primitive boolean value of a property from the default PropertyList.

isPropertyTrue

public static boolean isPropertyTrue(java.lang.String propertyListName,
                                     java.lang.String name)

This method is used to obtain a property's primitive boolean value from a particular PropertyList.

Parameters:

propertyListName - - the name of the PropertyList

name - - the name of the property

Returns:

Returns the primitive boolean value of a property from a particular PropertyList.

getPropertyArray

public static java.lang.String[] getPropertyArray(java.lang.String name)

This method is used to obtain a property's array of String values from the default PropertyList.

Parameters:

name - - the name of the property

Returns:

Returns an array of String values from a property from the default PropertyList.

getPropertyArray

public static java.lang.String[] getPropertyArray(java.lang.String propertyListName,
                                                  java.lang.String name)

This method is used to obtain a property's array of String values from a particular PropertyList.

Parameters:

propertyListName - - the name of the PropertyList

name - - the name of the property

Returns:

Returns an array of String values from a property from a particular PropertyList.

getPropertyHash

public static PropertyHash getPropertyHash(java.lang.String name)

This method is used to obtain a property's hash of String values from the default PropertyList.

Parameters:

name - - the name of the property

Returns:

Returns a hash of String values from a property from the default PropertyList.

getPropertyHash

public static PropertyHash getPropertyHash(java.lang.String propertyListName,
                                           java.lang.String name)

This method is used to obtain a property's hash of String values from a particular PropertyList.

Parameters:

propertyListName - - the name of the PropertyList

name - - the name of the property

Returns:

Returns a hash of String values from a property from a particular PropertyList.

getPropertyHashAsJavaProperties

public static java.util.Properties getPropertyHashAsJavaProperties(java.lang.String name)

This method returns a java.util.Properties object derived from the hash of String values in a PropertyHash from the default PropertyList. It is useful for storing 3rd-party properties in Habitat4J.

Parameters:

name - - the name of the property

Returns:

Returns a java.util.Properties object derived from the hash of String values in a PropertyHash from the default PropertyList.

getPropertyHashAsJavaProperties

public static java.util.Properties getPropertyHashAsJavaProperties(java.lang.String propertyListName,
                                                                   java.lang.String name)

This method returns a java.util.Properties object derived from the hash of String values in a PropertyHash from the default PropertyList. It is useful for storing 3rd-party properties in Habitat4J.

Parameters:

name - - the name of the property

propertyListName - - the name of the PropertyList

Returns:

Returns a java.util.Properties object derived from the hash of String values in a PropertyHash from the default PropertyList.

getPropertyHashValue

public static java.lang.String getPropertyHashValue(java.lang.String name,
                                                    java.lang.String key)

This method is used to obtain a String value from a PropertyHash in a particular PropertyList.

Parameters:

name - - the name of the property

key - - the key to lookup in the PropertyHash

Returns:

Returns a String value from a PropertyHash.

getPropertyHashValue

public static java.lang.String getPropertyHashValue(java.lang.String propertyListName,
                                                    java.lang.String name,
                                                    java.lang.String key)

This method is used to obtain a String value from a PropertyHash in a particular PropertyList.

Parameters:

propertyListName - - the name of the PropertyList

name - - the name of the property

key - - the key to lookup in the PropertyHash

Returns:

Returns a String value from a PropertyHash in a specific propertyListName.

isPropertyHashValueSet

public static boolean isPropertyHashValueSet(java.lang.String name,
                                             java.lang.String key)

This method is used to indicate whether a PropertyHash value is set in the default PropertyList. When used with null-valued entries in the PropertyList it can provide a simple HashSet implementation.

Parameters:

name - - the name of the property

key - - the key to lookup in the PropertyHash

Returns:

Returns a boolean value indicating a PropertyHash value is set.

isPropertyHashValueSet

public static boolean isPropertyHashValueSet(java.lang.String propertyListName,
                                             java.lang.String name,
                                             java.lang.String key)

This method is used to indicate whether a PropertyHash value is set for a particular PropertyList. When used with null-valued entries in the PropertyList it can provide a simple HashSet implementation.

Parameters:

propertyListName - - the name of the PropertyList

name - - the name of the property

key - - the key to lookup in the PropertyHash

Returns:

Returns where a PropertyHash value is present.

getPropertyBean

public static java.lang.Object getPropertyBean(java.lang.String name)

This method is used to obtain a PropertyBean Object from the default PropertyList.

Parameters:

name - - the name of the property

Returns:

Returns a PropertyBean Object from the default PropertyList.

getPropertyBean

public static java.lang.Object getPropertyBean(java.lang.String propertyListName,
                                               java.lang.String name)

This method is used to obtain a PropertyBean Object from a particular PropertyList.

Parameters:

propertyListName - - the name of the PropertyList

name - - the name of the property

Returns:

Returns a PropertyBean Object from a particular PropertyList.

getPropertyBeanCopy

public static java.lang.Object getPropertyBeanCopy(java.lang.String name)

This method is used to obtain a PropertyBean Object from the default PropertyList. It returns a copy (clone) of the Property instance that can be modified by the application without altering the original loaded and stored property.

Parameters:

name - - the name of the property

Returns:

Returns a copy (clone) of a PropertyBean Object from a property from the default PropertyList.

getPropertyBeanCopy

public static java.lang.Object getPropertyBeanCopy(java.lang.String propertyListName,
                                                   java.lang.String name)

This method is used to obtain a PropertyBean Object from a particular PropertyList. It returns a copy (clone) of the Property instance that can be modified by the application without altering the original loaded and stored property.

Parameters:

propertyListName - - the name of the PropertyList

name - - the name of the property

Returns:

Returns a copy (clone) of a PropertyBean Object from a property from a particular PropertyList.

getPropertyBeanArray

public static java.lang.Object[] getPropertyBeanArray(java.lang.String name)

This method is used to obtain a property's array of PropertyBean Objects from the default PropertyList.

Parameters:

name - - the name of the property

Returns:

Returns an array of PropertyBean Objects from a property from the default PropertyList.

getPropertyBeanArray

public static java.lang.Object[] getPropertyBeanArray(java.lang.String propertyListName,
                                                      java.lang.String name)

This method is used to obtain a property's array of PropertyBean Objects from a particular PropertyList.

Parameters:

propertyListName - - the name of the PropertyList

name - - the name of the property

Returns:

Returns an array of PropertyBean Objects from a property from a particular PropertyList.

getPropertyBeanHash

public static PropertyBeanHash getPropertyBeanHash(java.lang.String name)

This method is used to obtain a property's hash of PropertyBean Objects from the default PropertyList.

Parameters:

name - - the name of the property

Returns:

Returns a hash of PropertyBean Objects from a property from the default PropertyList.

getPropertyBeanHash

public static PropertyBeanHash getPropertyBeanHash(java.lang.String propertyListName,
                                                   java.lang.String name)

This method is used to obtain a property's hash of PropertyBean Objects from a particular PropertyList.

Parameters:

propertyListName - - the name of the PropertyList

name - - the name of the property

Returns:

Returns a hash of PropertyBean Objects from a property from a particular PropertyList.

getPropertyBeanHashValue

public static java.lang.Object getPropertyBeanHashValue(java.lang.String name,
                                                        java.lang.String key)

This method is used to obtain a specific hash value from a PropertyHash in the default PropertyList.

Parameters:

name - - the name of the property

key - - the key to lookup in the PropertyHash

Returns:

Returns a String value from a PropertyHash in the default PropertyList.

getPropertyBeanHashValue

public static java.lang.Object getPropertyBeanHashValue(java.lang.String propertyListName,
                                                        java.lang.String name,
                                                        java.lang.String key)

This method is used to obtain a specific hash value from a PropertyHash in a particular PropertyList.

Parameters:

propertyListName - - the name of the PropertyList

name - - the name of the property

key - - the key to lookup in the PropertyHash

Returns:

Returns a String value from a PropertyHash in a particular PropertyList.

getPropertyBeanHashValueCopy

public static java.lang.Object getPropertyBeanHashValueCopy(java.lang.String name,
                                                            java.lang.String key)

This method is used to obtain a copy (clone) of a PropertyBean Object from a property hash in the default PropertyList.

Parameters:

name - - the name of the property

key - - the key to lookup in the PropertyHash

Returns:

Returns a copy (clone) of a PropertyBean Object from a PropertyHash in the default PropertyList.

getPropertyBeanHashValueCopy

public static java.lang.Object getPropertyBeanHashValueCopy(java.lang.String propertyListName,
                                                            java.lang.String name,
                                                            java.lang.String key)

This method is used to obtain a copy (clone) of a PropertyBean Object from a property hash in a particular PropertyList.

Parameters:

propertyListName - - the name of the PropertyList

name - - the name of the property

key - - the key to lookup in the PropertyHash

Returns:

Returns a copy (clone) of a PropertyBean Object from a PropertyHash in a particular PropertyList.

getPropertyBeanArrayCopy

public static java.lang.Object[] getPropertyBeanArrayCopy(java.lang.String name)

This method is used to obtain a copy (clone) of a property's array of PropertyBean Objects from the default PropertyList.

Parameters:

name - - the name of the property

Returns:

Returns a copy (clone) of an array of PropertyBean Objects from a property from the default PropertyList.

getPropertyBeanArrayCopy

public static java.lang.Object[] getPropertyBeanArrayCopy(java.lang.String propertyListName,
                                                          java.lang.String name)

This method is used to obtain a copy (clone) of a property's array of PropertyBean Objects from a particular PropertyList.

Parameters:

propertyListName - - the name of the PropertyList

name - - the name of the property

Returns:

Returns a copy (clone) of an array of PropertyBean Objects in a copied (cloned) property hash from a particular PropertyList.

getPropertyBeanHashCopy

public static PropertyBeanHash getPropertyBeanHashCopy(java.lang.String name)

This method is used to obtain a copy (clone) of a property's hash of PropertyBean Objects from the default PropertyList.

Parameters:

name - - the name of the property

Returns:

Returns a copy (clone) of PropertyBean Objects in a copied (cloned) property hash from the default PropertyList.

getPropertyBeanHashCopy

public static PropertyBeanHash getPropertyBeanHashCopy(java.lang.String propertyListName,
                                                       java.lang.String name)

This method is used to obtain a copy (clone) of a property's hash of PropertyBean Objects from a particular PropertyList.

Parameters:

propertyListName - - the name of the PropertyList

name - - the name of the property

Returns:

Returns a copy (clone) of PropertyBean Objects in a copied (cloned) property hash from a particular PropertyList.

getPropertyClass

public static java.lang.Class getPropertyClass(java.lang.String name)

This method gets a property's class from the default PropertyList.

Parameters:

name - - the name of the property

Returns:

Returns the class of the property from the default PropertyList.

getPropertyClass

public static java.lang.Class getPropertyClass(java.lang.String propertyListName,
                                               java.lang.String name)

This method gets a property's class from a particular PropertyList.

Parameters:

propertyListName - - the name of the PropertyList

name - - the name of the property

Returns:

Returns the class of the property from a particular PropertyList.

getPropertyClassName

public static java.lang.String getPropertyClassName(java.lang.String name)

This method gets a property's class name from the default PropertyList.

Parameters:

name - - the name of the property

Returns:

Returns the class name of the property from the default PropertyList.

getPropertyClassName

public static java.lang.String getPropertyClassName(java.lang.String propertyListName,
                                                    java.lang.String name)

This method gets a property's class name from a particular PropertyList.

Parameters:

propertyListName - - the name of the PropertyList

name - - the name of the property

Returns:

Returns the class name of the property from a particular PropertyList.

getPropertyList

public static PropertyList getPropertyList()

This method returns the default PropertyList instance.

Returns:

Returns the default PropertyList object.

getPropertyList

public static PropertyList getPropertyList(java.lang.String propertyListName)

This method returns a particular PropertyList instance.

Parameters:

propertyListName - - the name of the PropertyList

Returns:

Returns a PropertyList object for a particular PropertyList.

renamePropertyList

public static void renamePropertyList(java.lang.String oldPropertyListName,
                                      java.lang.String newPropertyListName)
                               throws PropertyListHandlerException

This method renames a particular PropertyList instance.

Parameters:

oldPropertyListName - - the name of the PropertyList to rename

newPropertyListName - - the new name of the PropertyList

Throws:

PropertyListHandlerException

removePropertyList

public static void removePropertyList(java.lang.String propertyListName)
                               throws PropertyListHandlerException

This method removes a PropertyList.

Parameters:

propertyListName - - the name of the PropertyList to remove

Throws:

PropertyListHandlerException

getPropertyListManager

public static PropertyListManager getPropertyListManager()
                                                  throws PropertyListHandlerException

This method returns the singleton instance of PropertyListManager.

Returns:

Returns the singleton instance of PropertyListManager.

Throws:

PropertyListHandlerException

getPropertyListModifiedBy

public static java.lang.String getPropertyListModifiedBy()

This method returns the "modified by" of the default PropertyList.

Returns:

Returns the "modified by" of the default PropertyList.

getPropertyListModifiedBy

public static java.lang.String getPropertyListModifiedBy(java.lang.String propertyListName)

This method returns the "modified by" of the PropertyList.

Parameters:

propertyListName - - the name of the PropertyList

Returns:

Returns the "modified by" of the PropertyList.

getPropertyListReloadSerial

public static int getPropertyListReloadSerial()

This method returns the reload serial enumeration of the default PropertyList.

Returns:

Returns the reload serial enumeration of the default PropertyList.

getPropertyListReloadSerial

public static int getPropertyListReloadSerial(java.lang.String propertyListName)

This method returns the reload serial enumeration of a particular PropertyList.

Parameters:

propertyListName - - the name of the PropertyList

Returns:

Returns the reload serial enumeration of a particular PropertyList.

getPropertyListVersion

public static java.lang.String getPropertyListVersion()

This method returns the version of the default PropertyList.

Returns:

Returns the version of the default PropertyList.

getPropertyListVersion

public static java.lang.String getPropertyListVersion(java.lang.String propertyListName)

This method returns the version of the PropertyList.

Parameters:

propertyListName - - the name of the PropertyList

Returns:

Returns the version of the PropertyList.

getServerIdentity

public static ServerIdentity getServerIdentity()

This method returns the one and only ServerIdentity instance.

Returns:

Returns the ServerIdentity object used by this PropertyListManager instance.

initialize

public static PropertyListManager initialize(java.lang.String applicationName,
                                             java.lang.String mode,
                                             ServerIdentityXMLMap map)

This method initializes the PropertyListManager singleton object.

Parameters:

applicationName - - the name of the application

mode - - the mode (SERVER_IDENTITY_MODE_FILE, SERVER_IDENTITY_MODE_JVM, or SERVER_IDENTITY_MODE_NULL)

map - - ServerIdentityXMLMap definition to use

Returns:

Returns the singleton instance of the PropertyListManager object.

initialize

public static PropertyListManager initialize(java.lang.String applicationName,
                                             java.lang.String mode)

Parameters:

applicationName - - the name of the application

mode - - the mode (SERVER_IDENTITY_MODE_FILE, SERVER_IDENTITY_MODE_JVM, or SERVER_IDENTITY_MODE_NULL)

Returns:

Returns the singleton instance of the PropertyListManager object.

initialize

public static PropertyListManager initialize(java.lang.String applicationName)

This method initializes the PropertyListManager singleton object.

Parameters:

applicationName - - the name of the application

Returns:

Returns the singleton instance of the PropertyListManager object.

isInitialized

public static boolean isInitialized()

This method returns whether this singleton instance of PropertyListManager is initialized for the default PropertyList.

Returns:

Returns whether this singleton instance of PropertyListManager is initialized for the default PropertyList.

isInitialized

public static boolean isInitialized(java.lang.String propertyListName)

This method returns whether this singleton instance of PropertyListManager is initialized for a particular Propertylist.

Parameters:

propertyListName - - the name of the PropertyList

Returns:

Returns whether this singleton instance of PropertyListManager is initialized for a particular Propertylist.

isPropertyABean

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

This method returns whether a property contains an instance of a PropertyBean Object.

Parameters:

name - the name of the property

Returns:

Returns whether the property specified by name contains an instance of a PropertyBean Object.

isPropertyABean

public static boolean isPropertyABean(java.lang.String propertyListName,
                                      java.lang.String name)

This method returns whether a property contains an instance of a PropertyBean Object.

Parameters:

propertyListName - - the name of the PropertyList

name - the name of the property

Returns:

Returns whether the property specified by name contains an instance of a PropertyBean Object.

isPropertyABeanArray

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

This method returns whether a property contains an array of PropertyBean Objects.

Parameters:

name - the name of the property

Returns:

Returns whether the property specified by name contains an array of PropertyBean Objects.

isPropertyABeanArray

public static boolean isPropertyABeanArray(java.lang.String propertyListName,
                                           java.lang.String name)

This method returns whether a property contains an array of PropertyBean Objects.

Parameters:

propertyListName - - the name of the PropertyList

name - the name of the property

Returns:

Returns whether the property specified by name contains an array of PropertyBean Objects.

isPropertyABeanHash

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

This method returns whether a property contains a hash of PropertyBean Objects.

Parameters:

name - the name of the property

Returns:

Returns whether the property specified by name contains a hash of PropertyBean Objects.

isPropertyABeanHash

public static boolean isPropertyABeanHash(java.lang.String propertyListName,
                                          java.lang.String name)

This method returns whether a property contains an hash of PropertyBean Objects.

Parameters:

propertyListName - - the name of the PropertyList

name - the name of the property

Returns:

Returns whether the property specified by name contains a hash of PropertyBean Objects.

isPropertyAnArray

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

This method returns whether a property from the default PropertyList contains an array of String values.

Parameters:

name - - the name of the property

Returns:

Returns whether a property from the default PropertyList contains an array of String values.

isPropertyAnArray

public static boolean isPropertyAnArray(java.lang.String propertyListName,
                                        java.lang.String name)

This method returns whether a property from a particular PropertyList contains an array of String values.

Parameters:

propertyListName - - the name of the PropertyList

name - - the name of the property

Returns:

Returns whether a property from a particular PropertyList contains an array of String values.

isPropertyAHash

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

This method returns whether a property from the default PropertyList contains a hash of String values.

Parameters:

name - - the name of the property

Returns:

Returns whether a property from the default PropertyList contains a hash of String values.

isPropertyAHash

public static boolean isPropertyAHash(java.lang.String propertyListName,
                                      java.lang.String name)

This method returns whether a property from a particular PropertyList contains a hash of String values.

Parameters:

propertyListName - - the name of the PropertyList

name - - the name of the property

Returns:

Returns whether a property from a particular PropertyList contains a hash of String values.

isPropertyAString

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

This method returns whether a property contains a String value.

Parameters:

name - - the name of the property

Returns:

Returns whether a property from the default PropertyList contains a String value.

isPropertyAString

public static boolean isPropertyAString(java.lang.String propertyListName,
                                        java.lang.String name)

This method returns whether a property contains a String value.

Parameters:

propertyListName - - the name of the PropertyList

name - - the name of the property

Returns:

Returns whether a property from a particular PropertyList contains a String value.

loadPropertyList

public static void loadPropertyList(java.lang.String propertyListPath,
                                    PropertyListXMLMap map)
                             throws PropertyListHandlerException

This wrapper method tries to find a given propertyListPath as a classpath resource, then as a file resource, and then loads it.

Parameters:

propertyListPath - - the classloader or file path of the PropertyList file

map - - PropertyListXMLMap definition to use

Throws:

PropertyListHandlerException

loadPropertyList

public static void loadPropertyList(java.lang.String propertyListName,
                                    java.lang.String propertyListPath,
                                    PropertyListXMLMap map)
                             throws PropertyListHandlerException

This wrapper method tries to find a given propertyListPath as a classpath resource, then as a file resource, and then loads it.

Parameters:

propertyListName - - the name of the PropertyList

propertyListPath - - the classloader or file path of the PropertyList file

map - - PropertyListXMLMap definition to use

Throws:

PropertyListHandlerException

loadPropertyListFromFile

public static void loadPropertyListFromFile(java.lang.String propertyListFilePath,
                                            PropertyListXMLMap map)
                                     throws PropertyListHandlerException

This method loads a PropertyList from the contents of an XML file using a PropertyListXMLMap.

Parameters:

propertyListFilePath - - the file path for this instance of PropertyList

map - - PropertyListXMLMap definition to use

Throws:

PropertyListHandlerException

loadPropertyListFromFile

public static void loadPropertyListFromFile(java.lang.String propertyListName,
                                            java.lang.String propertyListFilePath,
                                            PropertyListXMLMap map)
                                     throws PropertyListHandlerException

This method loads a PropertyList from the contents of an XML file using a PropertyListXMLMap.

Parameters:

propertyListName - - the name of the PropertyList

propertyListFilePath - - the file path for this instance of PropertyList

map - - PropertyListXMLMap definition to use

Throws:

PropertyListHandlerException

loadPropertyListFromResource

public static void loadPropertyListFromResource(java.lang.String propertyListResourcePath,
                                                PropertyListXMLMap map)
                                         throws PropertyListHandlerException

This method loads a PropertyList from the contents of an XML classpath resource using a PropertyListXML map.

Parameters:

propertyListResourcePath -

map - - PropertyListXMLMap definition to use

Throws:

PropertyListHandlerException

loadPropertyListFromResource

public static void loadPropertyListFromResource(java.lang.String propertyListName,
                                                java.lang.String propertyListResourcePath,
                                                PropertyListXMLMap map)
                                         throws PropertyListHandlerException

This method loads a PropertyList from the contents of an XML classpath resource using a PropertyListXMLMap.

Parameters:

propertyListName - - the name of the PropertyList

propertyListResourcePath -

map - - PropertyListXMLMap definition to use

Throws:

PropertyListHandlerException

loadPropertyList

public static void loadPropertyList(java.lang.String propertyListPath)
                             throws PropertyListHandlerException

This wrapper method tries to find a given propertyListPath as a classpath resource, then as a file resource, and then loads it.

Parameters:

propertyListPath - - the classloader or file path of the PropertyList file

Throws:

PropertyListHandlerException

loadPropertyList

public static void loadPropertyList(java.lang.String propertyListName,
                                    java.lang.String propertyListPath)
                             throws PropertyListHandlerException

This wrapper method tries to find a given propertyListPath as a classpath resource, then as a file resource, and then loads it.

Parameters:

propertyListName - - the name of the PropertyList

propertyListPath - - the classloader or file path of the PropertyList file

Throws:

PropertyListHandlerException

loadPropertyListFromFile

public static void loadPropertyListFromFile(java.lang.String propertyListFilePath)
                                     throws PropertyListHandlerException

This method loads a PropertyList from the contents of an XML file.

Parameters:

propertyListFilePath - - the file path for this instance of PropertyList

Throws:

PropertyListHandlerException

loadPropertyListFromFile

public static void loadPropertyListFromFile(java.lang.String propertyListName,
                                            java.lang.String propertyListFilePath)
                                     throws PropertyListHandlerException

This method loads a PropertyList from the contents of an XML file.

Parameters:

propertyListName - - the name of the PropertyList

propertyListFilePath - - the file path for this instance of PropertyList

Throws:

PropertyListHandlerException

loadPropertyListFromResource

public static void loadPropertyListFromResource(java.lang.String propertyListResourcePath)
                                         throws PropertyListHandlerException

This method loads a PropertyList from the contents of an XML classpath resource.

Parameters:

propertyListResourcePath -

Throws:

PropertyListHandlerException

loadPropertyListFromResource

public static void loadPropertyListFromResource(java.lang.String propertyListName,
                                                java.lang.String propertyListResourcePath)
                                         throws PropertyListHandlerException

This method loads a PropertyList from the contents of an XML classpath resource.

Parameters:

propertyListName - - the name of the PropertyList

propertyListResourcePath -

Throws:

PropertyListHandlerException

reloadOnFileChange

public static void reloadOnFileChange()

This method reloads a file-based XML document based on file change.

reloadOnFileChange

public static void reloadOnFileChange(java.lang.String propertyListName)

This method reloads a file-based XML document based on file change.

Parameters:

propertyListName - - the name of the PropertyList

reset

public static void reset()

This method resets this singleton instance. Not recommended for use except for JUnit testing of Habitat4J.

setFeature

public static void setFeature(java.lang.String name,
                              boolean value)
                       throws PropertyListHandlerException

This method sets a Habitat4J feature.

Parameters:

name - - the name of the feature

value - - the value of the feature

Throws:

PropertyListHandlerException

setFeature

public static void setFeature(java.lang.String name,
                              int value)
                       throws PropertyListHandlerException

This method sets a Habitat4J feature.

Parameters:

name - - the name of the feature

value - - the value of the feature

Throws:

PropertyListHandlerException

setFeature

public static void setFeature(java.lang.String name,
                              java.lang.String value)
                       throws PropertyListHandlerException

This method sets a Habitat4J feature.

Parameters:

name - - the name of the feature

value - - the value of the feature

Throws:

PropertyListHandlerException

setPragmaDefinition

public static void setPragmaDefinition(java.lang.String propertyListName,
                                       java.lang.String name,
                                       java.lang.String value)
                                throws PropertyListHandlerException

Parameters:

propertyListName -

name -

value -

Throws:

PropertyListHandlerException

setPragmaDefinition

public static void setPragmaDefinition(java.lang.String name,
                                       java.lang.String value)
                                throws PropertyListHandlerException

Parameters:

name -

value -

Throws:

PropertyListHandlerException

addGlobalDecoderDefinition

public static void addGlobalDecoderDefinition(java.lang.String id,
                                              java.lang.Object decoderObject)

Parameters:

id - - the id for the DecryptorIF implementation

decoderObject - - the instance for the DecoderIF implementation

addGlobalDecoderDefinition

public static void addGlobalDecoderDefinition(java.lang.String id,
                                              java.lang.Class decoderClass)

Parameters:

id - - the id for the DecoderIF implementation

decoderClass - - the class for the DecoderIF implementation

addGlobalDecryptorDefinition

public static void addGlobalDecryptorDefinition(java.lang.String id,
                                                java.lang.Object decryptorObject)

Parameters:

id - - the id for the DecryptorIF implementation

decryptorObject - - the instance for the DecryptorIF implementation

addGlobalDecrytorDefinition

public static void addGlobalDecrytorDefinition(java.lang.String id,
                                               java.lang.Class decryptorClass)

Parameters:

id - - the id for the DecryptorIF implementation

decryptorClass - - the class for the DecryptorIF implementation

addGlobalPropertyBeanDefinition

public static void addGlobalPropertyBeanDefinition(java.lang.String id,
                                                   java.lang.Class propertyBeanClass)

Parameters:

id - - the id for the PropertyBean Object

propertyBeanClass - - the class for the PropertyBean Object

inhibitReload

public static void inhibitReload()

This method forces Habitat4J to inhibit all reload actions.

inhibitReload

public static void inhibitReload(long expiration)

This method forces Habitat4J to inhibit all reload actions.

Parameters:

expiration - - specifies the duration of the reload inhibition.

uninhibitReload

public static void uninhibitReload()

This method releases Habitat4J's reload inhibition.

clearReloadablePropertyLists

public static void clearReloadablePropertyLists()

removeReloadablePropertyList

public static void removeReloadablePropertyList(java.lang.String propertyListName)

addReloadablePropertyList

public static void addReloadablePropertyList(java.lang.String propertyListName)

isReloadablePropertyList

public static boolean isReloadablePropertyList(java.lang.String propertyListName)

toDisplayString

public static java.lang.String toDisplayString()

This method is used for debugging purposes.

Returns:

Returns a human-readable display string containing all PropertyList instances and their properties managed by this PropertyListManager.