Package org.opencms.configuration
Interface I_CmsConfigurationParameterHandler
-
- All Known Subinterfaces:
I_CmsCmisRepository
,I_CmsDetailPageHandler
,I_CmsDialogHandler
,I_CmsDirectEditProvider
,I_CmsJsonRendererXmlContent
,I_CmsPasswordHandler
,I_CmsPreEditorActionDefinition
,I_CmsRepository
,I_CmsResourceLoader
,I_CmsResourceType
,I_CmsSearchIndex
,I_CmsTextEncryption
,I_CmsUploadRestriction
,I_CmsUserDataDomain
,I_CmsXmlConfiguration
,I_CmsXmlConfigurationWithUpdateHandler
- All Known Implementing Classes:
A_CmsCmisRepository
,A_CmsDirectEditProvider
,A_CmsPreEditorActionDefinition
,A_CmsRepository
,A_CmsResourceType
,A_CmsResourceTypeFolderBase
,A_CmsResourceTypeLinkParseable
,A_CmsSearchIndex
,A_CmsXmlConfiguration
,CmsAdditionalLogFolderConfig
,CmsAdvancedDirectEditProvider
,CmsAdvancedPasswordHandler
,CmsAESTextEncryption
,CmsCmisRepository
,CmsConfigurationManager
,CmsDefaultDetailPageHandler
,CmsDefaultPasswordHandler
,CmsDefaultUploadRestriction
,CmsDefaultUserDataDomain
,CmsDirectEditDefaultProvider
,CmsDirectEditJQueryProvider
,CmsDirectEditJspIncludeProvider
,CmsDirectEditTextButtonProvider
,CmsDumpLoader
,CmsImageLoader
,CmsImportExportConfiguration
,CmsJlanRepository
,CmsJsonRendererXmlContent
,CmsJspLoader
,CmsLetsEncryptConfiguration
,CmsMacroFormatterLoader
,CmsModuleConfiguration
,CmsPermissiveDetailPageHandler
,CmsPointerLoader
,CmsPreEditorActionDefinitionXmlContent
,CmsProtectedStaticFileHandler
,CmsRedirectLoader
,CmsRepository
,CmsResourceTypeBinary
,CmsResourceTypeFolder
,CmsResourceTypeFolderExtended
,CmsResourceTypeFolderSubSitemap
,CmsResourceTypeFunctionConfig
,CmsResourceTypeHtmlRedirect
,CmsResourceTypeImage
,CmsResourceTypeJsp
,CmsResourceTypeLocaleIndependentXmlContent
,CmsResourceTypeMacroFormatter
,CmsResourceTypePlain
,CmsResourceTypePointer
,CmsResourceTypeSeoFile
,CmsResourceTypeSubsitemapContentFolder
,CmsResourceTypeUnknown
,CmsResourceTypeUnknownFile
,CmsResourceTypeUnknownFolder
,CmsResourceTypeXmlAdeConfiguration
,CmsResourceTypeXmlContainerPage
,CmsResourceTypeXmlContent
,CmsResourceTypeXmlPage
,CmsScheduledJobInfo
,CmsSchedulerConfiguration
,CmsSearchConfiguration
,CmsSearchIndex
,CmsSeoFileLoader
,CmsSitesConfiguration
,CmsSolrIndex
,CmsSystemConfiguration
,CmsToolbarDirectEditProvider
,CmsUserDataHeader
,CmsVariablesConfiguration
,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.
- Since:
- 6.0.0
-
-
Field Summary
Fields Modifier and Type Field Description 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.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description 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, ornull
if the class does not need any parameters.void
initConfiguration()
Initializes a configuration after all parameters have been added.
-
-
-
Field Detail
-
ADD_PARAMETER_METHOD
static final java.lang.String ADD_PARAMETER_METHOD
The name of the addConfigurationParameter() method.- See Also:
- Constant Field Values
-
INIT_CONFIGURATION_METHOD
static final java.lang.String INIT_CONFIGURATION_METHOD
The name of the initConfiguration() method.- See Also:
- Constant Field Values
-
-
Method Detail
-
addConfigurationParameter
void addConfigurationParameter(java.lang.String paramName, java.lang.String paramValue)
Adds a configuration parameter to this parameter configurable class instance.- Parameters:
paramName
- the name of the parameterparamValue
- the value for the parameter
-
getConfiguration
CmsParameterConfiguration getConfiguration()
Returns the parameters of this configurable class instance, ornull
if the class does not need any parameters.- Returns:
- 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.- Throws:
CmsConfigurationException
- if something goes wrong
-
-