com.dpslink.base.util

Class Profile

java.lang.Object

com.dpslink.base.util.Profile

All Implemented Interfaces:

java.io.Serializable

public class Profile
extends java.lang.Object
implements java.io.Serializable

A utility class that loads an application's individual properties files into a single properties object. An application defines the properties files that are to be loaded within a profile list file. The order of the definitions in the profile list file determines the order in which properties files are read and stored by this class.

An application identifies the profile list to use in an app.profile.list file. This file contains a single entry which points to a profile list file. The profile list file contains a list of the properties files to load.

Example app.profile.list:

 myapplication.list
 

Example myapplication.list:

 base.site.properties
 base.dbinfo.properties
 base.message.properties
 base.log4j.properties
 base.velocity.properties
 myapplication.site.properties
 myapplication.db.properties
 myapplication.dbinfo.properties
 myapplication.dbsql.properties
 myapplication.message.properties
 

When duplicate keys exist in the properties files being loaded, the last key read overrides the value stored by an earlier read.

This class assumes that the app.profile.list file as well as all other referenced files reside in a folder that is accessible via the classpath. Properties file names are assumed to be lower case.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	BASE_URL_ISSAME A flag indicating if the site is configured to run full-time SSL or full-time nonSSL.
static java.lang.String	BASE_URL_NONSECURE The value of the "Site.URL.Nonsecure" key.
static java.lang.String	BASE_URL_SECURE The value of the "Site.URL.Secure" key.
static int	COOKIE_EXPIRES The value of the "Site.Cookie.Expires" key.
private static java.util.Properties	cvProfile A static cache of profile properties.
static java.text.DateFormat	FMT_DATEINPUT The value of the "Site.Format.DateInput" key.
static java.text.DateFormat	FMT_TIMEINPUT The value of the "Site.Format.TimeInput" key.
private static long	serialVersionUID The class' serialization version id.
static java.lang.String	SITE_PATH The value of the "Site.Path" key.
static java.lang.String	SITE_ROOT The value of the "Site.Root" key.
static java.lang.String[]	STACK_OMIT_PARMS The value of the "Servlet.Stack.Omit.Parms" key.
static java.lang.String	TEMP_PATH The value of the "FileSystem.TempFolder" key.
static java.lang.String	URL_ERROR The URL to the SiteError servlet.
static java.lang.String	URL_REDIRECT The URL to the Redirect.html file.

Constructor Summary

Constructors

Constructor and Description
Profile()

Method Summary

Modifier and Type	Method and Description
static void	dumpPropertiesToFile() Dumps a sorted list of all profile.list property keys and values to a file named "_properties.profile.txt" in the application's temp folder.
static java.util.ArrayList<java.lang.String>	dumpPropertiesToList() Returns a sorted list of all profile.list property keys and values.
static boolean	getBoolean(java.lang.String key) Returns a boolean value for the given properties key.
static double	getDouble(java.lang.String key) Returns an double value for the given properties key.
static int	getInteger(java.lang.String key) Returns an int value for the given properties key.
static int[]	getIntegerArray(java.lang.String key, java.lang.String delimiter) Returns an int array of the parsed values for the given properties key using the given parsing delimiter.
static java.lang.String	getProperty(java.lang.String key) Returns the property value associated with the given key.
static java.lang.String	getProperty(java.lang.String key, java.lang.String dftValue) Returns the property value associated with the given key.
static java.lang.String	getPropertyFileFolder() Returns the file path to the .property configuration folder.
static java.lang.String	getPropertyListContent() Returns the content for the site's configured property list (as defined by app.profile.list).
static java.lang.String	getString(java.lang.String key) Returns a String value for the given properties key.
static java.lang.String[]	getStringArray(java.lang.String key) Returns a String array of the parsed values for the given properties key using the vertical bar (|) as the default parsing delimiter.
static java.lang.String[]	getStringArray(java.lang.String key, java.lang.String delimiter) Returns a String array of the parsed values for the given properties key using the given parsing delimiter.
static java.lang.String	getStringWithError(java.lang.String key) Returns a String value for the given properties key.
static java.util.Properties	getSubSet(java.lang.String prefix, boolean remove) Returns a new Properties object that contains a subset of the profile properties.
static void	init() Initializes the cache of properties and static constants.
private static void	loadProperties() Loads and stores the properties files defined in a profile list.
private static void	loadProperties(java.lang.String propfile) Loads the contents of the given properties file into the cache.
static void	setProperty(java.lang.String key, java.lang.String value) Sets the value for a property key.
private static void	substituteValues() Performs substitutions for property values that contain references to other properties.
private static java.lang.String	substituteValues(java.util.regex.Pattern p, java.lang.String s) Performs substitutions for property values that contain references to other properties.

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

The class' serialization version id.

See Also:

Constant Field Values

cvProfile

private static java.util.Properties cvProfile

A static cache of profile properties.

BASE_URL_SECURE

public static java.lang.String BASE_URL_SECURE

The value of the "Site.URL.Secure" key. This value is used as the base URL for secured (SSL) access to the site. Includes trailing URL separator character.

BASE_URL_NONSECURE

public static java.lang.String BASE_URL_NONSECURE

The value of the "Site.URL.Nonsecure" key. This value is used as the base URL for normal (non-SSL) access to the site. Includes trailing URL separator character.

BASE_URL_ISSAME

public static boolean BASE_URL_ISSAME

A flag indicating if the site is configured to run full-time SSL or full-time nonSSL.

COOKIE_EXPIRES

public static int COOKIE_EXPIRES

The value of the "Site.Cookie.Expires" key. This value (in hours) is used to determine the expiration for a given cookie value (logon id, etc.).

FMT_DATEINPUT

public static java.text.DateFormat FMT_DATEINPUT

The value of the "Site.Format.DateInput" key. This value is used to format a date for text input fields.

FMT_TIMEINPUT

public static java.text.DateFormat FMT_TIMEINPUT

The value of the "Site.Format.TimeInput" key. This value is used to format a time for text input fields.

SITE_PATH

public static java.lang.String SITE_PATH

The value of the "Site.Path" key. This value is used to determine the full path to the root directory for the site. Includes trailing file separator character.

SITE_ROOT

public static java.lang.String SITE_ROOT

The value of the "Site.Root" key. This value is used to determine the main or root directory for the site. Includes trailing URL separator character.

STACK_OMIT_PARMS

public static java.lang.String[] STACK_OMIT_PARMS

The value of the "Servlet.Stack.Omit.Parms" key. This value is used to determine URL parameters that should be omitted from servlet history stack entries.

TEMP_PATH

public static java.lang.String TEMP_PATH

The value of the "FileSystem.TempFolder" key. This value is used to determine the full path to the temporary file folder for the site. Includes trailing file separator character.

URL_ERROR

public static java.lang.String URL_ERROR

The URL to the SiteError servlet. Used by a servlet when a castastrophic error occurs during processing (like can't get a connection).

URL_REDIRECT

public static java.lang.String URL_REDIRECT

The URL to the Redirect.html file. Used by a servlet whenever a redirect is required for protocol switching.

Constructor Detail

Profile

public Profile()

Method Detail

init

public static void init()

Initializes the cache of properties and static constants.

getBoolean

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

Returns a boolean value for the given properties key.

Parameters:

key - (String) The key for the desired property value.

Returns:

boolean - The property value for the given key or false if the value could not be converted to an boolean.

getDouble

public static double getDouble(java.lang.String key)

Returns an double value for the given properties key.

Parameters:

key - (String) The key for the desired property value.

Returns:

double - The property value for the given key or zero if the value could not be converted to an double.

getInteger

public static int getInteger(java.lang.String key)

Returns an int value for the given properties key.

Parameters:

key - (String) The key for the desired property value.

Returns:

int - The property value for the given key or zero if the value could not be converted to an int.

getIntegerArray

public static int[] getIntegerArray(java.lang.String key,
                                    java.lang.String delimiter)

Returns an int array of the parsed values for the given properties key using the given parsing delimiter.

Parameters:

key - (String) The key for the desired property value.

delimiter - (String) The delimiter to be used for the parsing.

Returns:

int[] - An int array containing the parsed results of the retrieved property value.

getProperty

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

Returns the property value associated with the given key.

Parameters:

key - (String) The key for the desired value.

Returns:

String - The value for the given key or null if a value for the key could not be found.

getProperty

public static java.lang.String getProperty(java.lang.String key,
                                           java.lang.String dftValue)

Returns the property value associated with the given key.

Parameters:

key - (String) The key for the desired value.

dftValue - (String) The default value if the key is not found.

Returns:

String - The value for the given key or the default value if a value for the key could not be found.

getString

public static java.lang.String getString(java.lang.String key)

Returns a String value for the given properties key.

Parameters:

key - (String) The key for the desired property value.

Returns:

String - The property value for the given key.

getStringWithError

public static java.lang.String getStringWithError(java.lang.String key)
                                           throws java.util.MissingResourceException

Returns a String value for the given properties key.

Parameters:

key - (String) The key for the desired property value.

Returns:

String - The property value for the given key.

Throws:

java.util.MissingResourceException - - if the key is not found.

getStringArray

public static java.lang.String[] getStringArray(java.lang.String key)

Returns a String array of the parsed values for the given properties key using the vertical bar (|) as the default parsing delimiter.

Parameters:

key - (String) The key for the desired property value.

Returns:

String[] - A String array containing the parsed results of the retrieved property value.

getStringArray

public static java.lang.String[] getStringArray(java.lang.String key,
                                                java.lang.String delimiter)

Returns a String array of the parsed values for the given properties key using the given parsing delimiter.

Parameters:

key - (String) The key for the desired property value.

delimiter - (String) The delimiter to be used for the parsing.

Returns:

String[] - A String array containing the parsed results of the retrieved property value.

getSubSet

public static java.util.Properties getSubSet(java.lang.String prefix,
                                             boolean remove)

Returns a new Properties object that contains a subset of the profile properties. The subset contains all profile properties that have keys beginning with the specified prefix.

Parameters:

prefix - (String) The prefix for the keys to include in the subset (case sensitive).

remove - (boolean) true if the prefix should be removed from the subset's property keys, or false if the subset's property keys should be the same as the keys in the profile properties.

Returns:

Properties - The subset of properties.

getPropertyFileFolder

public static java.lang.String getPropertyFileFolder()

Returns the file path to the .property configuration folder.

Returns:

String - The file path to the .property file folder. Includes trailing file separator character.

getPropertyListContent

public static java.lang.String getPropertyListContent()

Returns the content for the site's configured property list (as defined by app.profile.list).

Returns:

String - The property list content with each line in the content delimited by the new line character (\n). Returns null if the content could not be determined.

setProperty

public static void setProperty(java.lang.String key,
                               java.lang.String value)

Sets the value for a property key.

Parameters:

key - (String) The key for the value to set.

value - (String) The value to set.

loadProperties

private static void loadProperties()

Loads and stores the properties files defined in a profile list. Properties files are assumed to reside in a folder that is accessible via the classpath. File names are assumed to be lower case.

loadProperties

private static void loadProperties(java.lang.String propfile)

Loads the contents of the given properties file into the cache.

Parameters:

propfile - (String) The name of the properties file to load.

substituteValues

private static void substituteValues()

Performs substitutions for property values that contain references to other properties. Invoked after all properties have been loaded into the cache. Iterates through all properties in the cache and updates the cache with the substitution results.

substituteValues

private static java.lang.String substituteValues(java.util.regex.Pattern p,
                                                 java.lang.String s)

Performs substitutions for property values that contain references to other properties. Invoked during substitution processing to handle the value for a specific property key.

Parameters:

p - (Pattern) The precompiled RegEx pattern to use for finding values to be substituted.

s - (String) The property value to process.

Returns:

String - The processed results.

dumpPropertiesToFile

public static void dumpPropertiesToFile()

Dumps a sorted list of all profile.list property keys and values to a file named "_properties.profile.txt" in the application's temp folder.

dumpPropertiesToList

public static java.util.ArrayList<java.lang.String> dumpPropertiesToList()

Returns a sorted list of all profile.list property keys and values.

Returns:

ArrayList - The sorted list.