com.technia.tvc.core

Class TVCSystem

java.lang.Object

com.technia.tvc.core.TVCSystem

public final class TVCSystem
extends java.lang.Object

This class contains system properties for TVC. This class is similar to java.lang.System in that the properties that can be retrieved are initiated from input parameters to the application.

The properties of this class is configured using init-params to the TVCServlet. Example:

                  <servlet>
                    <servlet-name>tvc_servlet</servlet-name>
                    <servlet-class>com.technia.tvc.core.TVCServlet</servlet-class>
                    <init-param>
                      <param-name>tvc.core.host</param-name>
                      <param-value>rmi://localhost:1099</param-value>
                    </init-param>
                  </servlet>
 

Besides setting all custom properties directly in the deployment descriptor (The web.xml file), you can create one or more Page objects in the Matrix database and set the page init parameter to contain a comma-separated list of Page object names, then every Page object will be loaded as a .properties file.

Here are the most central properties that can be configured:

• tvc.core.server - the collaboration server name (Default is :bos).
• tvc.core.host - the collaboration server host (Default is rmi://localhost:1099).
• tvc.core.user - the system user name (Default is creator). Note that this user must have system user access for TVC to work properly.
• tvc.core.password - the system user's password (Default is an empty string).
• tvc.core.dateTimeFormat - the date time format to use when parsing date values retrieved from Matrix (Default is MM/dd/yyyy hh:mm:ss a ).
• tvc.core.inputDateTimeFormat - the date time format to use when formatting date values that should be sent to Matrix (Default is MM/dd/yyyy hh:mm:ss a).
• tvc.core.country - the default country to use when retrieving locale sensitive information (Default is US).
• tvc.core.language - the default language to use when retrieving locale sensitive information (Default is en).
• tvc.core.encoding - the default encoding to use when sending/recieving data to/from the clients (Default is UTF-8).
• tvc.core.productionMode - a boolean value indicating whether the application is running in production mode or not (default is true).

Note that neither "tvc.core.server", "tvc.core.host", "tvc.core.user" nor "tvc.core.password" can be configured from a page object.

Also note that the properties tvc.core.server, tvc.core.host, tvc.core.dateTimeFormat and tvc.core.inputDateTimeFormat are set from the AEF if possible, thereby discarding any settings made in the deployment descriptor.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROGRAM_INIT_TVC_SYSTEM_USER Name of program used to fetch TVC System user name/password

Method Summary

Methods

Modifier and Type	Method and Description
static void	destroyForDebug() This method should be used to destroy the system from code outside this package.
static <T> T	execFromJPO(matrix.db.Context ctx, TxAction<T> action) This method can be used to run TVC code from within a JPO.
java.lang.Boolean	getBooleanProperty(java.lang.String key) Returns the system property with the specified key converted to a Boolean instance.
boolean	getBooleanProperty(java.lang.String key, boolean defaultValue) Returns the system property with the specified key converted to a boolean, or the default value if not such property exist.
java.lang.Boolean	getBooleanProperty(java.lang.String key, java.lang.Boolean defaultValue) Returns the system property with the specified key converted to a Boolean instance, or the default value if not such property exist.
java.lang.String	getCountry() Returns the system's default country when retrieving locale sensitive information.
java.lang.String	getDateTimeFormat() Returns the system's date time format to use when parsing dates recieved from the Matrix database.
java.lang.String	getEncoding() Returns the systems default encoding used when sending/recieving HTTP information.
java.lang.Float	getFloatProperty(java.lang.String key) Returns the system property with the specified key converted to a Float instance.
float	getFloatProperty(java.lang.String key, float defaultValue) Returns the system property with the specified key converted to a float, or the default value if not such property exist.
java.lang.Float	getFloatProperty(java.lang.String key, java.lang.Float defaultValue) Returns the system property with the specified key converted to a Float instance, or the default value if not such property exist.
java.lang.String	getHost() Returns the default host.
java.lang.String	getInputDateTimeFormat() Returns the system's date time format to use when setting date time values in the Matrix database.
static TVCSystem	getInstance() Returns the TVCSystem instance.
java.lang.Integer	getIntegerProperty(java.lang.String key) Returns the system property with the specified key converted to a Integer instance.
int	getIntegerProperty(java.lang.String key, int defaultValue) Returns the system property with the specified key converted to an int, or the default value if not such property exist.
java.lang.Integer	getIntegerProperty(java.lang.String key, java.lang.Integer defaultValue) Returns the system property with the specified key converted to a Integer instance, or the default value if not such property exist.
java.lang.String	getLanguage() Returns the system's default language when retrieving locale sensitive information.
java.util.Locale	getLocale() Returns the system's default locale when retrieving locale sensitive information.
java.lang.Long	getLongProperty(java.lang.String key) Returns the system property with the specified key converted to a Long instance.
long	getLongProperty(java.lang.String key, long defaultValue) Returns the system property with the specified key converted to a long, or the default value if not such property exist.
java.lang.Long	getLongProperty(java.lang.String key, java.lang.Long defaultValue) Returns the system property with the specified key converted to a Long instance, or the default value if not such property exist.
com.technia.tvc.core.resource.TVCPropertyMessageResources	getMessageResources() Returns the message resource bundle, used to localize messages or UI labels within the TVC subsystem.
java.lang.String	getPassword() Returns the system user's password.
java.lang.String	getProperty(java.lang.String key) Returns the system property with the specified key.
java.lang.String	getProperty(java.lang.String key, java.lang.String defaultValue) Returns the system property with the specified key, or the default value if not such property exist.
com.technia.tvc.core.res.ResourceDefLocator	getResourceLocator() Returns the resource locator used to ...
java.lang.String	getServer() Deprecated. Deprecated in ADK 10.6.3 or later.
long	getStartupTime() Returns the time when TVC was started (or when TVC System was initialized)
java.lang.String	getTempDir() Returns the path to the application's temp directory.
java.lang.String	getUser() Returns the system user's name.
java.lang.String	getWebappRootDir() Returns the path to the webapp root directory.
static void	initForDebug(java.util.Properties prop) This method is the only way to initialize the system from code outside this package.
boolean	isDevelopmentMode() Returns whether the application is running in development mode or not.
static boolean	isInitialized() Returns true if the system has been initialized.
static boolean	isInitializedForDebug() Returns true if the system has been initialized for debug.
static boolean	isNotInitialized() Returns true if the system has NOT been initialized.
boolean	isProductionMode() Returns whether the application is running in production mode or not.
java.util.Iterator<java.lang.String>	propertyKeys() Returns an iterator over the available property keys.
java.util.Iterator<java.lang.String>	propertyKeys(java.lang.String prefix) Returns an iterator over the available property keys starting with the specified prefix.
void	setProductionMode(boolean productionMode) Sets the production mode

Methods inherited from class java.lang.Object

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

Field Detail

PROGRAM_INIT_TVC_SYSTEM_USER

public static final java.lang.String PROGRAM_INIT_TVC_SYSTEM_USER

Name of program used to fetch TVC System user name/password

See Also:

Constant Field Values

Method Detail

getStartupTime

public long getStartupTime()

Returns the time when TVC was started (or when TVC System was initialized)

Returns:

The start up time

Since:

2009.2.2

getMessageResources

public com.technia.tvc.core.resource.TVCPropertyMessageResources getMessageResources()

Returns the message resource bundle, used to localize messages or UI labels within the TVC subsystem.

These resources were previously only available from the servlet context, thus making it impossible to use these resources from any code outside the "servlet/jsp/custom tag" area.

Returns:

A TVCPropertyMessageResources instance.

Since:

5.1.1

getProperty

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

Returns the system property with the specified key.

Parameters:

key - the key to the property.

Returns:

the property.

getProperty

public java.lang.String getProperty(java.lang.String key,
                           java.lang.String defaultValue)

Returns the system property with the specified key, or the default value if not such property exist.

Parameters:

key - the key to the property.

defaultValue - the default value.

Returns:

the property.

propertyKeys

public java.util.Iterator<java.lang.String> propertyKeys()

Returns an iterator over the available property keys.

propertyKeys

public java.util.Iterator<java.lang.String> propertyKeys(java.lang.String prefix)

Returns an iterator over the available property keys starting with the specified prefix.

Parameters:

prefix - the property prefix.

getBooleanProperty

public java.lang.Boolean getBooleanProperty(java.lang.String key)

Returns the system property with the specified key converted to a Boolean instance.

Parameters:

key - the key to the property.

Returns:

the property.

getBooleanProperty

public java.lang.Boolean getBooleanProperty(java.lang.String key,
                                   java.lang.Boolean defaultValue)

Returns the system property with the specified key converted to a Boolean instance, or the default value if not such property exist.

Parameters:

key - the key to the property.

defaultValue - the default value.

Returns:

the property.

getBooleanProperty

public boolean getBooleanProperty(java.lang.String key,
                         boolean defaultValue)

Returns the system property with the specified key converted to a boolean, or the default value if not such property exist.

Parameters:

key - the key to the property.

defaultValue - the default value.

Returns:

the property.

Since:

6.1.4

getIntegerProperty

public java.lang.Integer getIntegerProperty(java.lang.String key)

Returns the system property with the specified key converted to a Integer instance.

Parameters:

key - the key to the property.

Returns:

the property.

getIntegerProperty

public java.lang.Integer getIntegerProperty(java.lang.String key,
                                   java.lang.Integer defaultValue)

Returns the system property with the specified key converted to a Integer instance, or the default value if not such property exist.

Parameters:

key - the key to the property.

defaultValue - the default value.

Returns:

the property.

getIntegerProperty

public int getIntegerProperty(java.lang.String key,
                     int defaultValue)

Returns the system property with the specified key converted to an int, or the default value if not such property exist.

Parameters:

key - the key to the property.

defaultValue - the default value.

Returns:

the property.

Since:

6.1.4

getLongProperty

public java.lang.Long getLongProperty(java.lang.String key)

Returns the system property with the specified key converted to a Long instance.

Parameters:

key - the key to the property.

Returns:

the property.

getLongProperty

public java.lang.Long getLongProperty(java.lang.String key,
                             java.lang.Long defaultValue)

Returns the system property with the specified key converted to a Long instance, or the default value if not such property exist.

Parameters:

key - the key to the property.

defaultValue - the default value.

Returns:

the property.

getLongProperty

public long getLongProperty(java.lang.String key,
                   long defaultValue)

Returns the system property with the specified key converted to a long, or the default value if not such property exist.

Parameters:

key - the key to the property.

defaultValue - the default value.

Returns:

the property.

Since:

6.1.4

getFloatProperty

public java.lang.Float getFloatProperty(java.lang.String key)

Returns the system property with the specified key converted to a Float instance.

Parameters:

key - the key to the property.

Returns:

the property.

Since:

6.1.4

getFloatProperty

public java.lang.Float getFloatProperty(java.lang.String key,
                               java.lang.Float defaultValue)

Returns the system property with the specified key converted to a Float instance, or the default value if not such property exist.

Parameters:

key - the key to the property.

defaultValue - the default value.

Returns:

the property.

Since:

6.1.4

getFloatProperty

public float getFloatProperty(java.lang.String key,
                     float defaultValue)

Returns the system property with the specified key converted to a float, or the default value if not such property exist.

Parameters:

key - the key to the property.

defaultValue - the default value.

Returns:

the property.

Since:

6.1.4

getServer

@Deprecated
public java.lang.String getServer()

Deprecated. Deprecated in ADK 10.6.3 or later.

Returns the default server.

Returns:

the default server.

getHost

public java.lang.String getHost()

Returns the default host.

Returns:

the default host.

getUser

public java.lang.String getUser()

Returns the system user's name.

Returns:

the system user's name.

getPassword

public java.lang.String getPassword()

Returns the system user's password.

Returns:

the system user's password.

getDateTimeFormat

public java.lang.String getDateTimeFormat()

Returns the system's date time format to use when parsing dates recieved from the Matrix database.

Returns:

the system's date time format.

getInputDateTimeFormat

public java.lang.String getInputDateTimeFormat()

Returns the system's date time format to use when setting date time values in the Matrix database.

Returns:

the system's input date time format.

getCountry

public java.lang.String getCountry()

Returns the system's default country when retrieving locale sensitive information.

Returns:

the default country.

getLanguage

public java.lang.String getLanguage()

Returns the system's default language when retrieving locale sensitive information.

Returns:

the default language.

getLocale

public java.util.Locale getLocale()

Returns the system's default locale when retrieving locale sensitive information.

Returns:

the default locale.

getEncoding

public java.lang.String getEncoding()

Returns the systems default encoding used when sending/recieving HTTP information.

Returns:

the default encoding.

isProductionMode

public boolean isProductionMode()

Returns whether the application is running in production mode or not.

setProductionMode

public void setProductionMode(boolean productionMode)

Sets the production mode

isDevelopmentMode

public boolean isDevelopmentMode()

Returns whether the application is running in development mode or not.

getWebappRootDir

public java.lang.String getWebappRootDir()

Returns the path to the webapp root directory. Note that this method will return null if the application is deployed as a WAR file.

getTempDir

public java.lang.String getTempDir()

Returns the path to the application's temp directory.

getResourceLocator

public com.technia.tvc.core.res.ResourceDefLocator getResourceLocator()

Returns the resource locator used to ...

getInstance

public static TVCSystem getInstance()

Returns the TVCSystem instance.

Returns:

the TVCSystem instance.

Throws:

TVCSystemUnavailableException - if the system has not been properly setup.

initForDebug

public static void initForDebug(java.util.Properties prop)

This method is the only way to initialize the system from code outside this package. The purpose of this method is to provide the means for initializing the system when the TVCServlet isn't available (e.g., when debugging).

Parameters:

prop - the properties.

Throws:

TVCSystemAlreadyInitializedException - if the system has already been initialized.

See Also:

destroyForDebug()

destroyForDebug

public static void destroyForDebug()

This method should be used to destroy the system from code outside this package.

See Also:

initForDebug(Properties)

isNotInitialized

public static boolean isNotInitialized()

Returns true if the system has NOT been initialized.

Returns:

true if the system has NOT been initialized.

isInitialized

public static boolean isInitialized()

Returns true if the system has been initialized.

Returns:

true if the system has been initialized.

isInitializedForDebug

public static boolean isInitializedForDebug()

Returns true if the system has been initialized for debug.

Returns:

true if the system has been initialized for debug.

execFromJPO

public static <T> T execFromJPO(matrix.db.Context ctx,
                TxAction<T> action)
                     throws TVCException,
                            TxException,
                            TxActionException

This method can be used to run TVC code from within a JPO. The purpose of running this method is to make sure that the TVCSystem has been properly initialized and that a TxContext is allocated for the executing thread.

Parameters:

ctx - The context.

action - The action to execute.

Returns:

Whatever is returned from the action.

Throws:

TVCException - If unable to initialize TVCSystem or execute the action.

TxException - If an exception is thrown while executing the action.

TxActionException - If an exception is thrown from the action.