org.opencms.configuration

接口 I_CmsConfigurationParameterHandler

所有已知子接口:

I_CmsCmisRepository, I_CmsDialogHandler, I_CmsDirectEditProvider, I_CmsPasswordHandler, I_CmsPreEditorActionDefinition, I_CmsRepository, I_CmsResourceLoader, I_CmsResourceType, I_CmsXmlConfiguration

所有已知实现类:

A_CmsCmisRepository, A_CmsDirectEditProvider, A_CmsPreEditorActionDefinition, A_CmsRepository, A_CmsResourceType, A_CmsResourceTypeFolderBase, A_CmsResourceTypeLinkParseable, A_CmsXmlConfiguration, CmsAdvancedDirectEditProvider, CmsCmisRepository, CmsConfigurationManager, CmsDefaultPasswordHandler, CmsDelete, CmsDialogProperty, CmsDirectEditDefaultProvider, CmsDirectEditJQueryProvider, CmsDirectEditJspIncludeProvider, CmsDirectEditTextButtonProvider, CmsDumpLoader, CmsGallerySearchIndex, CmsImageLoader, CmsImportExportConfiguration, CmsJlanRepository, CmsJspLoader, CmsLock, CmsModuleConfiguration, CmsPointerLoader, CmsPreEditorActionDefinitionXmlContent, CmsPropertyAdvanced, CmsPropertyCustom, CmsRecourceTypeFolderGallery, CmsRepository, CmsResourceTypeBinary, CmsResourceTypeFolder, CmsResourceTypeFolderExtended, CmsResourceTypeFolderSubSitemap, CmsResourceTypeImage, CmsResourceTypeJsp, CmsResourceTypePlain, CmsResourceTypePointer, CmsResourceTypeUnknown, CmsResourceTypeUnknownFile, CmsResourceTypeUnknownFolder, CmsResourceTypeXmlAdeConfiguration, CmsResourceTypeXmlContainerPage, CmsResourceTypeXmlContent, CmsResourceTypeXmlPage, CmsScheduledJobInfo, CmsSearchConfiguration, CmsSearchIndex, CmsSolrIndex, CmsSystemConfiguration, CmsToolbarDirectEditProvider, CmsVfsConfiguration, CmsWorkplaceConfiguration, CmsXmlContainerPageLoader, CmsXmlContentLoader, CmsXmlPageLoader

public interface I_CmsConfigurationParameterHandler

Used for classes that are configurable using <param name="name">value</param> in the XML configuration.

Such "param" nodes can be used to add some arbitrary names parameters to classes that otherwise share the same XML configuration.

从以下版本开始:

6.0.0

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	ADD_PARAMETER_METHOD The name of the addConfigurationParameter() method.
static java.lang.String	INIT_CONFIGURATION_METHOD The name of the initConfiguration() method.

方法概要

方法

限定符和类型	方法和说明
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.
void	initConfiguration() Initializes a configuration after all parameters have been added.

字段详细资料

ADD_PARAMETER_METHOD

static final java.lang.String ADD_PARAMETER_METHOD

The name of the addConfigurationParameter() method.

另请参阅:

常量字段值

INIT_CONFIGURATION_METHOD

static final java.lang.String INIT_CONFIGURATION_METHOD

The name of the initConfiguration() method.

另请参阅:

常量字段值

方法详细资料

addConfigurationParameter

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

Adds a configuration parameter to this parameter configurable class instance.

参数:

paramName - the name of the parameter

paramValue - the value for the parameter

getConfiguration

CmsParameterConfiguration getConfiguration()

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

返回:

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

initConfiguration

void initConfiguration()
                       throws CmsConfigurationException

Initializes a configuration after all parameters have been added.

抛出:

CmsConfigurationException - if something goes wrong