Package org.opencms.configuration
Interface I_CmsXmlConfigurationWithUpdateHandler
-
- All Superinterfaces:
I_CmsConfigurationParameterHandler
,I_CmsXmlConfiguration
- All Known Implementing Classes:
CmsSitesConfiguration
public interface I_CmsXmlConfigurationWithUpdateHandler extends I_CmsXmlConfiguration
Interface for configurations which should run custom logic when the configuration is written back by OpenCms.
-
-
Field Summary
-
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
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
handleUpdate()
Called when OpenCms has written the configuration to the file system.void
setCmsObject(CmsObject cms)
Called during startup with a CmsObject with admin privileges.-
Methods inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler
addConfigurationParameter, getConfiguration, initConfiguration
-
Methods inherited from interface org.opencms.configuration.I_CmsXmlConfiguration
addXmlDigesterRules, generateXml, getDtdFilename, getDtdSystemLocation, getDtdUrlPrefix, getXmlFileName
-
-
-
-
Method Detail
-
handleUpdate
void handleUpdate() throws java.lang.Exception
Called when OpenCms has written the configuration to the file system.- Throws:
java.lang.Exception
- if something goes wrong
-
setCmsObject
void setCmsObject(CmsObject cms)
Called during startup with a CmsObject with admin privileges.- Parameters:
cms
- the CMS context
-
-