Package org.opencms.workplace

Class CmsWorkplaceManager

java.lang.Object
org.opencms.workplace.CmsWorkplaceManager
All Implemented Interfaces:
I_CmsLocaleHandler, I_CmsEventListener
public final class CmsWorkplaceManager extends 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 Details

  • Constructor Details

    • CmsWorkplaceManager

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

  • Method Details

    • 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(String field, String addInfoKey, String editable)
      Adds an account info.

      Parameters:
      field - the field
      addInfoKey - the additional info key
      editable - 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(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(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(String uri, 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(String uri)
      Adds a folder to the list of labeled folders.

      Parameters:
      uri - the folder uri to add

    • addLocalizedFolder

      public void addLocalizedFolder(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(String resourceTypeName, 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(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

    • checkAdeGalleryUpload

      public void checkAdeGalleryUpload(CmsObject cms) throws CmsSecurityException
      Checks if the user in the given context has permissions for uploading.
      Parameters:
      cms - a CMS context
      Throws:
      CmsSecurityException - if the user doesn't have permission

    • 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 check
      cms - the CmsObject to use

    • 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:

    • createTempFile

      public String createTempFile(CmsObject cms, 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

    • flushMessageCache

      public void flushMessageCache()
      Flushes the cached workplace messages.

    • getAcaciaUnlock

      public 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 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 String getCategoryFolder()
      Returns the name of the local category folder(s).

      Returns:
      the name of the local category folder(s)

    • getConfiguredAccountInfos

      public 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 Locale getDefaultLocale()
      Returns the Workplace default locale.

      Returns:
      the Workplace default locale

    • getDefaultNamePattern

      public String getDefaultNamePattern(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 Map<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(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 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 String getEncoding()
      Returns the configured workplace encoding.

      Returns:
      the configured workplace encoding

    • getExplorerTypeSetting

      public CmsExplorerTypeSettings getExplorerTypeSetting(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 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 List<CmsExplorerTypeSettings> getExplorerTypesForView(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 Map<CmsUUID,CmsElementView> getExplorerTypeViews()
      Gets the element views generated from explorer types.

      Returns:
      the map of element views from the explorer types

    • getExportPoints

      public 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 Map<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 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 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, 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:

    • getLabelSiteFolders

      public List<String> getLabelSiteFolders()
      Returns a list of site folders which generate labeled links.

      Returns:
      a list of site folders which generate labeled links

    • getLocales

      public List<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 List<String> getLocalizedFolders()
      Returns the configured list of localized workplace folders.

      Returns:
      the configured list of localized workplace folders

    • getMessages

      public CmsWorkplaceMessages getMessages(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

    • 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 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 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 ArrayList<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 String getUploadHook(CmsObject cms, 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

    • 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 String getUserListModeString()
      Returns the user list mode as a string.

      Returns:
      the user list mode as a string

    • getViews

      public List<CmsWorkplaceView> getViews()
      Returns the map of configured workplace views.

      Returns:
      the map of configured workplace views

    • getVirusScanner

      public I_CmsVirusScanner getVirusScanner()
      Gets the configured virus scanner (may be null).
      Returns:
      the configured virus scanner

    • getWorkplaceEditorManager

      public CmsWorkplaceEditorManager getWorkplaceEditorManager()
      Returns the instantiated workplace editor manager class.

      Returns:
      the instantiated workplace editor manager class

    • getWorkplaceExplorerTypeSettings

      public 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 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 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 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 interface I_CmsLocaleHandler
      Parameters:
      cms - an initialized cms permission context for VFS access
      See Also:

    • 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

    • isAdeGalleryUploadDisabled

      public boolean isAdeGalleryUploadDisabled(CmsObject cms)
      Returns true if gallery upload is disabled for the user in the given context.
      Parameters:
      cms - a CMS context
      Returns:
      true if the upload is disabled

    • isAllowElementAuthorToWorkInGalleries

      public boolean isAllowElementAuthorToWorkInGalleries()
      Checks if element authors have special permission to work in galleries (upload/replace).
      Returns:
      true in the case above

    • 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, otherwise false

    • isKeepAlive

      public boolean isKeepAlive()
      Returns true if "keep alive" mode is active.
      Returns:
      true if the session should be kept alive

    • isKeepAlive

      public 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

    • isVirusScannerEnabled

      public boolean isVirusScannerEnabled()
      Checks if the virus scanner is enabled.
      Returns:
      true if the virus scanner is enabled

    • 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

    • setAcaciaUnlock

      public void setAcaciaUnlock(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

    • setAllowElementAuthorToWorkInGalleries

      public void setAllowElementAuthorToWorkInGalleries(boolean allowElementAuthorToWorkInGalleries)
      Enables/disables special permissions for element authors to work with galleries (upload/replace).
      Parameters:
      allowElementAuthorToWorkInGalleries - true if the special permissions should be enabled for element authors

    • setAutoLock

      public void setAutoLock(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(String displayCategoriesByRepository, 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(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(String locale)
      Sets the Workplace default locale.

      Parameters:
      locale - the locale to set

    • setDefaultPropertiesOnStructure

      public void setDefaultPropertiesOnStructure(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(String deleteMode)
      Sets the element delete mode.

      Parameters:
      deleteMode - the element delete mode

    • setEnableAdvancedPropertyTabs

      public void setEnableAdvancedPropertyTabs(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(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(String galleryDefaultScope)
      Sets the gallery default scope.

      Parameters:
      galleryDefaultScope - the gallery default scope

    • setGroupTranslationClass

      public void setGroupTranslationClass(String translationClassName)
      Sets the group translation class name.

      Parameters:
      translationClassName - the group translation class name

    • setKeepAlive

      public void setKeepAlive(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(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(String mode)
      Sets the user list mode.

      Parameters:
      mode - the user list mode

    • setUserManagementEnabled

      public void setUserManagementEnabled(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

    • setVirusScanner

      public void setVirusScanner(I_CmsVirusScanner virusScanner)
      Sets the virus scanner.
      Parameters:
      virusScanner - the virus scanner to set

    • setVirusScannerEnabled

      public void setVirusScannerEnabled(boolean enabled)
      Sets the virus scanner to enabled/disabled.
      Parameters:
      enabled - true if the virus scanner should be enabled

    • setXmlContentAutoCorrect

      public void setXmlContentAutoCorrect(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 String translateGroupName(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