Package org.opencms.module

OpenCms modules provide a powerful, standardized way to extend the core OpenCms functionality.

OpenCms modules provide a standard mechanism to extend the OpenCms functionality. Modules can contain VFS data, Java classes and a number of configuration options.

Since:

6.0.0

Interface Summary

Interface	Description
I_CmsModuleAction	Module action classes in OpenCms must implement this interface.

Class Summary

Class	Description
A_CmsModuleAction	Simple base implementation of the I_CmsModuleAction interface, extend this class for more sophisticated module action implementations.
CmsModule	Describes an OpenCms module.
CmsModuleDependency	Describes an OpenCms module dependency.
CmsModuleImportData	Module data read from a module zip file.
CmsModuleImportExportHandler	Import/export handler implementation for Cms modules.
CmsModuleImportExportRepository	Class which manages import/export of modules from repositories configured in opencms-importexport.xml.
CmsModuleImportExportRepository.ModuleExportData	Holds exported module data and a modification date.
CmsModuleLog	This class is responsible for reading and writing module import/export log messages, to be used by CmsResourceWrapperModules.
CmsModuleManager	Manages the modules of an OpenCms installation.
CmsModuleUpdater	Class used for updating modules.
CmsModuleVersion	A version number for an OpenCms module.
CmsModuleXmlHandler	Adds the XML handler rules for import and export of a single module.
CmsReplaceModuleInfo	Status after updating a module.
CmsResourceImportData	Import data for a single resource.
Messages	Convenience class to access the localized messages of this OpenCms package.

Enum Summary

Enum	Description
CmsModule.ExportMode	The available module export modes.
CmsModuleLog.Action	Action type.
CmsModuleXmlHandler.XmlWriteMode	Enum used to distinguish whether we want to generate the XML for a module export's manifest or the XML for writing back opencms-modules.xml.