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
Fields Modifier and Type Field Description static java.lang.String
DEFAULT_WORKPLACE_ENCODING
The default encoding for the workplace (UTF-8).static java.lang.String
LOCALIZATION_ATTRIBUTE_NAME
The workplace localization manifest attribute name.static java.lang.String
MANIFEST_RESOURCE_NAME
The manifest file resource name.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_REINDEX_OFFLINE, EVENT_REINDEX_ONLINE, 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_IS_ONLINE, KEY_OU_ID, KEY_OU_NAME, KEY_PROJECTID, KEY_PUBLISHID, KEY_PUBLISHLIST, KEY_REINDEX_RELATED, KEY_REPORT, KEY_RESOURCE, KEY_RESOURCES, KEY_SKIPINDEX, KEY_USER_ACTION, KEY_USER_CHANGES, KEY_USER_ID, KEY_USER_NAME, LISTENERS_FOR_ALL_EVENTS, VALUE_CREATE_SIBLING, 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
Constructors Constructor Description CmsWorkplaceManager()
Creates a new instance for the workplace manager, will be called by the workplace configuration manager.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addAccountInfo(java.lang.String field, java.lang.String addInfoKey, java.lang.String editable)
Adds an account info.void
addAccountInfo(CmsAccountInfo info)
Adds an account info.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
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
addPreEditorConditionDefinition(I_CmsPreEditorActionDefinition preEditorCondition)
Adds an initialized condition definition class 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
checkWorkplaceRequest(javax.servlet.http.HttpServletRequest request, CmsObject cms)
Checks whether the workplace is accessed through the workplace server, and sends an error message otherwise.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.void
flushMessageCache()
Flushes the cached workplace messages.java.lang.String
getAcaciaUnlock()
Gets the value of the acacia-unlock configuration option (null if not set explicitly).java.util.List<CmsAccountInfo>
getAccountInfos()
Returns the account infos.CmsAdditionalLogFolderConfig
getAdditionalLogFolderConfiguration()
Gets the additional log folder configuration.java.lang.String
getCategoryFolder()
Returns the name of the local category folder(s).java.util.List<CmsAccountInfo>
getConfiguredAccountInfos()
Returns the configured account infos.CmsExplorerTypeAccess
getDefaultAccess()
Gets the access object of the type settings.java.util.Locale
getDefaultLocale()
Returns the Workplace default locale.java.lang.String
getDefaultNamePattern(java.lang.String type)
Gets the default name pattern for the given type.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.CmsCntPageData.ElementDeleteMode
getElementDeleteMode()
Returns the element delete mode.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.List<CmsExplorerTypeSettings>
getExplorerTypesForView(java.lang.String viewName)
Gets the explorer types for the given view name.java.util.Map<CmsUUID,CmsElementView>
getExplorerTypeViews()
Gets the element views generated from explorer types.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.CmsGallerySearchScope
getGalleryDefaultScope()
Returns the gallery default scope.java.lang.String
getGalleryDefaultScopeString()
Gets the configured gallery default scope as a string.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.CmsWorkplaceMessages
getMessages(java.util.Locale locale)
Returns theCmsWorkplaceMessages
for the given locale.I_CmsPostUploadDialogHandler
getPostUploadHandler()
Returns the post upload handler.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.I_CmsRepositoryFolderHandler
getRepositoryFolderHandler()
Returns the repository folder handler.java.lang.String
getSitemapConfigEditRole()
Gets the name of the role necessary for editing the sitemap configuration.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.I_CmsUploadRestriction
getUploadRestriction()
Gets the upload restriction.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.List<CmsExplorerTypeSettings>
getWorkplaceExplorerTypeSettings()
Returns the list of explorer type settings configured in the opencms-workplace.xml file.java.util.Locale
getWorkplaceLocale(CmsObject cms)
Returns the workplace locale from the current user's settings.java.util.Locale
getWorkplaceLocale(CmsRequestContext requestContext)
Gets the workplace locale for the given request context.java.util.Locale
getWorkplaceLocale(CmsUser user)
Returns the workplace locale for the user.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
isDisplayCategoriesByRepository()
Returns a flag, indicating if the categories should be displayed separated by repository in the category selection dialog.boolean
isDisplayCategorySelectionCollapsed()
Returns a flag, indicating if the category selection dialog should have all entries completely collapsed when opened.boolean
isEnableAdvancedPropertyTabs()
Returns if tabs in the advanced property dialog are enabled.boolean
isKeepAlive()
Returns true if "keep alive" mode is active.java.lang.Boolean
isKeepAlive(boolean useDefault)
Returns true if the session should be kept alive.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
setAcaciaUnlock(java.lang.String value)
Sets the value of the acacia-unlock configuration option.void
setAdditionalLogFolderConfiguration(CmsAdditionalLogFolderConfig logConfig)
Sets the additional log folder configuration.void
setAutoLock(java.lang.String value)
Sets if the autolock resources feature is enabled.void
setCategoryDisplayOptions(java.lang.String displayCategoriesByRepository, java.lang.String displayCategorySelectionCollapsed)
Sets the category display options that affect how the category selection dialog is shown.void
setCategoryFolder(java.lang.String categoryFolder)
Sets the name of the local category folder(s).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
setElementDeleteMode(java.lang.String deleteMode)
Sets the element delete mode.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
setGalleryDefaultScope(java.lang.String galleryDefaultScope)
Sets the gallery default scope.void
setGroupTranslationClass(java.lang.String translationClassName)
Sets the group translation class name.void
setKeepAlive(java.lang.String keepAlive)
Sets the "keep alive" mode.void
setPostUploadHandler(I_CmsPostUploadDialogHandler uploadHandler)
Sets the post upload dialog handler.void
setRepositoryFolderHandler(I_CmsRepositoryFolderHandler clazz)
Sets the repository folder handler.void
setSitemapConfigEditRole(java.lang.String roleName)
Sets the name of the role necessary for editing the sitemap configuration.void
setToolManager(CmsToolManager toolManager)
Sets the tool Manager object.void
setUploadRestriction(I_CmsUploadRestriction uploadRestriction)
Sets the upload restriciton.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
shouldAcaciaUnlock()
Returns true if the Acacia editor in standalone mode should automatically unlock resources.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 configuredI_CmsGroupNameTranslation
.
-
-
-
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
-
LOCALIZATION_ATTRIBUTE_NAME
public static final java.lang.String LOCALIZATION_ATTRIBUTE_NAME
The workplace localization manifest attribute name.- See Also:
- Constant Field Values
-
MANIFEST_RESOURCE_NAME
public static final java.lang.String MANIFEST_RESOURCE_NAME
The manifest file resource name.- 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
-
addAccountInfo
public void addAccountInfo(CmsAccountInfo info)
Adds an account info.- Parameters:
info
- the account info to add
-
addAccountInfo
public void addAccountInfo(java.lang.String field, java.lang.String addInfoKey, java.lang.String editable)
Adds an account info.- Parameters:
field
- the fieldaddInfoKey
- the additional info keyeditable
- the editable flag
-
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 uridestination
- 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
-
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 typepreEditorConditionDefinitionClassName
- 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
-
checkWorkplaceRequest
public void checkWorkplaceRequest(javax.servlet.http.HttpServletRequest request, CmsObject cms)
Checks whether the workplace is accessed through the workplace server, and sends an error message otherwise.- Parameters:
request
- the request to checkcms
- the CmsObject to use
-
cmsEvent
public void cmsEvent(CmsEvent event)
Implements the event listener of this class.- Specified by:
cmsEvent
in interfaceI_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 contextresourceName
- the name of the resource to copycurrentProjectId
- the id of the project to work with- Returns:
- the file name of the temporary file
- Throws:
CmsException
- if something goes wrong
-
flushMessageCache
public void flushMessageCache()
Flushes the cached workplace messages.
-
getAcaciaUnlock
public java.lang.String getAcaciaUnlock()
Gets the value of the acacia-unlock configuration option (null if not set explicitly).- Returns:
- the value of the acacia-unlock configuration option
-
getAccountInfos
public java.util.List<CmsAccountInfo> getAccountInfos()
Returns the account infos.- Returns:
- the account infos
-
getAdditionalLogFolderConfiguration
public CmsAdditionalLogFolderConfig getAdditionalLogFolderConfiguration()
Gets the additional log folder configuration.- Returns:
- the additional log folder configuration
-
getCategoryFolder
public java.lang.String getCategoryFolder()
Returns the name of the local category folder(s).- Returns:
- the name of the local category folder(s)
-
getConfiguredAccountInfos
public java.util.List<CmsAccountInfo> getConfiguredAccountInfos()
Returns the configured account infos.- Returns:
- the configured account infos
-
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
-
getDefaultNamePattern
public java.lang.String getDefaultNamePattern(java.lang.String type)
Gets the default name pattern for the given type.- Parameters:
type
- the type name- Returns:
- the default name pattern for the type
-
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
-
getElementDeleteMode
public CmsCntPageData.ElementDeleteMode getElementDeleteMode()
Returns the element delete mode.- Returns:
- the element delete mode
-
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
-
getExplorerTypesForView
public java.util.List<CmsExplorerTypeSettings> getExplorerTypesForView(java.lang.String viewName)
Gets the explorer types for the given view name.- Parameters:
viewName
- the view name- Returns:
- the explorer names for the given view names
-
getExplorerTypeViews
public java.util.Map<CmsUUID,CmsElementView> getExplorerTypeViews()
Gets the element views generated from explorer types.- Returns:
- the map of element views from the explorer types
-
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
will be thrown.CmsRuntimeException
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
-
getGalleryDefaultScope
public CmsGallerySearchScope getGalleryDefaultScope()
Returns the gallery default scope.- Returns:
- the gallery default scope
-
getGalleryDefaultScopeString
public java.lang.String getGalleryDefaultScopeString()
Gets the configured gallery default scope as a string.- Returns:
- the gallery default scope as a string
-
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 interfaceI_CmsLocaleHandler
- Parameters:
req
- the current http requestuser
- the current userproject
- the current projectresource
- 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
-
getMessages
public CmsWorkplaceMessages getMessages(java.util.Locale locale)
Returns theCmsWorkplaceMessages
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
-
getPostUploadHandler
public I_CmsPostUploadDialogHandler getPostUploadHandler()
Returns the post upload handler.- Returns:
- the post upload handler
-
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
-
getRepositoryFolderHandler
public I_CmsRepositoryFolderHandler getRepositoryFolderHandler()
Returns the repository folder handler.- Returns:
- the repository folder handler
-
getSitemapConfigEditRole
public java.lang.String getSitemapConfigEditRole()
Gets the name of the role necessary for editing the sitemap configuration.- Returns:
- the name of the role necessary for editing the sitemap configuration
-
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 contextuploadFolder
- the folder for which the upload hook should be found- Returns:
- the URI of the upload hook or null
-
getUploadRestriction
public I_CmsUploadRestriction getUploadRestriction()
Gets the upload restriction.- Returns:
- the upload restriction
-
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
-
getWorkplaceExplorerTypeSettings
public java.util.List<CmsExplorerTypeSettings> getWorkplaceExplorerTypeSettings()
Returns the list of explorer type settings configured in the opencms-workplace.xml file.- Returns:
- the list of explorer type settings
-
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
-
getWorkplaceLocale
public java.util.Locale getWorkplaceLocale(CmsRequestContext requestContext)
Gets the workplace locale for the given request context.- Parameters:
requestContext
- the request context- Returns:
- the workplace locale for the request context
-
getWorkplaceLocale
public java.util.Locale getWorkplaceLocale(CmsUser user)
Returns the workplace locale for the user.- Parameters:
user
- the user to get the workplace locale for.- Returns:
- the workplace locale for the user.
-
initHandler
public void initHandler(CmsObject cms)
Description copied from interface:I_CmsLocaleHandler
Will be called during system startup.- Specified by:
initHandler
in interfaceI_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
role permissionsCmsRole.WORKPLACE_MANAGER
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
-
isDisplayCategoriesByRepository
public boolean isDisplayCategoriesByRepository()
Returns a flag, indicating if the categories should be displayed separated by repository in the category selection dialog.- Returns:
- a flag, indicating if the categories should be displayed separated by repository in the category selection dialog.
-
isDisplayCategorySelectionCollapsed
public boolean isDisplayCategorySelectionCollapsed()
Returns a flag, indicating if the category selection dialog should have all entries completely collapsed when opened.- Returns:
- a flag, indicating if the category selection dialog should have all entries completely collapsed when opened.
-
isEnableAdvancedPropertyTabs
public boolean isEnableAdvancedPropertyTabs()
Returns if tabs in the advanced property dialog are enabled.- Returns:
true
if tabs should be enabled, otherwisefalse
-
isKeepAlive
public boolean isKeepAlive()
Returns true if "keep alive" mode is active.- Returns:
- true if the session should be kept alive
-
isKeepAlive
public java.lang.Boolean isKeepAlive(boolean useDefault)
Returns true if the session should be kept alive.- Parameters:
useDefault
- if true, the default value will be returned if the "keep alive" setting is not explicitly configured- Returns:
- True if the "keep alive" mode is active
-
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, otherwisefalse
-
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
-
setAcaciaUnlock
public void setAcaciaUnlock(java.lang.String value)
Sets the value of the acacia-unlock configuration option.- Parameters:
value
- the value of the acacia-unlock configuration option
-
setAdditionalLogFolderConfiguration
public void setAdditionalLogFolderConfiguration(CmsAdditionalLogFolderConfig logConfig)
Sets the additional log folder configuration.- Parameters:
logConfig
- the additional log folder configuration
-
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
-
setCategoryDisplayOptions
public void setCategoryDisplayOptions(java.lang.String displayCategoriesByRepository, java.lang.String displayCategorySelectionCollapsed)
Sets the category display options that affect how the category selection dialog is shown.- Parameters:
displayCategoriesByRepository
- if true, the categories are shown separated by repository.displayCategorySelectionCollapsed
- if true, the selection dialog opens showing only the top-level categories (or the various repositories) in collapsed state.
-
setCategoryFolder
public void setCategoryFolder(java.lang.String categoryFolder)
Sets the name of the local category folder(s).- Parameters:
categoryFolder
- the name of the local category folder(s)
-
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
-
setElementDeleteMode
public void setElementDeleteMode(java.lang.String deleteMode)
Sets the element delete mode.- Parameters:
deleteMode
- the element delete mode
-
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
)
-
setGalleryDefaultScope
public void setGalleryDefaultScope(java.lang.String galleryDefaultScope)
Sets the gallery default scope.- Parameters:
galleryDefaultScope
- the gallery default scope
-
setGroupTranslationClass
public void setGroupTranslationClass(java.lang.String translationClassName)
Sets the group translation class name.- Parameters:
translationClassName
- the group translation class name
-
setKeepAlive
public void setKeepAlive(java.lang.String keepAlive)
Sets the "keep alive" mode.- Parameters:
keepAlive
- the keep-alive mode
-
setPostUploadHandler
public void setPostUploadHandler(I_CmsPostUploadDialogHandler uploadHandler)
Sets the post upload dialog handler.- Parameters:
uploadHandler
- the post upload handler
-
setRepositoryFolderHandler
public void setRepositoryFolderHandler(I_CmsRepositoryFolderHandler clazz)
Sets the repository folder handler.- Parameters:
clazz
- the repository folder handler
-
setSitemapConfigEditRole
public void setSitemapConfigEditRole(java.lang.String roleName)
Sets the name of the role necessary for editing the sitemap configuration.- Parameters:
roleName
- the name of the role necessary for editing the sitemap configuration
-
setToolManager
public void setToolManager(CmsToolManager toolManager)
Sets the tool Manager object.- Parameters:
toolManager
- the tool Manager object to set
-
setUploadRestriction
public void setUploadRestriction(I_CmsUploadRestriction uploadRestriction)
Sets the upload restriciton.- Parameters:
uploadRestriction
- the upload restriction
-
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
-
shouldAcaciaUnlock
public boolean shouldAcaciaUnlock()
Returns true if the Acacia editor in standalone mode should automatically unlock resources.- Returns:
- true if resources should be automatically unlocked in standalone mode
-
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 configuredI_CmsGroupNameTranslation
.- Parameters:
groupName
- the group namekeepOu
- if true, the OU will be appended to the translated name- Returns:
- the translated group name
-
-