org.opencms.configuration

类 A_CmsXmlConfiguration

java.lang.Object

org.opencms.configuration.A_CmsXmlConfiguration

所有已实现的接口:

I_CmsConfigurationParameterHandler, I_CmsXmlConfiguration

直接已知子类:

CmsImportExportConfiguration, CmsModuleConfiguration, CmsSearchConfiguration, CmsSystemConfiguration, CmsVfsConfiguration, CmsWorkplaceConfiguration

public abstract class A_CmsXmlConfiguration
extends java.lang.Object
implements I_CmsXmlConfiguration

Abstract base implementation for xml configurations.

从以下版本开始:

6.0.0

字段概要

从接口继承的字段 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_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

从接口继承的字段 org.opencms.configuration.I_CmsConfigurationParameterHandler

ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD

构造器概要

构造器

构造器和说明
A_CmsXmlConfiguration() Constructor.

方法概要

方法

限定符和类型	方法和说明
void	addConfigurationParameter(java.lang.String paramName, java.lang.String paramValue) Adds a configuration parameter to this parameter configurable class instance.
CmsParameterConfiguration	getConfiguration() Returns the parameters of this configurable class instance, or null if the class does not need any parameters.
java.lang.String	getDtdSystemLocation() Returns the internal system location of the DTD file for this XML configuration, e.g.
java.lang.String	getDtdUrlPrefix() Returns the external system id prefix of the DTD file for this XML configuration, e.g.
java.lang.String	getXmlFileName() Returns the name of the XML input file for this configuration, e.g.
void	initConfiguration() Initializes a configuration after all parameters have been added.
protected abstract void	initMembers() Initializes member variables.
protected void	setXmlFileName(java.lang.String fileName) Sets the file name of this XML configuration.

从类继承的方法 java.lang.Object

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

从接口继承的方法 org.opencms.configuration.I_CmsXmlConfiguration

addXmlDigesterRules, generateXml, getDtdFilename

构造器详细资料

A_CmsXmlConfiguration

public A_CmsXmlConfiguration()

Constructor.

方法详细资料

addConfigurationParameter

public void addConfigurationParameter(java.lang.String paramName,
                             java.lang.String paramValue)

从接口复制的说明: I_CmsConfigurationParameterHandler

Adds a configuration parameter to this parameter configurable class instance.

指定者:

addConfigurationParameter 在接口中 I_CmsConfigurationParameterHandler

参数:

paramName - the name of the parameter

paramValue - the value for the parameter

另请参阅:

I_CmsConfigurationParameterHandler.addConfigurationParameter(java.lang.String, java.lang.String)

getConfiguration

public CmsParameterConfiguration getConfiguration()

从接口复制的说明: I_CmsConfigurationParameterHandler

Returns the parameters of this configurable class instance, or null if the class does not need any parameters.

指定者:

getConfiguration 在接口中 I_CmsConfigurationParameterHandler

返回:

the parameters of this configurable class instance, or null if the class does not need any parameters

另请参阅:

I_CmsConfigurationParameterHandler.getConfiguration()

getDtdSystemLocation

public java.lang.String getDtdSystemLocation()

从接口复制的说明: I_CmsXmlConfiguration

Returns the internal system location of the DTD file for this XML configuration, e.g. org/opencms/configuration/.

If this is not null, then the DTD is not read through the web URL, but an internal name resolution is added that resolves the system id of the DTD to I_CmsXmlConfiguration.getDtdSystemLocation() + I_CmsXmlConfiguration.getDtdUrlPrefix().

指定者:

getDtdSystemLocation 在接口中 I_CmsXmlConfiguration

返回:

the system location of the DTD file for this XML configuration

另请参阅:

I_CmsXmlConfiguration.getDtdSystemLocation()

getDtdUrlPrefix

public java.lang.String getDtdUrlPrefix()

从接口复制的说明: I_CmsXmlConfiguration

Returns the external system id prefix of the DTD file for this XML configuration, e.g. http://www.opencms.org/dtd/6.0/.

The full system id for the DTD is calculated like this: I_CmsXmlConfiguration.getDtdSystemLocation() + I_CmsXmlConfiguration.getDtdUrlPrefix().

指定者:

getDtdUrlPrefix 在接口中 I_CmsXmlConfiguration

返回:

the system id prefix of the DTD file for this XML configuration

另请参阅:

I_CmsXmlConfiguration.getDtdUrlPrefix()

getXmlFileName

public java.lang.String getXmlFileName()

从接口复制的说明: I_CmsXmlConfiguration

Returns the name of the XML input file for this configuration, e.g. opencms.xml.

指定者:

getXmlFileName 在接口中 I_CmsXmlConfiguration

返回:

the name of the XML input file for this configuration

另请参阅:

I_CmsXmlConfiguration.getXmlFileName()

initConfiguration

public void initConfiguration()

从接口复制的说明: I_CmsConfigurationParameterHandler

Initializes a configuration after all parameters have been added.

指定者:

initConfiguration 在接口中 I_CmsConfigurationParameterHandler

另请参阅:

I_CmsConfigurationParameterHandler.initConfiguration()

initMembers

protected abstract void initMembers()

Initializes member variables.

setXmlFileName

protected void setXmlFileName(java.lang.String fileName)

Sets the file name of this XML configuration.

参数:

fileName - the file name to set