org.opencms.workplace
Class CmsWorkplaceManager

java.lang.Object
  org.opencms.workplace.CmsWorkplaceManager

All Implemented Interfaces:

I_CmsLocaleHandler, I_CmsEventListener

public final class CmsWorkplaceManager
extends java.lang.Object
implements I_CmsLocaleHandler, I_CmsEventListener

Manages the global OpenCms workplace settings for all users.

This class reads the settings from the "opencms.properties" and stores them in member variables. For each setting one or more get methods are provided.

Since:

6.0.0

Field Summary

static java.lang.String	DEFAULT_WORKPLACE_ENCODING The default encoding for the workplace (UTF-8).
static java.lang.String	PARAM_LOGIN_REQUESTED_RESOURCE The id of the "requestedResource" parameter for the OpenCms login form.
static java.lang.String	SESSION_WORKPLACE_SETTINGS Key name for the session workplace settings.

Fields inherited from interface org.opencms.main.I_CmsEventListener

EVENT_BEFORE_PUBLISH_PROJECT, EVENT_CLEAR_CACHES, EVENT_CLEAR_OFFLINE_CACHES, EVENT_CLEAR_ONLINE_CACHES, EVENT_CLEAR_PRINCIPAL_CACHES, EVENT_FLEX_CACHE_CLEAR, EVENT_FLEX_PURGE_JSP_REPOSITORY, EVENT_FULLSTATIC_EXPORT, EVENT_GROUP_MODIFIED, EVENT_LOGIN_USER, EVENT_OU_MODIFIED, EVENT_PROJECT_MODIFIED, EVENT_PROPERTY_DEFINITION_CREATED, EVENT_PROPERTY_DEFINITION_MODIFIED, EVENT_PROPERTY_MODIFIED, EVENT_PUBLISH_PROJECT, EVENT_REBUILD_SEARCHINDEXES, EVENT_RESOURCE_AND_PROPERTIES_MODIFIED, EVENT_RESOURCE_COPIED, EVENT_RESOURCE_CREATED, EVENT_RESOURCE_DELETED, EVENT_RESOURCE_MODIFIED, EVENT_RESOURCE_MOVED, EVENT_RESOURCES_AND_PROPERTIES_MODIFIED, EVENT_RESOURCES_MODIFIED, EVENT_SITEMAP_CHANGED, EVENT_UPDATE_EXPORTS, EVENT_USER_MODIFIED, KEY_CHANGE, KEY_DBCONTEXT, KEY_GROUP_ID, KEY_GROUP_NAME, KEY_INDEX_NAMES, KEY_OU_ID, KEY_OU_NAME, KEY_PROJECTID, KEY_PUBLISHID, KEY_PUBLISHLIST, KEY_REPORT, KEY_RESOURCE, KEY_RESOURCES, KEY_USER_ACTION, KEY_USER_ID, KEY_USER_NAME, LISTENERS_FOR_ALL_EVENTS, VALUE_GROUP_MODIFIED_ACTION_CREATE, VALUE_GROUP_MODIFIED_ACTION_DELETE, VALUE_GROUP_MODIFIED_ACTION_WRITE, VALUE_OU_MODIFIED_ACTION_CREATE, VALUE_OU_MODIFIED_ACTION_DELETE, VALUE_USER_MODIFIED_ACTION_ADD_USER_TO_GROUP, VALUE_USER_MODIFIED_ACTION_CREATE_USER, VALUE_USER_MODIFIED_ACTION_DELETE_USER, VALUE_USER_MODIFIED_ACTION_REMOVE_USER_FROM_GROUP, VALUE_USER_MODIFIED_ACTION_RESET_PASSWORD, VALUE_USER_MODIFIED_ACTION_SET_OU, VALUE_USER_MODIFIED_ACTION_WRITE_USER

Constructor Summary

CmsWorkplaceManager()
Creates a new instance for the workplace manager, will be called by the workplace configuration manager.

Method Summary

void	addDialogHandler(I_CmsDialogHandler clazz) Adds a dialog handler instance to the list of configured dialog handlers.
void	addEditorCssHandler(java.lang.String editorCssHandlerClassName) Adds an editor CSS handler class to the list of handlers.
void	addEditorCssHandlerToHead(java.lang.String editorCssHandlerClassName) Adds an editor CSS handler class at the first position of the list of handlers.
void	addExplorerTypeSetting(CmsExplorerTypeSettings settings) Adds an explorer type setting object to the list of type settings.
void	addExplorerTypeSettings(CmsModule module) Adds the list of explorer type settings from the given module.
void	addExportPoint(java.lang.String uri, java.lang.String destination) Adds newly created export point to the workplace configuration.
void	addLabeledFolder(java.lang.String uri) Adds a folder to the list of labeled folders.
void	addLocalizedFolder(java.lang.String uri) Adds a new folder to the list of localized workplace folders.
void	addMenuRule(CmsMenuRule menuRule) Adds a menu rule set from the workplace configuration to the configured menu rules.
void	addPreEditorConditionDefinition(I_CmsPreEditorActionDefinition preEditorCondition) Adds an initialized condition definition class that is triggered before opening the editor.
void	addPreEditorConditionDefinition(java.lang.String resourceTypeName, java.lang.String preEditorConditionDefinitionClassName) Adds a condition definition class for a given resource type name that is triggered before opening the editor.
void	addSynchronizeExcludePattern(java.lang.String pattern) Adds a pattern to be excluded in VFS synchronization.
boolean	autoLockResources() Returns if the autolock resources feature is enabled.
void	cmsEvent(CmsEvent event) Implements the event listener of this class.
java.lang.String	createTempFile(CmsObject cms, java.lang.String resourceName, CmsUUID currentProjectId) Creates a temporary file which is needed while working in an editor with preview option.
CmsWorkplaceCustomFoot	getCustomFoot() Returns the customized workplace foot.
CmsExplorerTypeAccess	getDefaultAccess() Gets the access object of the type settings.
java.util.Locale	getDefaultLocale() Returns the Workplace default locale.
CmsDefaultUserSettings	getDefaultUserSettings() Returns the Workplace default user settings.
java.util.Map<java.lang.String,I_CmsDialogHandler>	getDialogHandler() Returns all instantiated dialog handlers for the workplace.
I_CmsDialogHandler	getDialogHandler(java.lang.String key) Returns the instantiated dialog handler class for the key or null, if there is no mapping for the key.
I_CmsDirectEditProvider	getDirectEditProvider() Returns a new instance of the configured direct edit provider.
I_CmsEditorActionHandler	getEditorActionHandler() Returns the instantiated editor action handler class.
java.util.List<I_CmsEditorCssHandler>	getEditorCssHandlers() Returns the instantiated editor CSS handler classes.
CmsEditorDisplayOptions	getEditorDisplayOptions() Returns the instantiated editor display option class.
I_CmsEditorHandler	getEditorHandler() Returns the instantiated editor handler class.
java.lang.String	getEncoding() Returns the configured workplace encoding.
CmsExplorerTypeSettings	getExplorerTypeSetting(java.lang.String type) Returns the explorer type settings for the specified resource type.
java.util.List<CmsExplorerTypeSettings>	getExplorerTypeSettings() Returns the list of explorer type settings.
java.util.Set<CmsExportPoint>	getExportPoints() Returns the set of configured export points for the workplace.
long	getFileBytesMaxUploadSize(CmsObject cms) Returns the value (in bytes) for the maximum file upload size of the current user.
int	getFileMaxUploadSize() Returns the value (in kb) for the maximum file upload size.
CmsRfsFileViewer	getFileViewSettings() Returns the system-wide file view settings for the workplace.
java.util.Map<java.lang.String,A_CmsAjaxGallery>	getGalleries() Returns a collection of all available galleries.
I_CmsGroupNameTranslation	getGroupNameTranslation() Returns the object used for translating group names.
java.lang.String	getGroupTranslationClass() Returns the configured class name for translating group names.
CmsI18nInfo	getI18nInfo(javax.servlet.http.HttpServletRequest req, CmsUser user, CmsProject project, java.lang.String resource) Returns the i18n information to use in the request context.
java.util.List<java.lang.String>	getLabelSiteFolders() Returns a list of site folders which generate labeled links.
java.util.List<java.util.Locale>	getLocales() Returns the list of available workplace locales, sorted ascending.
java.util.List<java.lang.String>	getLocalizedFolders() Returns the configured list of localized workplace folders.
CmsMenuRule	getMenuRule(java.lang.String ruleName) Returns the menu rule set with the given name.
java.util.List<CmsMenuRule>	getMenuRules() Returns the configured menu rule sets.
java.util.Map<java.lang.String,CmsMenuRule>	getMenuRulesMap() Returns the configured menu rule sets as Map.
CmsWorkplaceMessages	getMessages(java.util.Locale locale) Returns the CmsWorkplaceMessages for the given locale.
CmsExplorerContextMenu	getMultiContextMenu() Returns the configured multi context menu to use in the Explorer view.
I_CmsPreEditorActionDefinition	getPreEditorConditionDefinition(I_CmsResourceType resourceType) Returns the condition definition for the given resource type that is triggered before opening the editor.
java.util.List<I_CmsPreEditorActionDefinition>	getPreEditorConditionDefinitions() Returns the condition definitions for the different resource types which are triggered before opening the editor.
java.util.ArrayList<java.util.regex.Pattern>	getSynchronizeExcludePatterns() Returns Regex patterns that should be excluded from synchronization.
CmsUUID	getTempFileProjectId() Returns the id of the temporary file project required by the editors.
CmsToolManager	getToolManager() Returns the tool manager.
java.lang.String	getUploadHook(CmsObject cms, java.lang.String uploadFolder) Gets the upload hook URI which should be opened for an upload to a given folder.
CmsWorkplaceUserInfoManager	getUserInfoManager() Returns the user additional information configuration Manager.
java.lang.String	getUserListModeString() Returns the user list mode as a string.
java.util.List<CmsWorkplaceView>	getViews() Returns the map of configured workplace views.
CmsWorkplaceEditorManager	getWorkplaceEditorManager() Returns the instantiated workplace editor manager class.
java.util.Locale	getWorkplaceLocale(CmsObject cms) Returns the workplace locale from the current user's settings.
void	initHandler(CmsObject cms) Will be called during system startup.
void	initialize(CmsObject cms) Initializes the workplace manager with the OpenCms system configuration.
boolean	isDefaultPropertiesOnStructure() Returns the default property editing mode on resources.
boolean	isEnableAdvancedPropertyTabs() Returns if tabs in the advanced property dialog are enabled.
static boolean	isWorkplaceUser(javax.servlet.http.HttpServletRequest req) Returns true if the provided request was done by a Workplace user.
boolean	isXmlContentAutoCorrect() Returns if XML content is automatically corrected when opened with the editor.
boolean	lazyUserListsEnabled() Returns if lazy user lists are enabled.
void	removeExplorerTypeSettings(CmsModule module) Removes the list of explorer type settings from the given module.
void	setAutoLock(java.lang.String value) Sets if the autolock resources feature is enabled.
void	setCustomFoot(CmsWorkplaceCustomFoot footCustom) Sets the customized workplace foot.
void	setDefaultAccess(CmsExplorerTypeAccess access) Sets the access object of the type settings.
void	setDefaultLocale(java.lang.String locale) Sets the Workplace default locale.
void	setDefaultPropertiesOnStructure(java.lang.String defaultPropertiesOnStructure) Sets the default property editing mode on resources.
void	setDefaultUserSettings(CmsDefaultUserSettings defaultUserSettings) Sets the Workplace default user settings.
void	setDirectEditProvider(I_CmsDirectEditProvider clazz) Sets the direct edit provider.
void	setEditorAction(I_CmsEditorActionHandler clazz) Sets the editor action class.
void	setEditorDisplayOptions(CmsEditorDisplayOptions clazz) Sets the editor display option class.
void	setEditorHandler(I_CmsEditorHandler clazz) Sets the editor handler class.
void	setEnableAdvancedPropertyTabs(java.lang.String enableAdvancedPropertyTabs) Sets if tabs in the advanced property dialog are enabled.
void	setFileMaxUploadSize(java.lang.String value) Sets the value (in kb) for the maximum file upload size.
void	setFileViewSettings(CmsObject cms, CmsRfsFileViewer fileViewSettings) Sets the system-wide file view settings for the workplace.
void	setGroupTranslationClass(java.lang.String translationClassName) Sets the group translation class name.
void	setMultiContextMenu(CmsExplorerContextMenu multiContextMenu) Sets the configured multi context menu to use in the Explorer view.
void	setToolManager(CmsToolManager toolManager) Sets the tool Manager object.
void	setUserInfoManager(CmsWorkplaceUserInfoManager userInfoManager) Sets the user additional information configuration manager.
void	setUserListMode(java.lang.String mode) Sets the user list mode.
void	setUserManagementEnabled(java.lang.String value) Controls if the user/group icon in the administration view should be shown.
void	setXmlContentAutoCorrect(java.lang.String xmlContentAutoCorrect) Sets the auto correction of XML contents when they are opened with the editor.
boolean	showUserGroupIcon() Returns if the user/group icon in the administration view should be shown.
boolean	supportsLazyUserLists() Returns true if lazy user lists should be used.
java.lang.String	translateGroupName(java.lang.String groupName, boolean keepOu) Translates a group name using the configured I_CmsGroupNameTranslation.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_WORKPLACE_ENCODING

public static final java.lang.String DEFAULT_WORKPLACE_ENCODING

The default encoding for the workplace (UTF-8).

See Also:

Constant Field Values

PARAM_LOGIN_REQUESTED_RESOURCE

public static final java.lang.String PARAM_LOGIN_REQUESTED_RESOURCE

The id of the "requestedResource" parameter for the OpenCms login form.

See Also:

Constant Field Values

SESSION_WORKPLACE_SETTINGS

public static final java.lang.String SESSION_WORKPLACE_SETTINGS

Key name for the session workplace settings.

See Also:

Constant Field Values

Constructor Detail

CmsWorkplaceManager

public CmsWorkplaceManager()

Creates a new instance for the workplace manager, will be called by the workplace configuration manager.

Method Detail

isWorkplaceUser

public static boolean isWorkplaceUser(javax.servlet.http.HttpServletRequest req)

Returns true if the provided request was done by a Workplace user.

Parameters:

req - the request to check

Returns:

true if the provided request was done by a Workplace user

addDialogHandler

public void addDialogHandler(I_CmsDialogHandler clazz)

Adds a dialog handler instance to the list of configured dialog handlers.

Parameters:

clazz - the instantiated dialog handler to add

addEditorCssHandler

public void addEditorCssHandler(java.lang.String editorCssHandlerClassName)

Adds an editor CSS handler class to the list of handlers.

Parameters:

editorCssHandlerClassName - full class name of the css handler class

addEditorCssHandlerToHead

public void addEditorCssHandlerToHead(java.lang.String editorCssHandlerClassName)

Adds an editor CSS handler class at the first position of the list of handlers.

Parameters:

editorCssHandlerClassName - full class name of the css handler class

addExplorerTypeSetting

public void addExplorerTypeSetting(CmsExplorerTypeSettings settings)

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

Parameters:

settings - the explorer type settings

addExplorerTypeSettings

public void addExplorerTypeSettings(CmsModule module)

Adds the list of explorer type settings from the given module.

Parameters:

module - the module witch contains the explorer type settings to add

addExportPoint

public void addExportPoint(java.lang.String uri,
                           java.lang.String destination)

Adds newly created export point to the workplace configuration.

Parameters:

uri - the export point uri

destination - the export point destination

addLabeledFolder

public void addLabeledFolder(java.lang.String uri)

Adds a folder to the list of labeled folders.

Parameters:

uri - the folder uri to add

addLocalizedFolder

public void addLocalizedFolder(java.lang.String uri)

Adds a new folder to the list of localized workplace folders.

Parameters:

uri - a new folder to add to the list of localized workplace folders

addMenuRule

public void addMenuRule(CmsMenuRule menuRule)

Adds a menu rule set from the workplace configuration to the configured menu rules.

Parameters:

menuRule - the menu rule to add

addPreEditorConditionDefinition

public void addPreEditorConditionDefinition(I_CmsPreEditorActionDefinition preEditorCondition)

Adds an initialized condition definition class that is triggered before opening the editor.

Parameters:

preEditorCondition - the initialized condition definition class

addPreEditorConditionDefinition

public void addPreEditorConditionDefinition(java.lang.String resourceTypeName,
                                            java.lang.String preEditorConditionDefinitionClassName)

Adds a condition definition class for a given resource type name that is triggered before opening the editor.

Parameters:

resourceTypeName - the name of the resource type

preEditorConditionDefinitionClassName - full class name of the condition definition class

addSynchronizeExcludePattern

public void addSynchronizeExcludePattern(java.lang.String pattern)

Adds a pattern to be excluded in VFS synchronization.

Parameters:

pattern - a java regex to applied on the file name

autoLockResources

public boolean autoLockResources()

Returns if the autolock resources feature is enabled.

Returns:

true if the autolock resources feature is enabled, otherwise false

cmsEvent

public void cmsEvent(CmsEvent event)

Implements the event listener of this class.

Specified by:

cmsEvent in interface I_CmsEventListener

Parameters:

event - CmsEvent that has occurred

See Also:

I_CmsEventListener.cmsEvent(org.opencms.main.CmsEvent)

createTempFile

public java.lang.String createTempFile(CmsObject cms,
                                       java.lang.String resourceName,
                                       CmsUUID currentProjectId)
                                throws CmsException

Creates a temporary file which is needed while working in an editor with preview option.

Note: This method is synchronized to avoid rare issues that might be caused by double requests fired by some browser/OS combinations.

Parameters:

cms - the cms context

resourceName - the name of the resource to copy

currentProjectId - the id of the project to work with

Returns:

the file name of the temporary file

Throws:

CmsException - if something goes wrong

getCustomFoot

public CmsWorkplaceCustomFoot getCustomFoot()

Returns the customized workplace foot.

Returns:

the customized workplace foot

getDefaultAccess

public CmsExplorerTypeAccess getDefaultAccess()

Gets the access object of the type settings.

Returns:

access object of the type settings

getDefaultLocale

public java.util.Locale getDefaultLocale()

Returns the Workplace default locale.

Returns:

the Workplace default locale

getDefaultUserSettings

public CmsDefaultUserSettings getDefaultUserSettings()

Returns the Workplace default user settings.

Returns:

the Workplace default user settings

getDialogHandler

public java.util.Map<java.lang.String,I_CmsDialogHandler> getDialogHandler()

Returns all instantiated dialog handlers for the workplace.

Returns:

all instantiated dialog handlers for the workplace

getDialogHandler

public I_CmsDialogHandler getDialogHandler(java.lang.String key)

Returns the instantiated dialog handler class for the key or null, if there is no mapping for the key.

Parameters:

key - the key whose associated value is to be returned

Returns:

the instantiated dialog handler class for the key

getDirectEditProvider

public I_CmsDirectEditProvider getDirectEditProvider()

Returns a new instance of the configured direct edit provider.

Returns:

a new instance of the configured direct edit provider

getEditorActionHandler

public I_CmsEditorActionHandler getEditorActionHandler()

Returns the instantiated editor action handler class.

Returns:

the instantiated editor action handler class

getEditorCssHandlers

public java.util.List<I_CmsEditorCssHandler> getEditorCssHandlers()

Returns the instantiated editor CSS handler classes.

Returns:

the instantiated editor CSS handler classes

getEditorDisplayOptions

public CmsEditorDisplayOptions getEditorDisplayOptions()

Returns the instantiated editor display option class.

Returns:

the instantiated editor display option class

getEditorHandler

public I_CmsEditorHandler getEditorHandler()

Returns the instantiated editor handler class.

Returns:

the instantiated editor handler class

getEncoding

public java.lang.String getEncoding()

Returns the configured workplace encoding.

Returns:

the configured workplace encoding

getExplorerTypeSetting

public CmsExplorerTypeSettings getExplorerTypeSetting(java.lang.String type)

Returns the explorer type settings for the specified resource type.

Parameters:

type - the resource type for which the settings are required

Returns:

the explorer type settings for the specified resource type

getExplorerTypeSettings

public java.util.List<CmsExplorerTypeSettings> getExplorerTypeSettings()

Returns the list of explorer type settings.

These settings provide information for the new resource dialog and the context menu appearance.

Returns:

the list of explorer type settings

getExportPoints

public java.util.Set<CmsExportPoint> getExportPoints()

Returns the set of configured export points for the workplace.

Returns:

the set of configured export points for the workplace

getFileBytesMaxUploadSize

public long getFileBytesMaxUploadSize(CmsObject cms)

Returns the value (in bytes) for the maximum file upload size of the current user.

Parameters:

cms - the initialized CmsObject

Returns:

the value (in bytes) for the maximum file upload size

getFileMaxUploadSize

public int getFileMaxUploadSize()

Returns the value (in kb) for the maximum file upload size.

Returns:

the value (in kb) for the maximum file upload size

getFileViewSettings

public CmsRfsFileViewer getFileViewSettings()

Returns the system-wide file view settings for the workplace.

Note that this instance may not modified (invocation of setters) directly or a CmsRuntimeException will be thrown.

It has to be cloned first and then may be written back to the workplace settings using method setFileViewSettings(CmsObject, org.opencms.util.CmsRfsFileViewer).

Returns:

the system-wide file view settings for the workplace

getGalleries

public java.util.Map<java.lang.String,A_CmsAjaxGallery> getGalleries()

Returns a collection of all available galleries.

The Map has the gallery type name as key and an instance of the gallery class (not completely initialized) as value.

Returns:

a collection of all available galleries

getGroupNameTranslation

public I_CmsGroupNameTranslation getGroupNameTranslation()

Returns the object used for translating group names.

Returns:

the group name translator

getGroupTranslationClass

public java.lang.String getGroupTranslationClass()

Returns the configured class name for translating group names.

Returns:

the group translation class name

getI18nInfo

public CmsI18nInfo getI18nInfo(javax.servlet.http.HttpServletRequest req,
                               CmsUser user,
                               CmsProject project,
                               java.lang.String resource)

Description copied from interface: I_CmsLocaleHandler

Returns the i18n information to use in the request context.

Specified by:

getI18nInfo in interface I_CmsLocaleHandler

Parameters:

req - the current http request

user - the current user

project - the current project

resource - the URI of the requested resource (with full site root added)

Returns:

the i18n information to use for the given request context

See Also:

I_CmsLocaleHandler.getI18nInfo(javax.servlet.http.HttpServletRequest, org.opencms.file.CmsUser, org.opencms.file.CmsProject, java.lang.String)

getLabelSiteFolders

public java.util.List<java.lang.String> getLabelSiteFolders()

Returns a list of site folders which generate labeled links.

Returns:

a list of site folders which generate labeled links

getLocales

public java.util.List<java.util.Locale> getLocales()

Returns the list of available workplace locales, sorted ascending.

Please note: Be careful not to modify the returned Set as it is not a clone.

Returns:

the set of available workplace locales

getLocalizedFolders

public java.util.List<java.lang.String> getLocalizedFolders()

Returns the configured list of localized workplace folders.

Returns:

the configured list of localized workplace folders

getMenuRule

public CmsMenuRule getMenuRule(java.lang.String ruleName)

Returns the menu rule set with the given name.

If no rule set with the specified name is found, null is returned.

Parameters:

ruleName - the name of the rule set to get

Returns:

the menu rule set with the given name

getMenuRules

public java.util.List<CmsMenuRule> getMenuRules()

Returns the configured menu rule sets.

Returns:

the configured menu rule sets

getMenuRulesMap

public java.util.Map<java.lang.String,CmsMenuRule> getMenuRulesMap()

Returns the configured menu rule sets as Map.

Returns:

the configured menu rule sets as Map

getMessages

public CmsWorkplaceMessages getMessages(java.util.Locale locale)

Returns the CmsWorkplaceMessages for the given locale.

The workplace messages are a collection of resource bundles, containing the messages for all OpenCms core bundles and of all initialized modules.

Please note that the message objects are cached internally. The returned message object should therefore never be modified directly in any way.

Parameters:

locale - the locale to get the messages for

Returns:

the CmsWorkplaceMessages for the given locale

getMultiContextMenu

public CmsExplorerContextMenu getMultiContextMenu()

Returns the configured multi context menu to use in the Explorer view.

Returns:

the configured multi context menu to use in the Explorer view

getPreEditorConditionDefinition

public I_CmsPreEditorActionDefinition getPreEditorConditionDefinition(I_CmsResourceType resourceType)

Returns the condition definition for the given resource type that is triggered before opening the editor.

Parameters:

resourceType - the resource type

Returns:

the condition definition for the given resource type class name or null if none is found

getPreEditorConditionDefinitions

public java.util.List<I_CmsPreEditorActionDefinition> getPreEditorConditionDefinitions()

Returns the condition definitions for the different resource types which are triggered before opening the editor.

Returns:

the condition definitions

getSynchronizeExcludePatterns

public java.util.ArrayList<java.util.regex.Pattern> getSynchronizeExcludePatterns()

Returns Regex patterns that should be excluded from synchronization.

Returns:

the exclude patterns

getTempFileProjectId

public CmsUUID getTempFileProjectId()

Returns the id of the temporary file project required by the editors.

Returns:

the id of the temporary file project required by the editors

getToolManager

public CmsToolManager getToolManager()

Returns the tool manager.

Returns:

the tool manager

getUploadHook

public java.lang.String getUploadHook(CmsObject cms,
                                      java.lang.String uploadFolder)

Gets the upload hook URI which should be opened for an upload to a given folder.

This method will return null if no upload hook should be used for the given upload folder.

The API for this upload hook is as follows: The upload hook will be called with the following parameters: resources (required): a comma separated list of the structure ids of the uploaded resources if this is omitted closelink (optional): a link which should be opened once the upload hook has finished whatever it is doing

Parameters:

cms - the current CMS context

uploadFolder - the folder for which the upload hook should be found

Returns:

the URI of the upload hook or null

getUserInfoManager

public CmsWorkplaceUserInfoManager getUserInfoManager()

Returns the user additional information configuration Manager.

Returns:

the user additional information configuration manager

getUserListModeString

public java.lang.String getUserListModeString()

Returns the user list mode as a string.

Returns:

the user list mode as a string

getViews

public java.util.List<CmsWorkplaceView> getViews()

Returns the map of configured workplace views.

Returns:

the map of configured workplace views

getWorkplaceEditorManager

public CmsWorkplaceEditorManager getWorkplaceEditorManager()

Returns the instantiated workplace editor manager class.

Returns:

the instantiated workplace editor manager class

getWorkplaceLocale

public java.util.Locale getWorkplaceLocale(CmsObject cms)

Returns the workplace locale from the current user's settings.

Parameters:

cms - the current cms object

Returns:

the workplace locale

initHandler

public void initHandler(CmsObject cms)

Description copied from interface: I_CmsLocaleHandler

Will be called during system startup.

Specified by:

initHandler in interface I_CmsLocaleHandler

Parameters:

cms - an initialized cms permission context for VFS access

See Also:

I_CmsLocaleHandler.initHandler(org.opencms.file.CmsObject)

initialize

public void initialize(CmsObject cms)
                throws CmsException,
                       CmsRoleViolationException

Initializes the workplace manager with the OpenCms system configuration.

Parameters:

cms - an OpenCms context object that must have been initialized with "Admin" permissions

Throws:

CmsRoleViolationException - if the provided OpenCms user context does not have CmsRole.WORKPLACE_MANAGER role permissions

CmsException - if something goes wrong

isDefaultPropertiesOnStructure

public boolean isDefaultPropertiesOnStructure()

Returns the default property editing mode on resources.

Returns:

the default property editing mode on resources

isEnableAdvancedPropertyTabs

public boolean isEnableAdvancedPropertyTabs()

Returns if tabs in the advanced property dialog are enabled.

Returns:

true if tabs should be enabled, otherwise false

isXmlContentAutoCorrect

public boolean isXmlContentAutoCorrect()

Returns if XML content is automatically corrected when opened with the editor.

Returns:

true if XML content is automatically corrected when opened with the editor, otherwise false

lazyUserListsEnabled

public boolean lazyUserListsEnabled()

Returns if lazy user lists are enabled.

Returns:

true if lazy user lists are enabled

removeExplorerTypeSettings

public void removeExplorerTypeSettings(CmsModule module)

Removes the list of explorer type settings from the given module.

Parameters:

module - the module witch contains the explorer type settings to remove

setAutoLock

public void setAutoLock(java.lang.String value)

Sets if the autolock resources feature is enabled.

Parameters:

value - "true" if the autolock resources feature is enabled, otherwise false

setCustomFoot

public void setCustomFoot(CmsWorkplaceCustomFoot footCustom)

Sets the customized workplace foot.

Parameters:

footCustom - the customized workplace foot

setDefaultAccess

public void setDefaultAccess(CmsExplorerTypeAccess access)

Sets the access object of the type settings.

Parameters:

access - access object

setDefaultLocale

public void setDefaultLocale(java.lang.String locale)

Sets the Workplace default locale.

Parameters:

locale - the locale to set

setDefaultPropertiesOnStructure

public void setDefaultPropertiesOnStructure(java.lang.String defaultPropertiesOnStructure)

Sets the default property editing mode on resources.

Parameters:

defaultPropertiesOnStructure - the default property editing mode on resources

setDefaultUserSettings

public void setDefaultUserSettings(CmsDefaultUserSettings defaultUserSettings)

Sets the Workplace default user settings.

Parameters:

defaultUserSettings - the user settings to set

setDirectEditProvider

public void setDirectEditProvider(I_CmsDirectEditProvider clazz)

Sets the direct edit provider.

Parameters:

clazz - the direct edit provider to set

setEditorAction

public void setEditorAction(I_CmsEditorActionHandler clazz)

Sets the editor action class.

Parameters:

clazz - the editor action class to set

setEditorDisplayOptions

public void setEditorDisplayOptions(CmsEditorDisplayOptions clazz)

Sets the editor display option class.

Parameters:

clazz - the editor display option class to set

setEditorHandler

public void setEditorHandler(I_CmsEditorHandler clazz)

Sets the editor handler class.

Parameters:

clazz - the editor handler class to set

setEnableAdvancedPropertyTabs

public void setEnableAdvancedPropertyTabs(java.lang.String enableAdvancedPropertyTabs)

Sets if tabs in the advanced property dialog are enabled.

Parameters:

enableAdvancedPropertyTabs - true if tabs should be enabled, otherwise false

setFileMaxUploadSize

public void setFileMaxUploadSize(java.lang.String value)

Sets the value (in kb) for the maximum file upload size.

Parameters:

value - the value (in kb) for the maximum file upload size

setFileViewSettings

public void setFileViewSettings(CmsObject cms,
                                CmsRfsFileViewer fileViewSettings)
                         throws CmsRoleViolationException

Sets the system-wide file view settings for the workplace.

Parameters:

cms - the CmsObject for ensuring security constraints.

fileViewSettings - the system-wide file view settings for the workplace to set

Throws:

CmsRoleViolationException - if the current user does not own the administrator role (CmsRole.ROOT_ADMIN)

setGroupTranslationClass

public void setGroupTranslationClass(java.lang.String translationClassName)

Sets the group translation class name.

Parameters:

translationClassName - the group translation class name

setMultiContextMenu

public void setMultiContextMenu(CmsExplorerContextMenu multiContextMenu)

Sets the configured multi context menu to use in the Explorer view.

Parameters:

multiContextMenu - the configured multi context menu to use in the Explorer view

setToolManager

public void setToolManager(CmsToolManager toolManager)

Sets the tool Manager object.

Parameters:

toolManager - the tool Manager object to set

setUserInfoManager

public void setUserInfoManager(CmsWorkplaceUserInfoManager userInfoManager)

Sets the user additional information configuration manager.

Parameters:

userInfoManager - the manager to set

setUserListMode

public void setUserListMode(java.lang.String mode)

Sets the user list mode.

Parameters:

mode - the user list mode

setUserManagementEnabled

public void setUserManagementEnabled(java.lang.String value)

Controls if the user/group icon in the administration view should be shown.

Parameters:

value - "true" if the user/group icon in the administration view should be shown, otherwise false

setXmlContentAutoCorrect

public void setXmlContentAutoCorrect(java.lang.String xmlContentAutoCorrect)

Sets the auto correction of XML contents when they are opened with the editor.

Parameters:

xmlContentAutoCorrect - if "true", the content will be corrected without notification, otherwise a confirmation is needed

showUserGroupIcon

public boolean showUserGroupIcon()

Returns if the user/group icon in the administration view should be shown.

Returns:

true if the user/group icon in the administration view should be shown, otherwise false

supportsLazyUserLists

public boolean supportsLazyUserLists()

Returns true if lazy user lists should be used.

Returns:

true if lazy user lists should be used

translateGroupName

public java.lang.String translateGroupName(java.lang.String groupName,
                                           boolean keepOu)

Translates a group name using the configured I_CmsGroupNameTranslation.

Parameters:

groupName - the group name

keepOu - if true, the OU will be appended to the translated name

Returns:

the translated group name