Package org.opencms.configuration

Class CmsSitesConfiguration

java.lang.Object

org.opencms.configuration.A_CmsXmlConfiguration

org.opencms.configuration.CmsSitesConfiguration

All Implemented Interfaces:

I_CmsConfigurationParameterHandler, I_CmsXmlConfiguration, I_CmsXmlConfigurationWithUpdateHandler

public class CmsSitesConfiguration
extends A_CmsXmlConfiguration
implements I_CmsXmlConfigurationWithUpdateHandler

Class to read and write the OpenCms site configuration.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	A_ERROR	The "error" attribute.
static final String	A_ERROR_PAGE	The "errorPage" attribute.
static final String	A_EXCLUSIVE	The "exclusive" attribute.
static final String	A_OFFSET	The attribute name for the alias offset.
static final String	A_POSITION	The "position" attribute.
static final String	A_REDIRECT	The "redirect" attribute.
static final String	A_SERVER	The "server" attribute.
static final String	A_SSL	The ssl mode attribute.
static final String	A_SUBSITE_SELECTION	Attribute name for the subsiteSelection option.
static final String	A_TITLE	The "title" attribute.
static final String	A_USE_PERMANENT_REDIRECTS	The "usePermanentRedirects" attribute.
static final String	A_WEBSERVER	The "webserver" attribute.
static final String	CONFIGURATION_DTD_NAME	The name of the DTD for this configuration.
static final String	DEFAULT_XML_FILE_NAME	The name of the default XML file for this configuration.
static final String	N_ALIAS	The node name for the alias node.
static final String	N_DEFAULT_URI	The node name for the default-uri node.
static final String	N_OLD_STYLE_SECURE_SERVER	New secure modes node.
static final String	N_PARAMETERS	The node name for the parameters.
static final String	N_SECURE	The node name for the secure site.
static final String	N_SHARED_FOLDER	Shared folder node name.
static final String	N_SITES	The node name for the sites node.
static final String	N_WEBSERVERSCRIPTING	The node name which indicates if apache should be configurable in sitemanager.
static final String	N_WEBSERVERSCRIPTING_CONFIGTEMPLATE	Configuration node name.
static final String	N_WEBSERVERSCRIPTING_FILENAMEPREFIX	Configuration node name.
static final String	N_WEBSERVERSCRIPTING_LOGGINGDIR	Configuration node name.
static final String	N_WEBSERVERSCRIPTING_SECURETEMPLATE	Configuration node name.
static final String	N_WEBSERVERSCRIPTING_TARGETPATH	Configuration node name.
static final String	N_WEBSERVERSCRIPTING_WEBSERVERSCRIPT	Configuration node name.
static final String	N_WORKPLACE_SERVER	The node name for the workplace-server node.

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
CmsSitesConfiguration()

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.
String	getDtdFilename()	Returns the name of the DTD file for this XML configuration, e.g.
CmsSiteManagerImpl	getSiteManager()	Returns the site manager.
void	handleUpdate()	Called when OpenCms has written the configuration to the file system.
protected void	initMembers()	Initializes member variables.
void	setCmsObject(CmsObject cms)	Called during startup with a CmsObject with admin privileges.
void	setSiteManager(CmsSiteManagerImpl siteManager)	Sets the site manager.

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

Methods inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler

addConfigurationParameter, getConfiguration, initConfiguration

Methods inherited from interface org.opencms.configuration.I_CmsXmlConfiguration

getDtdSystemLocation, getDtdUrlPrefix, getXmlFileName

Field Details

A_ERROR

public static final String A_ERROR

The "error" attribute.

See Also:

• Constant Field Values

A_ERROR_PAGE

public static final String A_ERROR_PAGE

The "errorPage" attribute.

See Also:

• Constant Field Values

A_EXCLUSIVE

public static final String A_EXCLUSIVE

The "exclusive" attribute.

See Also:

• Constant Field Values

A_OFFSET

public static final String A_OFFSET

The attribute name for the alias offset.

See Also:

• Constant Field Values

A_POSITION

public static final String A_POSITION

The "position" attribute.

See Also:

• Constant Field Values

A_REDIRECT

public static final String A_REDIRECT

The "redirect" attribute.

See Also:

• Constant Field Values

A_SERVER

public static final String A_SERVER

The "server" attribute.

See Also:

• Constant Field Values

A_SSL

public static final String A_SSL

The ssl mode attribute.

See Also:

• Constant Field Values

A_SUBSITE_SELECTION

public static final String A_SUBSITE_SELECTION

Attribute name for the subsiteSelection option.

See Also:

• Constant Field Values

A_TITLE

public static final String A_TITLE

The "title" attribute.

See Also:

• Constant Field Values

A_USE_PERMANENT_REDIRECTS

public static final String A_USE_PERMANENT_REDIRECTS

The "usePermanentRedirects" attribute.

See Also:

• Constant Field Values

A_WEBSERVER

public static final String A_WEBSERVER

The "webserver" attribute.

See Also:

• Constant Field Values

CONFIGURATION_DTD_NAME

public static final String CONFIGURATION_DTD_NAME

The name of the DTD for this configuration.

See Also:

• Constant Field Values

DEFAULT_XML_FILE_NAME

public static final String DEFAULT_XML_FILE_NAME

The name of the default XML file for this configuration.

See Also:

• Constant Field Values

N_ALIAS

public static final String N_ALIAS

The node name for the alias node.

See Also:

• Constant Field Values

N_DEFAULT_URI

public static final String N_DEFAULT_URI

The node name for the default-uri node.

See Also:

• Constant Field Values

N_OLD_STYLE_SECURE_SERVER

public static final String N_OLD_STYLE_SECURE_SERVER

New secure modes node.

See Also:

• Constant Field Values

N_PARAMETERS

public static final String N_PARAMETERS

The node name for the parameters.

See Also:

• Constant Field Values

N_SECURE

public static final String N_SECURE

The node name for the secure site.

See Also:

• Constant Field Values

N_SHARED_FOLDER

public static final String N_SHARED_FOLDER

Shared folder node name.

See Also:

• Constant Field Values

N_SITES

public static final String N_SITES

The node name for the sites node.

See Also:

• Constant Field Values

N_WEBSERVERSCRIPTING

public static final String N_WEBSERVERSCRIPTING

The node name which indicates if apache should be configurable in sitemanager.

See Also:

• Constant Field Values

N_WEBSERVERSCRIPTING_CONFIGTEMPLATE

public static final String N_WEBSERVERSCRIPTING_CONFIGTEMPLATE

Configuration node name.

See Also:

• Constant Field Values

N_WEBSERVERSCRIPTING_FILENAMEPREFIX

public static final String N_WEBSERVERSCRIPTING_FILENAMEPREFIX

Configuration node name.

See Also:

• Constant Field Values

N_WEBSERVERSCRIPTING_LOGGINGDIR

public static final String N_WEBSERVERSCRIPTING_LOGGINGDIR

Configuration node name.

See Also:

• Constant Field Values

N_WEBSERVERSCRIPTING_SECURETEMPLATE

public static final String N_WEBSERVERSCRIPTING_SECURETEMPLATE

Configuration node name.

See Also:

• Constant Field Values

N_WEBSERVERSCRIPTING_TARGETPATH

public static final String N_WEBSERVERSCRIPTING_TARGETPATH

Configuration node name.

See Also:

• Constant Field Values

N_WEBSERVERSCRIPTING_WEBSERVERSCRIPT

public static final String N_WEBSERVERSCRIPTING_WEBSERVERSCRIPT

Configuration node name.

See Also:

• Constant Field Values

N_WORKPLACE_SERVER

public static final String N_WORKPLACE_SERVER

The node name for the workplace-server node.

See Also:

• Constant Field Values

Constructor Details

CmsSitesConfiguration

public CmsSitesConfiguration()

Method Details

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.

Specified by:

addXmlDigesterRules in interface I_CmsXmlConfiguration

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.

Specified by:

generateXml in interface I_CmsXmlConfiguration

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)

getDtdFilename

public String getDtdFilename()

Description copied from interface: I_CmsXmlConfiguration

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

Specified by:

getDtdFilename in interface I_CmsXmlConfiguration

Returns:

the name of the DTD file for this XML configuration

See Also:

• I_CmsXmlConfiguration.getDtdFilename()

getSiteManager

public CmsSiteManagerImpl getSiteManager()

Returns the site manager.

Returns:

the site manager

handleUpdate

public void handleUpdate()
                  throws Exception

Description copied from interface: I_CmsXmlConfigurationWithUpdateHandler

Called when OpenCms has written the configuration to the file system.

Specified by:

handleUpdate in interface I_CmsXmlConfigurationWithUpdateHandler

Throws:

Exception - if something goes wrong

See Also:

• I_CmsXmlConfigurationWithUpdateHandler.handleUpdate()

setCmsObject

public void setCmsObject(CmsObject cms)

Description copied from interface: I_CmsXmlConfigurationWithUpdateHandler

Called during startup with a CmsObject with admin privileges.

Specified by:

setCmsObject in interface I_CmsXmlConfigurationWithUpdateHandler

Parameters:

cms - the CMS context

See Also:

• I_CmsXmlConfigurationWithUpdateHandler.setCmsObject(org.opencms.file.CmsObject)

setSiteManager

public void setSiteManager(CmsSiteManagerImpl siteManager)

Sets the site manager.

Parameters:

siteManager - the site manager to set

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()