org.productivity.java.habitat4j.common
Class ServerIdentity

java.lang.Object
  org.productivity.java.habitat4j.common.ServerIdentity

All Implemented Interfaces:

Habitat4JConstants

public class ServerIdentity
extends java.lang.Object
implements Habitat4JConstants

This class provides server-wide information used by all applications. An instance of this is managed by the ServerIdentityManager Singleton class. PropertyListManager relies on an instance of ServerIdentity to make contextual decisions on which properties to load for use by the application.

## 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: ServerIdentity.html,v 1.2 2008/11/24 15:15:06 cvs Exp $

Author:

Justin Yunke <habitat4j@productivity.org>

Field Summary

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

Constructor Summary

ServerIdentity()

Method Summary

ServerIdentityRole	addRole(java.lang.String name) This method adds a ServerIdentityRole to a ServerIdentity instance.
java.lang.String	getApplicationName()
java.lang.String	getEnvironment()
java.util.Hashtable	getFixed()
java.lang.String	getInstanceDescription()
java.lang.String	getInstanceEnumeration()
java.lang.String	getInstanceName()
java.lang.String	getInstanceOS()
java.lang.String	getModifiedBy()
java.lang.String	getPragmaDefinition(java.lang.String name)
java.util.Hashtable	getPragmaDefinitions()
ServerIdentityRole	getRole(java.lang.String name)
java.util.Hashtable	getRoles()
java.lang.String	getVersion()
boolean	hasPragmaDefinitions()
void	reset() This method resets all of the contents of this object.
void	setApplicationName(java.lang.String applicationName)
void	setEnvironment(java.lang.String environment)
void	setInstanceDescription(java.lang.String instanceDescription)
void	setInstanceEnumeration(java.lang.String instanceEnumeration)
void	setInstanceName(java.lang.String instanceName)
void	setInstanceOS(java.lang.String instanceOS)
void	setModifiedBy(java.lang.String modifiedBy)
void	setPragmaDefinition(java.lang.String name, java.lang.String value)
void	setVersion(java.lang.String version)
java.lang.String	toString() This method provides a human-readable dump of all variables that make up an instance of ServerIdentity.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerIdentity

public ServerIdentity()

Method Detail

getApplicationName

public java.lang.String getApplicationName()

Returns:

Returns the name of the calling application.

getVersion

public java.lang.String getVersion()

Returns:

Returns the version.

getModifiedBy

public java.lang.String getModifiedBy()

Returns:

Returns the modifiedBy.

getEnvironment

public java.lang.String getEnvironment()

Returns:

Returns the server's environment designation.

setEnvironment

public void setEnvironment(java.lang.String environment)

Parameters:

environment - the server's environment designation to set

getInstanceDescription

public java.lang.String getInstanceDescription()

Returns:

Returns the description of the server's instance.

setInstanceDescription

public void setInstanceDescription(java.lang.String instanceDescription)

Parameters:

instanceDescription - the server's instance description to set

getInstanceEnumeration

public java.lang.String getInstanceEnumeration()

Returns:

Returns the server's instance enumeration.

setInstanceEnumeration

public void setInstanceEnumeration(java.lang.String instanceEnumeration)

Parameters:

instanceEnumeration - the server's instance enumeration to set

getInstanceName

public java.lang.String getInstanceName()

Returns:

Returns the server's instance name.

setInstanceOS

public void setInstanceOS(java.lang.String instanceOS)

Parameters:

instanceName - the server's instance operating system to set

getInstanceOS

public java.lang.String getInstanceOS()

Returns:

Returns the server's instance operating system.

setInstanceName

public void setInstanceName(java.lang.String instanceName)

Parameters:

instanceName - the server's instance name to set

hasPragmaDefinitions

public boolean hasPragmaDefinitions()

Returns:

Returns where there are pragmatic definitions available.

getPragmaDefinitions

public java.util.Hashtable getPragmaDefinitions()

Returns:

Returns the list of pragmatic definitions in the form of a Hashtable.

getPragmaDefinition

public java.lang.String getPragmaDefinition(java.lang.String name)

Parameters:

name - - the String name of the pragma definition to retrieve

Returns:

Returns the pragmatic definition defined by a specific name.

setPragmaDefinition

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

Parameters:

name - - the String name of the pragma definition to set

value - - the String value of the pragma definition to set

getRoles

public java.util.Hashtable getRoles()

Returns:

Returns the Hashtable list of roles.

addRole

public ServerIdentityRole addRole(java.lang.String name)

This method adds a ServerIdentityRole to a ServerIdentity instance. If the role has already been defined, the specific instance is returned to be overridden.

Parameters:

name - the role name to add, such as "dbServer," "appServer," or "webServer"

Returns:

Returns an instance of ServerIdentityRole

getRole

public ServerIdentityRole getRole(java.lang.String name)

Parameters:

name - the role name to get, such as "dbServer," "appServer," or "webServer"

Returns:

Returns an instance of ServerIdentityRole

setApplicationName

public void setApplicationName(java.lang.String applicationName)

Parameters:

applicationName - the name of the calling application to be set

setVersion

public void setVersion(java.lang.String version)

Parameters:

version - The version to set.

setModifiedBy

public void setModifiedBy(java.lang.String modifiedBy)

Parameters:

modifiedBy - The modifiedBy to set.

getFixed

public java.util.Hashtable getFixed()

Returns:

Returns the fixed items, such as applicationName, environment, etc.

reset

public void reset()

This method resets all of the contents of this object.

toString

public java.lang.String toString()

This method provides a human-readable dump of all variables that make up an instance of ServerIdentity.

Overrides:

toString in class java.lang.Object

Returns:

Returns a human-readable dump of all variables in the form of a String.