org.opencms.configuration
Class CmsWorkplaceConfiguration

java.lang.Object
  org.opencms.configuration.A_CmsXmlConfiguration
      org.opencms.configuration.CmsWorkplaceConfiguration

All Implemented Interfaces:

I_CmsConfigurationParameterHandler, I_CmsXmlConfiguration

public class CmsWorkplaceConfiguration
extends A_CmsXmlConfiguration
implements I_CmsXmlConfiguration

Import/Export master configuration class.

Since:

6.0.0

Version:

$Revision: 1.39 $

Author:

Alexander Kandzior

Field Summary

static String	A_AUTOSETNAVIGATION The "autosetnavigation" attribute.
static String	A_AUTOSETTITLE The "autosettitle" attribute.
static String	A_PAGE The "page" attribute.
static String	A_PERMISSIONS The "permissions" attribute.
static String	A_PRINCIPAL The "principal" attribute.
static String	A_REFERENCE The "reference" attribute.
static String	A_RULES The "rules" attribute.
static String	A_SHOWNAVIGATION The "shownavigation" attribute.
static String	A_TARGET The "target" attribute.
static String	N_ACCESSCONTROL The name of the access control node.
static String	N_ACCESSENTRY The name of the access entry node.
protected static String	N_AUTOLOCK The name of the autolock node.
static String	N_BUTTONSTYLE The node name of the buttonstyle node.
static String	N_CONTEXTMENU The name of the context menu node.
protected static String	N_DATECREATED The node name of the datecreated column node.
protected static String	N_DATEEXPIRED The node name of the date expired column node.
protected static String	N_DATELASTMODIFIED The node name of the datelastmodified column node.
protected static String	N_DATERELEASED The node name of the date released column node.
protected static String	N_DEFAULTACCESSCONTROL The name of the default access control node.
protected static String	N_DEFAULTLOCALE The name of the node for the default locale.
static String	N_DEFAULTPROPERTIES The name of the default properties node.
protected static String	N_DEFAULTPROPERTIESONSTRUCTURE The name of the default properties on structure node.
static String	N_DEFAULTPROPERTY The name of the default property node.
protected static String	N_DIALOGHANDLER Individual workplace handler node name.
protected static String	N_DIALOGHANDLERS The main workplace handler node name.
static String	N_DIALOGSDEFAULTSETTINGS The node name of the dialogs defaultsettings node.
protected static String	N_DIALOGSPREFERENCES The node name of the dialogs preferences node.
static String	N_DIRECTEDITSTYLE The node name of the directedit style node.
static String	N_DIRECTPUBLISH The node name of the directpublish node.
static String	N_EDITOPTIONS The name of the edit options node.
static String	N_EDITOR The node name of the editor node.
protected static String	N_EDITORACTION The name of the editor action node.
static String	N_EDITORGENERALOPTIONS The node name of the editors general options node.
protected static String	N_EDITORHANDLER The name of the editor handler node.
protected static String	N_EDITORPREFERENCES The node name of the editors preferences node.
static String	N_EDITORPREFERREDEDITORS The node name of the editors preferred editors node.
protected static String	N_ENABLEADVANCEDPROPERTYTABS The name of the "enable advanced property tabs" node.
static String	N_ENABLED The subname of the rfsfilesettings/enabled node.
protected static String	N_ENABLEUSERMGMT The name of the "user management enabled" node.
static String	N_ENTRIES The node name of the file entries node.
static String	N_ENTRY The name of the entry node.
static String	N_EXPANDPERMISSIONSINHERITED The name of the expand inherited permissions node.
static String	N_EXPANDPERMISSIONSUSER The name of the expand user permissions node.
static String	N_EXPLORERDISPLAYOPTIONS The node name of the explorer displayoptions node.
static String	N_EXPLORERGENERALOPTIONS The node name of the explorer generaloptions node.
protected static String	N_EXPLORERPREFERENCES The node name of the explorer preferences node.
static String	N_EXPLORERTYPE The name of the explorer type node.
static String	N_EXPLORERTYPES The name of the explorer types node.
static String	N_FILECOPY The node name of the file copy node.
static String	N_FILEDELETION The node name of the file deletion node.
static String	N_FILEENCODING The subname of the rfsfilesettings/fileEncoding node.
static String	N_FILEPATH The subname of the rfsfilesettings/filePath node.
static String	N_FOLDER The node name of the start folder node.
static String	N_FOLDERCOPY The node name of the folder copy node.
static String	N_INFORMROLEMEMBERS The node name of the inform role members node.
static String	N_ISLOGFILE The subname of the rfsfilesettings/isLogfile node.
protected static String	N_LABELEDFOLDERS The name of the "labeled folders" node.
static String	N_LOCALE The node name of the locale node.
protected static String	N_LOCALIZEDFOLDERS The name of the "localized folders" node.
protected static String	N_LOCKEDBY The node name of the lockedby column node.
protected static String	N_MAXUPLOADSIZE The name of the "max file upload size" node.
static String	N_MESSAGEACCEPTED The node name of the message-accepted node.
static String	N_MESSAGECOMPLETED The node name of the message-completed node.
static String	N_MESSAGEFORWARDED The node name of the message-forwarded node.
static String	N_NEWRESOURCE The name of the new resource node.
protected static String	N_PERMISSIONS The node name of the permissions column node.
static String	N_PERMISSIONSINHERITONFOLDER The name of the inherit permissions on folder node.
static String	N_PROJECT The node name of the project node.
static String	N_REPORTTYPE The node name of the report type node.
static String	N_RESTRICTEXPLORERVIEW The node name of the restrict explorer view node.
static String	N_RFSFILEVIEWESETTINGS The node name of the rfsfileviewsettings node.
static String	N_SEPARATOR The name of the separator node.
static String	N_SHOWEXPORTSETTINGS The node name of the show lock node.
static String	N_SHOWLOCK The node name of the show lock node.
static String	N_SHOWMESSAGES The node name of the show messages node.
static String	N_SHOWPROJECTS The node name of the showprojects node.
protected static String	N_SIZE The node name of the size column node.
static String	N_STARTUPFILTER The node name of the startupfilter node.
protected static String	N_STATE The node name of the state column node.
protected static String	N_TITLE The node name of the title column node.
protected static String	N_TYPE The node name of the type column node.
static String	N_UPLOADAPPLET The node name of the uploadapplet node.
protected static String	N_USER The node name of the default preferences node.
protected static String	N_USERCREATED The node name of the user created node.
protected static String	N_USERLASTMODIFIED The node name of the user lastmodified node.
static String	N_WINDOWSIZE The subname of the rfsfilesettings/windowSize node.
static String	N_WORKFLOW The node name of the workflow node.
static String	N_WORKFLOWDEFAULTSETTINGS The node name of the workflow default settings node.
static String	N_WORKFLOWGENERALOPTIONS The node name of the workflow general options node.
protected static String	N_WORKFLOWPREFERENCES The node name of the workflow preferences node.
protected static String	N_WORKPLACE The node name of the master workplace node.
static String	N_WORKPLACEGENERALOPTIONS The node name of the workplace general options node.
protected static String	N_WORKPLACEPREFERENCES The node name of the workplace preferences node.
static String	N_WORKPLACESTARTUPSETTINGS The node name of the workplace startup settings node.
static String	N_WORKPLACEVIEW The node name of the view node.

Fields inherited from interface org.opencms.configuration.I_CmsXmlConfiguration

A_ALIAS, A_CLASS, A_COUNT, A_DESTINATION, A_ENABLED, A_FROM, A_HANDLER, A_ICON, A_ID, A_KEY, A_NAME, A_ORDER, A_PASSWORD, 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

Fields inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler

ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD

Constructor Summary

CmsWorkplaceConfiguration()
Public constructor, will be called by configuration manager.

Method Summary

static void	addExplorerTypeXmlRules(Digester digester) Adds the explorer type rules to the given digester.
void	addXmlDigesterRules(Digester digester) Digests an XML node and creates an instance of this configurable class.
static void	generateExplorerTypesXml(Element startNode, List explorerTypes, boolean module) Creates the xml output for explorer type nodes.
Element	generateXml(Element parent) Generates the XML element for this configurable class.
String	getDtdFilename() Returns the name of the DTD file for this XML configuration, e.g.
CmsWorkplaceManager	getWorkplaceManager() Returns the initialized workplace manager.
void	initializeFinished() Will be called when configuration of this object is finished.
void	setWorkplaceManager(CmsWorkplaceManager manager) Sets the generated workplace manager.

Methods inherited from class org.opencms.configuration.A_CmsXmlConfiguration

addConfigurationParameter, getConfiguration, getDtdSystemLocation, getDtdUrlPrefix, getXmlFileName, initConfiguration, setXmlFileName

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opencms.configuration.I_CmsXmlConfiguration

getDtdSystemLocation, getDtdUrlPrefix, getXmlFileName

Methods inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler

addConfigurationParameter, getConfiguration, initConfiguration

Field Detail

A_AUTOSETNAVIGATION

public static final String A_AUTOSETNAVIGATION

The "autosetnavigation" attribute.

See Also:

Constant Field Values

A_AUTOSETTITLE

public static final String A_AUTOSETTITLE

The "autosettitle" attribute.

See Also:

Constant Field Values

A_PAGE

public static final String A_PAGE

The "page" attribute.

See Also:

Constant Field Values

A_PERMISSIONS

public static final String A_PERMISSIONS

The "permissions" attribute.

See Also:

Constant Field Values

A_PRINCIPAL

public static final String A_PRINCIPAL

The "principal" attribute.

See Also:

Constant Field Values

A_REFERENCE

public static final String A_REFERENCE

The "reference" attribute.

See Also:

Constant Field Values

A_RULES

public static final String A_RULES

The "rules" attribute.

See Also:

Constant Field Values

A_SHOWNAVIGATION

public static final String A_SHOWNAVIGATION

The "shownavigation" attribute.

See Also:

Constant Field Values

A_TARGET

public static final String A_TARGET

The "target" attribute.

See Also:

Constant Field Values

N_ACCESSCONTROL

public static final String N_ACCESSCONTROL

The name of the access control node.

See Also:

Constant Field Values

N_ACCESSENTRY

public static final String N_ACCESSENTRY

The name of the access entry node.

See Also:

Constant Field Values

N_BUTTONSTYLE

public static final String N_BUTTONSTYLE

The node name of the buttonstyle node.

See Also:

Constant Field Values

N_CONTEXTMENU

public static final String N_CONTEXTMENU

The name of the context menu node.

See Also:

Constant Field Values

N_DEFAULTPROPERTIES

public static final String N_DEFAULTPROPERTIES

The name of the default properties node.

See Also:

Constant Field Values

N_DEFAULTPROPERTY

public static final String N_DEFAULTPROPERTY

The name of the default property node.

See Also:

Constant Field Values

N_DIALOGSDEFAULTSETTINGS

public static final String N_DIALOGSDEFAULTSETTINGS

The node name of the dialogs defaultsettings node.

See Also:

Constant Field Values

N_DIRECTEDITSTYLE

public static final String N_DIRECTEDITSTYLE

The node name of the directedit style node.

See Also:

Constant Field Values

N_DIRECTPUBLISH

public static final String N_DIRECTPUBLISH

The node name of the directpublish node.

See Also:

Constant Field Values

N_EDITOPTIONS

public static final String N_EDITOPTIONS

The name of the edit options node.

See Also:

Constant Field Values

N_EDITOR

public static final String N_EDITOR

The node name of the editor node.

See Also:

Constant Field Values

N_EDITORGENERALOPTIONS

public static final String N_EDITORGENERALOPTIONS

The node name of the editors general options node.

See Also:

Constant Field Values

N_EDITORPREFERREDEDITORS

public static final String N_EDITORPREFERREDEDITORS

The node name of the editors preferred editors node.

See Also:

Constant Field Values

N_ENABLED

public static final String N_ENABLED

The subname of the rfsfilesettings/enabled node.

See Also:

Constant Field Values

N_ENTRIES

public static final String N_ENTRIES

The node name of the file entries node.

See Also:

Constant Field Values

N_ENTRY

public static final String N_ENTRY

The name of the entry node.

See Also:

Constant Field Values

N_EXPANDPERMISSIONSINHERITED

public static final String N_EXPANDPERMISSIONSINHERITED

The name of the expand inherited permissions node.

See Also:

Constant Field Values

N_EXPANDPERMISSIONSUSER

public static final String N_EXPANDPERMISSIONSUSER

The name of the expand user permissions node.

See Also:

Constant Field Values

N_EXPLORERDISPLAYOPTIONS

public static final String N_EXPLORERDISPLAYOPTIONS

The node name of the explorer displayoptions node.

See Also:

Constant Field Values

N_EXPLORERGENERALOPTIONS

public static final String N_EXPLORERGENERALOPTIONS

The node name of the explorer generaloptions node.

See Also:

Constant Field Values

N_EXPLORERTYPE

public static final String N_EXPLORERTYPE

The name of the explorer type node.

See Also:

Constant Field Values

N_EXPLORERTYPES

public static final String N_EXPLORERTYPES

The name of the explorer types node.

See Also:

Constant Field Values

N_FILECOPY

public static final String N_FILECOPY

The node name of the file copy node.

See Also:

Constant Field Values

N_FILEDELETION

public static final String N_FILEDELETION

The node name of the file deletion node.

See Also:

Constant Field Values

N_FILEENCODING

public static final String N_FILEENCODING

The subname of the rfsfilesettings/fileEncoding node.

See Also:

Constant Field Values

N_FILEPATH

public static final String N_FILEPATH

The subname of the rfsfilesettings/filePath node.

See Also:

Constant Field Values

N_FOLDER

public static final String N_FOLDER

The node name of the start folder node.

See Also:

Constant Field Values

N_FOLDERCOPY

public static final String N_FOLDERCOPY

The node name of the folder copy node.

See Also:

Constant Field Values

N_INFORMROLEMEMBERS

public static final String N_INFORMROLEMEMBERS

The node name of the inform role members node.

See Also:

Constant Field Values

N_ISLOGFILE

public static final String N_ISLOGFILE

The subname of the rfsfilesettings/isLogfile node.

See Also:

Constant Field Values

N_LOCALE

public static final String N_LOCALE

The node name of the locale node.

See Also:

Constant Field Values

N_MESSAGEACCEPTED

public static final String N_MESSAGEACCEPTED

The node name of the message-accepted node.

See Also:

Constant Field Values

N_MESSAGECOMPLETED

public static final String N_MESSAGECOMPLETED

The node name of the message-completed node.

See Also:

Constant Field Values

N_MESSAGEFORWARDED

public static final String N_MESSAGEFORWARDED

The node name of the message-forwarded node.

See Also:

Constant Field Values

N_NEWRESOURCE

public static final String N_NEWRESOURCE

The name of the new resource node.

See Also:

Constant Field Values

N_PERMISSIONSINHERITONFOLDER

public static final String N_PERMISSIONSINHERITONFOLDER

The name of the inherit permissions on folder node.

See Also:

Constant Field Values

N_PROJECT

public static final String N_PROJECT

The node name of the project node.

See Also:

Constant Field Values

N_REPORTTYPE

public static final String N_REPORTTYPE

The node name of the report type node.

See Also:

Constant Field Values

N_RESTRICTEXPLORERVIEW

public static final String N_RESTRICTEXPLORERVIEW

The node name of the restrict explorer view node.

See Also:

Constant Field Values

N_RFSFILEVIEWESETTINGS

public static final String N_RFSFILEVIEWESETTINGS

The node name of the rfsfileviewsettings node.

See Also:

Constant Field Values

N_SEPARATOR

public static final String N_SEPARATOR

The name of the separator node.

See Also:

Constant Field Values

N_SHOWEXPORTSETTINGS

public static final String N_SHOWEXPORTSETTINGS

The node name of the show lock node.

See Also:

Constant Field Values

N_SHOWLOCK

public static final String N_SHOWLOCK

The node name of the show lock node.

See Also:

Constant Field Values

N_SHOWMESSAGES

public static final String N_SHOWMESSAGES

The node name of the show messages node.

See Also:

Constant Field Values

N_SHOWPROJECTS

public static final String N_SHOWPROJECTS

The node name of the showprojects node.

See Also:

Constant Field Values

N_STARTUPFILTER

public static final String N_STARTUPFILTER

The node name of the startupfilter node.

See Also:

Constant Field Values

N_UPLOADAPPLET

public static final String N_UPLOADAPPLET

The node name of the uploadapplet node.

See Also:

Constant Field Values

N_WINDOWSIZE

public static final String N_WINDOWSIZE

The subname of the rfsfilesettings/windowSize node.

See Also:

Constant Field Values

N_WORKFLOW

public static final String N_WORKFLOW

The node name of the workflow node.

See Also:

Constant Field Values

N_WORKFLOWDEFAULTSETTINGS

public static final String N_WORKFLOWDEFAULTSETTINGS

The node name of the workflow default settings node.

See Also:

Constant Field Values

N_WORKFLOWGENERALOPTIONS

public static final String N_WORKFLOWGENERALOPTIONS

The node name of the workflow general options node.

See Also:

Constant Field Values

N_WORKPLACEGENERALOPTIONS

public static final String N_WORKPLACEGENERALOPTIONS

The node name of the workplace general options node.

See Also:

Constant Field Values

N_WORKPLACESTARTUPSETTINGS

public static final String N_WORKPLACESTARTUPSETTINGS

The node name of the workplace startup settings node.

See Also:

Constant Field Values

N_WORKPLACEVIEW

public static final String N_WORKPLACEVIEW

The node name of the view node.

See Also:

Constant Field Values

N_AUTOLOCK

protected static final String N_AUTOLOCK

The name of the autolock node.

See Also:

Constant Field Values

N_DATECREATED

protected static final String N_DATECREATED

The node name of the datecreated column node.

See Also:

Constant Field Values

N_DATEEXPIRED

protected static final String N_DATEEXPIRED

The node name of the date expired column node.

See Also:

Constant Field Values

N_DATELASTMODIFIED

protected static final String N_DATELASTMODIFIED

The node name of the datelastmodified column node.

See Also:

Constant Field Values

N_DATERELEASED

protected static final String N_DATERELEASED

The node name of the date released column node.

See Also:

Constant Field Values

N_DEFAULTACCESSCONTROL

protected static final String N_DEFAULTACCESSCONTROL

The name of the default access control node.

See Also:

Constant Field Values

N_DEFAULTLOCALE

protected static final String N_DEFAULTLOCALE

The name of the node for the default locale.

See Also:

Constant Field Values

N_DEFAULTPROPERTIESONSTRUCTURE

protected static final String N_DEFAULTPROPERTIESONSTRUCTURE

The name of the default properties on structure node.

See Also:

Constant Field Values

N_DIALOGHANDLER

protected static final String N_DIALOGHANDLER

Individual workplace handler node name.

See Also:

Constant Field Values

N_DIALOGHANDLERS

protected static final String N_DIALOGHANDLERS

The main workplace handler node name.

See Also:

Constant Field Values

N_DIALOGSPREFERENCES

protected static final String N_DIALOGSPREFERENCES

The node name of the dialogs preferences node.

See Also:

Constant Field Values

N_EDITORACTION

protected static final String N_EDITORACTION

The name of the editor action node.

See Also:

Constant Field Values

N_EDITORHANDLER

protected static final String N_EDITORHANDLER

The name of the editor handler node.

See Also:

Constant Field Values

N_EDITORPREFERENCES

protected static final String N_EDITORPREFERENCES

The node name of the editors preferences node.

See Also:

Constant Field Values

N_ENABLEADVANCEDPROPERTYTABS

protected static final String N_ENABLEADVANCEDPROPERTYTABS

The name of the "enable advanced property tabs" node.

See Also:

Constant Field Values

N_ENABLEUSERMGMT

protected static final String N_ENABLEUSERMGMT

The name of the "user management enabled" node.

See Also:

Constant Field Values

N_EXPLORERPREFERENCES

protected static final String N_EXPLORERPREFERENCES

The node name of the explorer preferences node.

See Also:

Constant Field Values

N_LABELEDFOLDERS

protected static final String N_LABELEDFOLDERS

The name of the "labeled folders" node.

See Also:

Constant Field Values

N_LOCALIZEDFOLDERS

protected static final String N_LOCALIZEDFOLDERS

The name of the "localized folders" node.

See Also:

Constant Field Values

N_LOCKEDBY

protected static final String N_LOCKEDBY

The node name of the lockedby column node.

See Also:

Constant Field Values

N_MAXUPLOADSIZE

protected static final String N_MAXUPLOADSIZE

The name of the "max file upload size" node.

See Also:

Constant Field Values

N_PERMISSIONS

protected static final String N_PERMISSIONS

The node name of the permissions column node.

See Also:

Constant Field Values

N_SIZE

protected static final String N_SIZE

The node name of the size column node.

See Also:

Constant Field Values

N_STATE

protected static final String N_STATE

The node name of the state column node.

See Also:

Constant Field Values

N_TITLE

protected static final String N_TITLE

The node name of the title column node.

See Also:

Constant Field Values

N_TYPE

protected static final String N_TYPE

The node name of the type column node.

See Also:

Constant Field Values

N_USER

protected static final String N_USER

The node name of the default preferences node.

See Also:

Constant Field Values

N_USERCREATED

protected static final String N_USERCREATED

The node name of the user created node.

See Also:

Constant Field Values

N_USERLASTMODIFIED

protected static final String N_USERLASTMODIFIED

The node name of the user lastmodified node.

See Also:

Constant Field Values

N_WORKFLOWPREFERENCES

protected static final String N_WORKFLOWPREFERENCES

The node name of the workflow preferences node.

See Also:

Constant Field Values

N_WORKPLACE

protected static final String N_WORKPLACE

The node name of the master workplace node.

See Also:

Constant Field Values

N_WORKPLACEPREFERENCES

protected static final String N_WORKPLACEPREFERENCES

The node name of the workplace preferences node.

See Also:

Constant Field Values

Constructor Detail

CmsWorkplaceConfiguration

public CmsWorkplaceConfiguration()

Public constructor, will be called by configuration manager.

Method Detail

addExplorerTypeXmlRules

public static void addExplorerTypeXmlRules(Digester digester)

Adds the explorer type rules to the given digester.

Parameters:

digester - the digester to add the rules to

generateExplorerTypesXml

public static void generateExplorerTypesXml(Element startNode,
                                            List explorerTypes,
                                            boolean module)

Creates the xml output for explorer type nodes.

Parameters:

startNode - the startnode to add all rescource types to

explorerTypes - the list of explorer types

module - true if the XML tree for the module config should be generated, false otherwise

addXmlDigesterRules

public void addXmlDigesterRules(Digester digester)

Description copied from interface: I_CmsXmlConfiguration

Digests an XML node and creates an instance of this configurable class.

Specified by:

addXmlDigesterRules in interface I_CmsXmlConfiguration

Parameters:

digester - the digester to use

See Also:

I_CmsXmlConfiguration.addXmlDigesterRules(org.apache.commons.digester.Digester)

generateXml

public Element generateXml(Element parent)

Description copied from interface: I_CmsXmlConfiguration

Generates the XML element for this configurable class.

Specified by:

generateXml in interface I_CmsXmlConfiguration

Parameters:

parent - the parent element in the XML tree

Returns:

the XML element for this configurable class

See Also:

I_CmsXmlConfiguration.generateXml(org.dom4j.Element)

getDtdFilename

public String getDtdFilename()

Description copied from interface: I_CmsXmlConfiguration

Returns the name of the DTD file for this XML configuration, e.g. opencms-configuration.dtd.

Specified by:

getDtdFilename in interface I_CmsXmlConfiguration

Returns:

the name of the DTD file for this XML configuration

See Also:

I_CmsXmlConfiguration.getDtdFilename()

getWorkplaceManager

public CmsWorkplaceManager getWorkplaceManager()

Returns the initialized workplace manager.

Returns:

the initialized workplace manager

initializeFinished

public void initializeFinished()

Will be called when configuration of this object is finished.

setWorkplaceManager

public void setWorkplaceManager(CmsWorkplaceManager manager)

Sets the generated workplace manager.

Parameters:

manager - the workplace manager to set