Package org.opencms.module

Class CmsModuleXmlHandler

java.lang.Object

org.opencms.module.CmsModuleXmlHandler

public class CmsModuleXmlHandler
extends Object

Adds the XML handler rules for import and export of a single module.

Since:

6.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	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.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	A_NAME	The "name" attribute.
static final String	A_VERSION	The "version" attribute.
static final String	N_AUTHOREMAIL	The node name for the authoremail node.
static final String	N_AUTHORNAME	The node name for the authorname node.
static final String	N_AUTOINCREMENT	The node name for the auto increment mode.
static final String	N_CHECKPOINT_TIME	The node name for the checkpoint time.
static final String	N_CLASS	The node name for the class node.
static final String	N_DATECREATED	The node name for the datecreated node.
static final String	N_DATEINSTALLED	The node name for the date installed node.
static final String	N_DEPENDENCIES	The node name for the dependencies node.
static final String	N_DEPENDENCY	The node name for the dependency node.
static final String	N_DESCRIPTION	The node name for the description node.
static final String	N_EXCLUDERESOURCES	The node name for the resources node.
static final String	N_EXPORT_MODE	The node name for the import site.
static final String	N_GROUP	The node name for the group node.
static final String	N_IMPORT_SCRIPT	Node for the import script.
static final String	N_MODULE	The node name for a module.
static final String	N_NAME	The node name for the name node.
static final String	N_NICENAME	The node name for the nicename node.
static final String	N_PARAM	The "param" node name for generic parameters.
static final String	N_PARAMETERS	The node name for the parameters node.
static final String	N_RESOURCES	The node name for the resources node.
static final String	N_SITE	The node name for the module site.
static final String	N_USERINSTALLED	The node name for the user installed node.
static final String	N_VERSION	The node name for the version node.

Constructor Summary

Constructors

Constructor	Description
CmsModuleXmlHandler()	Public constructor, will be called by digester during import.

Method Summary

Modifier and Type	Method	Description
void	addDependency(String name, String version)	Adds a module dependency to the current module.
void	addExcludeResource(String resource)	Adds a resource to the list module resources.
void	addExplorerTypeSetting(CmsExplorerTypeSettings settings)	Adds an explorer type setting object to the list of type settings.
void	addExportPoint(String uri, String destination)	Adds an export point to the module configuration.
void	addParameter(String key, String value)	Adds a module parameter to the module configuration.
void	addResource(String resource)	Adds a resource to the list module resources.
void	addResourceType(I_CmsResourceType resourceType)	Adds a new resource type to the internal list of loaded resource types.
static void	addXmlDigesterRules(org.apache.commons.digester3.Digester digester)	Adds the XML digester rules for a single module.
void	createdModule(String name, String niceName, String group, String actionClass, String importScript, String importSite, String site, String exportModeName, String description, String version, String authorName, String authorEmail, String dateCreated, String userInstalled, String dateInstalled)	Created a new module from the provided parameters.
static org.dom4j.Element	generateXml(CmsModule module, CmsModuleXmlHandler.XmlWriteMode writeMode)	Generates a detached XML element for a module.
CmsModule	getModule()	Returns the generated module.
static String	makeValidJavaClassName(String className)	Generates a (hopefully) valid Java class name from an invalid class name.
void	setAutoIncrement(boolean autoincrement)	Sets the auto-increment mode.
void	setCheckpointTime(long time)	Sets the checkpoint time.
void	setOldModule()	Sets the current imported module to an old (5.0.x) style module.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

A_NAME

public static final String A_NAME

The "name" attribute.

See Also:

• Constant Field Values

A_VERSION

public static final String A_VERSION

The "version" attribute.

See Also:

• Constant Field Values

N_AUTHOREMAIL

public static final String N_AUTHOREMAIL

The node name for the authoremail node.

See Also:

• Constant Field Values

N_AUTHORNAME

public static final String N_AUTHORNAME

The node name for the authorname node.

See Also:

• Constant Field Values

N_AUTOINCREMENT

public static final String N_AUTOINCREMENT

The node name for the auto increment mode.

See Also:

• Constant Field Values

N_CHECKPOINT_TIME

public static final String N_CHECKPOINT_TIME

The node name for the checkpoint time.

See Also:

• Constant Field Values

N_CLASS

public static final String N_CLASS

The node name for the class node.

See Also:

• Constant Field Values

N_DATECREATED

public static final String N_DATECREATED

The node name for the datecreated node.

See Also:

• Constant Field Values

N_DATEINSTALLED

public static final String N_DATEINSTALLED

The node name for the date installed node.

See Also:

• Constant Field Values

N_DEPENDENCIES

public static final String N_DEPENDENCIES

The node name for the dependencies node.

See Also:

• Constant Field Values

N_DEPENDENCY

public static final String N_DEPENDENCY

The node name for the dependency node.

See Also:

• Constant Field Values

N_DESCRIPTION

public static final String N_DESCRIPTION

The node name for the description node.

See Also:

• Constant Field Values

N_EXCLUDERESOURCES

public static final String N_EXCLUDERESOURCES

The node name for the resources node.

See Also:

• Constant Field Values

N_EXPORT_MODE

public static final String N_EXPORT_MODE

The node name for the import site.

See Also:

• Constant Field Values

N_GROUP

public static final String N_GROUP

The node name for the group node.

See Also:

• Constant Field Values

N_IMPORT_SCRIPT

public static final String N_IMPORT_SCRIPT

Node for the import script.

See Also:

• Constant Field Values

N_MODULE

public static final String N_MODULE

The node name for a module.

See Also:

• Constant Field Values

N_NAME

public static final String N_NAME

The node name for the name node.

See Also:

• Constant Field Values

N_NICENAME

public static final String N_NICENAME

The node name for the nicename node.

See Also:

• Constant Field Values

N_PARAM

public static final String N_PARAM

The "param" node name for generic parameters.

See Also:

• Constant Field Values

N_PARAMETERS

public static final String N_PARAMETERS

The node name for the parameters node.

See Also:

• Constant Field Values

N_RESOURCES

public static final String N_RESOURCES

The node name for the resources node.

See Also:

• Constant Field Values

N_SITE

public static final String N_SITE

The node name for the module site.

See Also:

• Constant Field Values

N_USERINSTALLED

public static final String N_USERINSTALLED

The node name for the user installed node.

See Also:

• Constant Field Values

N_VERSION

public static final String N_VERSION

The node name for the version node.

See Also:

• Constant Field Values

Constructor Details

CmsModuleXmlHandler

public CmsModuleXmlHandler()

Public constructor, will be called by digester during import.

Method Details

addXmlDigesterRules

public static void addXmlDigesterRules(org.apache.commons.digester3.Digester digester)

Adds the XML digester rules for a single module.

Parameters:

digester - the digester to add the rules to

generateXml

public static org.dom4j.Element generateXml(CmsModule module,
 CmsModuleXmlHandler.XmlWriteMode writeMode)

Generates a detached XML element for a module.

Parameters:

module - the module to generate the XML element for

writeMode - enum value representing the context for which we are generating the XML

Returns:

the detached XML element for the module

makeValidJavaClassName

public static String makeValidJavaClassName(String className)

Generates a (hopefully) valid Java class name from an invalid class name.

All invalid characters are replaced by an underscore "_". This is for example used to make sure old (5.0) modules can still be imported, by converting the name to a valid class name.

Parameters:

className - the class name to make valid

Returns:

a valid Java class name from an invalid class name

addDependency

public void addDependency(String name,
 String version)

Adds a module dependency to the current module.

Parameters:

name - the module name of the dependency

version - the module version of the dependency

addExcludeResource

public void addExcludeResource(String resource)

Adds a resource to the list module resources.

Parameters:

resource - a resources uri in the OpenCms VFS

addExplorerTypeSetting

public void addExplorerTypeSetting(CmsExplorerTypeSettings settings)

Adds an explorer type setting object to the list of type settings.

Adds the type setting as well to a map with the resource type name as key.

Parameters:

settings - the explorer type settings

addExportPoint

public void addExportPoint(String uri,
 String destination)

Adds an export point to the module configuration.

Parameters:

uri - the export point uri

destination - the export point destination

addParameter

public void addParameter(String key,
 String value)

Adds a module parameter to the module configuration.

Parameters:

key - the parameter key

value - the parameter value

addResource

public void addResource(String resource)

Adds a resource to the list module resources.

Parameters:

resource - a resources uri in the OpenCms VFS

addResourceType

public void addResourceType(I_CmsResourceType resourceType)

Adds a new resource type to the internal list of loaded resource types.

Parameters:

resourceType - the resource type to add

See Also:

• I_CmsResourceType.ADD_RESOURCE_TYPE_METHOD

createdModule

public void createdModule(String name,
 String niceName,
 String group,
 String actionClass,
 String importScript,
 String importSite,
 String site,
 String exportModeName,
 String description,
 String version,
 String authorName,
 String authorEmail,
 String dateCreated,
 String userInstalled,
 String dateInstalled)

Created a new module from the provided parameters.

Parameters:

name - the name of this module, usually looks like a java package name

niceName - the "nice" display name of this module

group - the group of the module

actionClass - the (optional) module action class name

importScript - the import script

importSite - the import site (only one of importSite and site is not null)

site - the module site

exportModeName - the export mode name

description - the description of this module

version - the version of this module

authorName - the name of the author of this module

authorEmail - the email of the module author

dateCreated - the date this module was created by the author

userInstalled - the name of the user who uploaded this module

dateInstalled - the date this module was uploaded

getModule

public CmsModule getModule()

Returns the generated module.

Returns:

the generated module

setAutoIncrement

public void setAutoIncrement(boolean autoincrement)

Sets the auto-increment mode.

Parameters:

autoincrement - true if version auto-incrementation should be enabled

setCheckpointTime

public void setCheckpointTime(long time)

Sets the checkpoint time.

Parameters:

time - the checkpoint time

setOldModule

public void setOldModule()

Sets the current imported module to an old (5.0.x) style module.