Package org.opencms.configuration

Class CmsVariablesConfiguration

java.lang.Object

org.opencms.configuration.A_CmsXmlConfiguration

org.opencms.configuration.CmsVariablesConfiguration

All Implemented Interfaces:

I_CmsConfigurationParameterHandler, I_CmsXmlConfiguration

public class CmsVariablesConfiguration
extends A_CmsXmlConfiguration

Class to read and write the OpenCms site configuration.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	CONFIGURATION_DTD_NAME	The name of the DTD for this configuration.
static java.lang.String	DEFAULT_XML_FILE_NAME	The name of the default XML file for this configuration.
static java.lang.String	N_BEFORELOGINMESSAGE	The node name for the login message.
static java.lang.String	N_ENABLED	The node name for the login message enabled flag.
static java.lang.String	N_LOGINFORBIDDEN	The node name for the login message login forbidden flag.
static java.lang.String	N_LOGINMESSAGE	The node name for the login message.
static java.lang.String	N_MESSAGE	The node name for the login message text.
static java.lang.String	N_TIMEEND	The node name for the login message end time.
static java.lang.String	N_TIMESTART	The node name for the login message start time.
static java.lang.String	N_VARIABLES	The node name for the variables element.

Fields inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler

ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD

Fields inherited from interface org.opencms.configuration.I_CmsXmlConfiguration

A_ALIAS, A_CLASS, A_COUNT, A_DEFAULT, A_DESTINATION, A_ENABLED, A_FROM, A_HANDLER, A_ICON, A_ID, A_KEY, A_MODE, A_NAME, A_ORDER, A_PASSWORD, A_PORT, A_PROTOCOL, A_SUFFIX, A_TO, A_TYPE, A_URI, A_USER, A_VALUE, N_EXPORTPOINT, N_EXPORTPOINTS, N_NAME, N_PARAM, N_PROPERTY, N_RESOURCE, N_SITE, N_VALUE

Constructor Summary

Constructors

Constructor	Description
CmsVariablesConfiguration()

Method Summary

Modifier and Type	Method	Description
void	addXmlDigesterRules(org.apache.commons.digester3.Digester digester)	Digests an XML node and creates an instance of this configurable class.
org.dom4j.Element	generateXml(org.dom4j.Element parent)	Generates the XML element for this configurable class.
CmsLoginMessage	getBeforeLoginMessage()	Returns the login message.
java.lang.String	getDtdFilename()	Returns the name of the DTD file for this XML configuration, e.g.
CmsLoginMessage	getLoginMessage()	Returns the login message.
protected void	initMembers()	Initializes member variables.
void	setBeforeLoginMessage(CmsLoginMessage message)	Adds the before login message from the configuration.
void	setLoginMessage(CmsLoginMessage message)	Adds the login message from the configuration.

Methods inherited from class org.opencms.configuration.A_CmsXmlConfiguration

addConfigurationParameter, getConfiguration, getDtdSystemLocation, getDtdUrlPrefix, getXmlFileName, initConfiguration, setXmlFileName

Methods inherited from class java.lang.Object

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

Field Detail

N_LOGINMESSAGE

public static final java.lang.String N_LOGINMESSAGE

The node name for the login message.

See Also:

Constant Field Values

N_BEFORELOGINMESSAGE

public static final java.lang.String N_BEFORELOGINMESSAGE

The node name for the login message.

See Also:

Constant Field Values

N_VARIABLES

public static final java.lang.String N_VARIABLES

The node name for the variables element.

See Also:

Constant Field Values

N_ENABLED

public static final java.lang.String N_ENABLED

The node name for the login message enabled flag.

See Also:

Constant Field Values

N_MESSAGE

public static final java.lang.String N_MESSAGE

The node name for the login message text.

See Also:

Constant Field Values

N_TIMESTART

public static final java.lang.String N_TIMESTART

The node name for the login message start time.

See Also:

Constant Field Values

N_TIMEEND

public static final java.lang.String N_TIMEEND

The node name for the login message end time.

See Also:

Constant Field Values

N_LOGINFORBIDDEN

public static final java.lang.String N_LOGINFORBIDDEN

The node name for the login message login forbidden flag.

See Also:

Constant Field Values

CONFIGURATION_DTD_NAME

public static final java.lang.String CONFIGURATION_DTD_NAME

The name of the DTD for this configuration.

See Also:

Constant Field Values

DEFAULT_XML_FILE_NAME

public static final java.lang.String DEFAULT_XML_FILE_NAME

The name of the default XML file for this configuration.

See Also:

Constant Field Values

Constructor Detail

CmsVariablesConfiguration

public CmsVariablesConfiguration()

Method Detail

addXmlDigesterRules

public void addXmlDigesterRules(org.apache.commons.digester3.Digester digester)

Description copied from interface: I_CmsXmlConfiguration

Digests an XML node and creates an instance of this configurable class.

Parameters:

digester - the digester to use

See Also:

I_CmsXmlConfiguration.addXmlDigesterRules(org.apache.commons.digester3.Digester)

generateXml

public org.dom4j.Element generateXml(org.dom4j.Element parent)

Description copied from interface: I_CmsXmlConfiguration

Generates the XML element for this configurable class.

Parameters:

parent - the parent element in the XML tree

Returns:

the XML element for this configurable class

See Also:

I_CmsXmlConfiguration.generateXml(org.dom4j.Element)

getBeforeLoginMessage

public CmsLoginMessage getBeforeLoginMessage()

Returns the login message.

Returns:

before login message

getDtdFilename

public java.lang.String getDtdFilename()

Description copied from interface: I_CmsXmlConfiguration

Returns the name of the DTD file for this XML configuration, e.g. opencms-configuration.dtd.

Returns:

the name of the DTD file for this XML configuration

See Also:

I_CmsXmlConfiguration.getDtdFilename()

getLoginMessage

public CmsLoginMessage getLoginMessage()

Returns the login message.

Returns:

the login message

setBeforeLoginMessage

public void setBeforeLoginMessage(CmsLoginMessage message)

Adds the before login message from the configuration.

Parameters:

message - the login message to add

setLoginMessage

public void setLoginMessage(CmsLoginMessage message)

Adds the login message from the configuration.

Parameters:

message - the login message to add

initMembers

protected void initMembers()

Description copied from class: A_CmsXmlConfiguration

Initializes member variables.

Specified by:

initMembers in class A_CmsXmlConfiguration

See Also:

A_CmsXmlConfiguration.initMembers()