Package | Description |
---|---|
org.opencms.module |
OpenCms modules provide a powerful, standardized way to extend
the core OpenCms functionality.
|
org.opencms.search.solr.spellchecking |
Contains the SOLR based spellcheck service classes.
|
org.opencms.ugc | |
org.opencms.workplace |
The base classes for the OpenCms Workplace
(standard dialog, tab dialog, report based dialog)
and the Workplace configuration classes are located here.
|
Modifier and Type | Method and Description |
---|---|
CmsModule |
CmsModuleXmlHandler.getModule()
Returns the generated module.
|
CmsModule |
CmsModuleManager.getModule(java.lang.String name)
Returns the module with the given module name,
or
null if no module with the given name is configured. |
static CmsModule |
CmsModuleImportExportHandler.readModuleFromImport(java.lang.String importResource)
Reads a module object from an external file source.
|
Modifier and Type | Method and Description |
---|---|
java.util.List<CmsModule> |
CmsModuleManager.getAllInstalledModules()
Returns a list of installed modules.
|
static java.util.Map<CmsModule,java.lang.String> |
CmsModuleManager.getAllModulesFromPath(java.lang.String rfsAbsPath)
Returns a map of modules found in the given RFS absolute path.
|
Modifier and Type | Method and Description |
---|---|
void |
CmsModuleManager.addModule(CmsObject cms,
CmsModule module)
Adds a new module to the module manager.
|
static java.util.List<java.lang.String> |
CmsModule.calculateModuleResourceNames(CmsObject cms,
CmsModule module)
Calculates the resources belonging to the module, taking excluded resources and readability of resources into account,
and returns site paths of the module resources.
|
static java.util.List<CmsResource> |
CmsModule.calculateModuleResources(CmsObject cms,
CmsModule module)
Calculates and returns the resources belonging to the module, taking excluded resources and readability of resources into account.
|
java.util.List<CmsModuleDependency> |
CmsModuleManager.checkDependencies(CmsModule module,
int mode)
Checks if a modules dependencies are fulfilled.
|
CmsModuleDependency |
CmsModule.checkDependency(CmsModule module)
Checks if this module depends on another given module,
will return the dependency, or
null if no dependency was found. |
int |
CmsModule.compareTo(CmsModule obj) |
static org.dom4j.Element |
CmsModuleXmlHandler.generateXml(CmsModule module)
Generates a detached XML element for a module.
|
static CmsModuleImportExportHandler |
CmsModuleImportExportHandler.getExportHandler(CmsObject cms,
CmsModule module,
java.lang.String handlerDescription)
Gets the module export handler containing all resources used in the module export.
|
void |
A_CmsModuleAction.initialize(CmsObject adminCms,
CmsConfigurationManager configurationManager,
CmsModule module) |
void |
I_CmsModuleAction.initialize(CmsObject adminCms,
CmsConfigurationManager configurationManager,
CmsModule module)
Will be called by the OpenCms system during server startup.
|
boolean |
CmsModule.isIdentical(CmsModule other)
Checks if this module is identical with another module.
|
void |
A_CmsModuleAction.moduleUninstall(CmsModule module) |
void |
I_CmsModuleAction.moduleUninstall(CmsModule module)
Will be called if a module is uninstalled from an OpenCms system.
|
void |
A_CmsModuleAction.moduleUpdate(CmsModule module) |
void |
I_CmsModuleAction.moduleUpdate(CmsModule module)
Will be called if the module this action instance belongs to is updated.
|
void |
A_CmsModuleAction.shutDown(CmsModule module) |
void |
I_CmsModuleAction.shutDown(CmsModule module)
Will be called by the OpenCms system during server shutdown.
|
void |
CmsModuleManager.updateModule(CmsObject cms,
CmsModule module)
Updates a already configured module with new values.
|
Constructor and Description |
---|
CmsModuleManager(java.util.List<CmsModule> configuredModules)
Basic constructor.
|
Modifier and Type | Method and Description |
---|---|
void |
CmsSpellcheckingModuleAction.initialize(CmsObject adminCms,
CmsConfigurationManager configurationManager,
CmsModule module) |
void |
CmsSpellcheckingModuleAction.moduleUninstall(CmsModule module) |
void |
CmsSpellcheckingModuleAction.moduleUpdate(CmsModule module) |
void |
CmsSpellcheckingModuleAction.shutDown(CmsModule module) |
Modifier and Type | Method and Description |
---|---|
void |
CmsUgcModuleAction.initialize(CmsObject adminCms,
CmsConfigurationManager configurationManager,
CmsModule module) |
void |
CmsUgcModuleAction.moduleUninstall(CmsModule module) |
void |
CmsUgcModuleAction.moduleUpdate(CmsModule module) |
void |
CmsUgcModuleAction.shutDown(CmsModule module) |
Modifier and Type | Method and Description |
---|---|
void |
CmsWorkplaceManager.addExplorerTypeSettings(CmsModule module)
Adds the list of explorer type settings from the given module.
|
void |
CmsWorkplaceAction.initialize(CmsObject adminCms,
CmsConfigurationManager configurationManager,
CmsModule module) |
void |
CmsWorkplaceManager.removeExplorerTypeSettings(CmsModule module)
Removes the list of explorer type settings from the given module.
|