de.folt.util
Class OpenTMSProperties

java.lang.Object
  de.folt.util.OpenTMSProperties

public class OpenTMSProperties
extends java.lang.Object

This class implements an adapted properties class.

Author:

klemens

Constructor Summary

OpenTMSProperties(java.lang.String propFile)

Method Summary

boolean	getBooleanOpenTMSProperty(java.lang.String key) getBooleanEMXProperty
java.lang.Exception	getException()
static OpenTMSProperties	getInstance() getInstance return an OpenTMSProperties property instance; only one per process; if OpenTMSInstance = null create an OpenTMSProperties
static OpenTMSProperties	getInstance(java.lang.String propertiesFile) getInstance return an OpenTMSProperties property instance; only one per process based on a property file; if OpenTMSInstance = null create an OpenTMSProperties
int	getIntOpenTMSProperty(java.lang.String key) getIntEMXProperty
int	getLogLevel(java.lang.String canonicalName) getLogLevel this method returns the log level for a specific class.
java.util.Properties	getOpenTMSProperties() getOpenTMSProperties
java.lang.String	getOpenTMSPropertiesAsString() getOpenTMSPropertiesAsString return all openTMS properties in a string separated by \n
java.util.Properties	getOpenTMSPropertiesInstance()
java.lang.String	getOpenTMSProperty(java.lang.String key) getEMXProperty retrieves an openTMS property as a string.
static java.lang.String	getPropfileName()
static java.lang.String	getShortpath() getShortpath - get the short path of the properties file
static java.lang.String	getUrlClassPath()
java.lang.String	initOpenTMSPropertiesPath() initOpenTMSPropertiesPath set default OpenTMS property file path using getClass().getClassLoader().getResource("de/folt/util/OpenTMSProperties.class")
java.lang.String	initOpenTMSPropertiesPath(boolean bWithUserName) initOpenTMSPropertiesPath set default OpenTMS property file path using getClass().getClassLoader().getResource("de/folt/util/OpenTMSProperties.class")
void	loadOpenTMSPropertiesToXML() loadOpenTMSPropertiesToXML loads the properties from an property xml file
void	makeCopyOpenTMSProperties() makeCopyOpenTMSProperties - create a backup copy the OpenTMSPropertiesInstance
java.lang.String	returnPropFilePath() returnPropFilePath
void	saveOpenTMSProperties() saveOpenTMSProperties
void	saveOpenTMSPropertiesToXML() saveOpenTMSPropertiesToXML create an xml file from the OpenTMSPropertiesInstance
void	setException(java.lang.Exception exception)
void	setOpenTMSPropertiesInstance(java.util.Properties openTMSPropertiesInstance)
void	setOpenTMSProperty(java.lang.String key, boolean value) setEMXProperty
void	setOpenTMSProperty(java.lang.String key, int value) setOpenTMSProperty
void	setOpenTMSProperty(java.lang.String key, java.lang.String value) setEMXProperty
static void	setPropfileName(java.lang.String propfileName)
static void	setShortpath(java.lang.String shortpath) setShortpath
static void	setUrlClassPath(java.lang.String urlClassPath)

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenTMSProperties

public OpenTMSProperties(java.lang.String propFile)

Parameters:

propFile - set the OpenTMS property file path

Throws:

EMXException

Method Detail

getUrlClassPath

public static java.lang.String getUrlClassPath()

Returns:

the urlClassPath

setUrlClassPath

public static void setUrlClassPath(java.lang.String urlClassPath)

Parameters:

urlClassPath - the urlClassPath to set

getInstance

public static OpenTMSProperties getInstance()

getInstance return an OpenTMSProperties property instance; only one per process; if OpenTMSInstance = null create an OpenTMSProperties

Returns:

an OpenTMSProperties property instance

getInstance

public static OpenTMSProperties getInstance(java.lang.String propertiesFile)

getInstance return an OpenTMSProperties property instance; only one per process based on a property file; if OpenTMSInstance = null create an OpenTMSProperties

Parameters:

propertiesFile - the properties file for the instance

Returns:

an OpenTMSProperties property instance

getPropfileName

public static java.lang.String getPropfileName()

Returns:

the propfileName

getShortpath

public static java.lang.String getShortpath()

getShortpath - get the short path of the properties file

Returns:

the short path of the properties file

setPropfileName

public static void setPropfileName(java.lang.String propfileName)

Parameters:

propfileName - the propfileName to set

setShortpath

public static void setShortpath(java.lang.String shortpath)

setShortpath

Parameters:

shortpath - set the short path of the properties file

getBooleanOpenTMSProperty

public boolean getBooleanOpenTMSProperty(java.lang.String key)

getBooleanEMXProperty

Parameters:

key - the key to retrieve

Returns:

the value of the property key as a boolean

getIntOpenTMSProperty

public int getIntOpenTMSProperty(java.lang.String key)

getIntEMXProperty

Parameters:

key - the key to retrieve

Returns:

the value of the property key as an int

getLogLevel

public int getLogLevel(java.lang.String canonicalName)

getLogLevel this method returns the log level for a specific class. The log level is defined in the OpenTMS.properties file.
Example:

 # OpenTMS LogLevel - this is the general log level which will be used if no log level is defined for the class
 # OpenTMS.LogLevel=0
 # this allows to set specific LogLevels for packages + classnames
 # Structure OpenTMS.LogLevel..
 OpenTMS.LogLevel.de.folt.models.datamodel.sql.OpenTMSSQLDataSource=0


Parameters:
canonicalName - the name of the class for the log level
Returns:

getOpenTMSProperties

public java.util.Properties getOpenTMSProperties()

getOpenTMSProperties

Returns:

the associated properties

getOpenTMSPropertiesAsString

public java.lang.String getOpenTMSPropertiesAsString()

getOpenTMSPropertiesAsString return all openTMS properties in a string separated by \n

Returns:

the openTMS properties string

getOpenTMSPropertiesInstance

public java.util.Properties getOpenTMSPropertiesInstance()

Returns:

the openTMSPropertiesInstance

getOpenTMSProperty

public java.lang.String getOpenTMSProperty(java.lang.String key)

getEMXProperty retrieves an openTMS property as a string. It supports %% notation. This means that the value of %% is replaced by the value with the name of this property. If %CURRENTDIRECTOrY% is used the value is replaced with the name of the current directory. CURRENTDIRECTOrYASURL returns the current directory as URL

Parameters:

key - the key to retrieve

Returns:

the value of the property key as a string

initOpenTMSPropertiesPath

public java.lang.String initOpenTMSPropertiesPath()

initOpenTMSPropertiesPath set default OpenTMS property file path using getClass().getClassLoader().getResource("de/folt/util/OpenTMSProperties.class")

Returns:

the path name of the property file

initOpenTMSPropertiesPath

public java.lang.String initOpenTMSPropertiesPath(boolean bWithUserName)

initOpenTMSPropertiesPath set default OpenTMS property file path using getClass().getClassLoader().getResource("de/folt/util/OpenTMSProperties.class")

Returns:

the path name of the property file

loadOpenTMSPropertiesToXML

public void loadOpenTMSPropertiesToXML()

loadOpenTMSPropertiesToXML loads the properties from an property xml file

makeCopyOpenTMSProperties

public void makeCopyOpenTMSProperties()

makeCopyOpenTMSProperties - create a backup copy the OpenTMSPropertiesInstance

returnPropFilePath

public java.lang.String returnPropFilePath()

returnPropFilePath

Returns:

property file path

saveOpenTMSProperties

public void saveOpenTMSProperties()

saveOpenTMSProperties

saveOpenTMSPropertiesToXML

public void saveOpenTMSPropertiesToXML()

saveOpenTMSPropertiesToXML create an xml file from the OpenTMSPropertiesInstance

setOpenTMSPropertiesInstance

public void setOpenTMSPropertiesInstance(java.util.Properties openTMSPropertiesInstance)

Parameters:

openTMSPropertiesInstance - the openTMSPropertiesInstance to set

setOpenTMSProperty

public void setOpenTMSProperty(java.lang.String key,
                               boolean value)

setEMXProperty

Parameters:

key -

value -

setOpenTMSProperty

public void setOpenTMSProperty(java.lang.String key,
                               int value)

setOpenTMSProperty

Parameters:

key -

value -

setOpenTMSProperty

public void setOpenTMSProperty(java.lang.String key,
                               java.lang.String value)

setEMXProperty

Parameters:

key -

value -

setException

public void setException(java.lang.Exception exception)

Parameters:

exception - the exception to set

getException

public java.lang.Exception getException()

Returns:

the exception