Package org.opencms.workplace

Class CmsWorkplace

java.lang.Object
org.opencms.workplace.CmsWorkplace
Direct Known Subclasses:
CmsToolDialog
public abstract class CmsWorkplace extends Object
Master class for the JSP based workplace which provides default methods and session handling for all JSP workplace classes.

Since:
6.0.0

  • Field Details

  • Constructor Details

    • CmsWorkplace

      public CmsWorkplace(CmsJspActionElement jsp)
      Public constructor.

      Parameters:
      jsp - the initialized JSP context

    • CmsWorkplace

      public CmsWorkplace(CmsObject cms, javax.servlet.http.HttpSession session)
      Constructor in case no page context is available.

      Parameters:
      cms - the current user context
      session - the session

    • CmsWorkplace

      public CmsWorkplace(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
      Public constructor with JSP variables.

      Parameters:
      context - the JSP page context
      req - the JSP request
      res - the JSP response

  • Method Details

    • buildSelect

      public static String buildSelect(String parameters, List<String> options, List<String> values, int selected, boolean useLineFeed)
      Generates a html select box out of the provided values.

      Parameters:
      parameters - a string that will be inserted into the initial select tag, if null no parameters will be inserted
      options - the options
      values - the option values, if null the select will have no value attributes
      selected - the index of the pre-selected option, if -1 no option is pre-selected
      useLineFeed - if true, adds some formatting "\n" to the output String
      Returns:
      a String representing a html select box

    • canEditPermissionsForRoles

      public static boolean canEditPermissionsForRoles(CmsObject cms, String path)
      Checks if permissions for roles should be editable for the current user on the resource with the given path.

      Parameters:
      cms - the CMS context
      path - the path of a resource
      Returns:
      true if permissions for roles should be editable for the current user on the resource with the given path

    • generateCssStyle

      public static String generateCssStyle(CmsObject cms)
      Returns the style sheets for the report.

      Parameters:
      cms - the current users context
      Returns:
      the style sheets for the report

    • generatePageEndExtended

      public static String generatePageEndExtended()
      Generates the footer for the extended report view.

      Returns:
      html code

    • generatePageEndSimple

      public static String generatePageEndSimple()
      Generates the footer for the simple report view.

      Returns:
      html code

    • generatePageStartExtended

      public static String generatePageStartExtended(CmsObject cms, String encoding)
      Generates the header for the extended report view.

      Parameters:
      cms - the current users context
      encoding - the encoding string
      Returns:
      html code

    • generatePageStartSimple

      public static String generatePageStartSimple(CmsWorkplace wp)
      Generates the header for the simple report view.

      Parameters:
      wp - the workplace instance
      Returns:
      html code

    • getResourceUri

      public static String getResourceUri(String resourceName)
      Returns the full Workplace resource path to the selected resource.

      Parameters:
      resourceName - the name of the resource to get the resource path for
      Returns:
      the full Workplace resource path to the selected resource

    • getSkinUri

      public static String getSkinUri()
      Returns the path to the skin resources.

      Returns:
      the path to the skin resources

    • getStartSiteRoot

      public static String getStartSiteRoot(CmsObject cms, CmsUserSettings userSettings)
      Returns the start site from the given user settings.

      Parameters:
      cms - the cms context
      userSettings - the user settings
      Returns:
      the start site root

    • getStartSiteRoot

      public static String getStartSiteRoot(CmsObject cms, CmsWorkplaceSettings settings)
      Returns the start site from the given workplace settings.

      Parameters:
      cms - the cms context
      settings - the workplace settings
      Returns:
      the start site root

    • getStaticResourceUri

      public static String getStaticResourceUri(String resourceName)
      Returns the URI to static resources served from the class path.

      Parameters:
      resourceName - the resource name
      Returns:
      the URI

    • getStaticResourceUri

      public static String getStaticResourceUri(String resourceName, String versionInfo)
      Returns the URI to static resources served from the class path.

      Parameters:
      resourceName - the resource name
      versionInfo - add an additional version info parameter to avoid browser caching issues
      Returns:
      the URI

    • getStyleUri

      public static String getStyleUri(CmsJspActionElement jsp)
      Returns the path to the cascading stylesheets.

      Parameters:
      jsp - the JSP context
      Returns:
      the path to the cascading stylesheets

    • getStyleUri

      public static String getStyleUri(CmsJspActionElement jsp, String filename)
      Returns the path to the cascading stylesheets.

      Parameters:
      jsp - the JSP context
      filename - the name of the stylesheet
      Returns:
      the path to the cascading stylesheets

    • getTemporaryFileName

      public static String getTemporaryFileName(String resourceName)
      Returns the temporary file name for the given resource name.

      To create a temporary file name of a resource name, the prefix char '~' (tilde) is added to the file name after all parent folder names have been removed.

      Parameters:
      resourceName - the resource name to return the temporary file name for
      Returns:
      the temporary file name for the given resource name
      See Also:

    • getWorkplaceExplorerLink

      public static String getWorkplaceExplorerLink(CmsJspActionElement jsp, String explorerRootPath)
      Creates a link for the OpenCms workplace that will reload the whole workplace, switch to the explorer view, the site of the given explorerRootPath and show the folder given in the explorerRootPath.

      Parameters:
      jsp - needed for link functionality.
      explorerRootPath - a root relative folder link (has to end with '/').
      Returns:
      a link for the OpenCms workplace that will reload the whole workplace, switch to the explorer view, the site of the given explorerRootPath and show the folder given in the explorerRootPath.

    • getWorkplaceExplorerLink

      public static String getWorkplaceExplorerLink(CmsObject cms, String explorerRootPath)
      Creates a link for the OpenCms workplace that will reload the whole workplace, switch to the explorer view, the site of the given explorerRootPath and show the folder given in the explorerRootPath.

      Parameters:
      cms - the cms object
      explorerRootPath - a root relative folder link (has to end with '/').
      Returns:
      a link for the OpenCms workplace that will reload the whole workplace, switch to the explorer view, the site of the given explorerRootPath and show the folder given in the explorerRootPath.

    • getWorkplaceSettings

      public static CmsWorkplaceSettings getWorkplaceSettings(CmsObject cms, javax.servlet.http.HttpServletRequest req)
      Returns the workplace settings of the current user.

      Parameters:
      cms - the cms context
      req - the request
      Returns:
      the workplace settings or null if the user is not logged in

    • initUserSettings

      public static CmsWorkplaceSettings initUserSettings(CmsObject cms, CmsWorkplaceSettings settings, boolean update)
      Updates the user settings in the given workplace settings for the current user, reading the user settings from the database if required.

      Parameters:
      cms - the cms object for the current user
      settings - the workplace settings to update (if null a new instance is created)
      update - flag indicating if settings are only updated (user preferences)
      Returns:
      the current users workplace settings
      See Also:

    • initWorkplaceSettings

      public static CmsWorkplaceSettings initWorkplaceSettings(CmsObject cms, CmsWorkplaceSettings settings, boolean update)
      Updates the given workplace settings, also re-initializing the state of the Workplace to the users preferences (for example setting the startup site and project). The user settings will also be updated by calling initUserSettings(CmsObject, CmsWorkplaceSettings, boolean) before updating the workplace project, selected site etc.

      Parameters:
      cms - the cms object for the current user
      settings - the workplace settings to update (if null a new instance is created)
      update - flag indicating if settings are only updated (user preferences)
      Returns:
      the current users initialized workplace settings
      See Also:

    • isTemporaryFile

      public static boolean isTemporaryFile(CmsResource resource)
      Returns true if the given resource is a temporary file.

      A resource is considered a temporary file it is a file where the CmsResource.FLAG_TEMPFILE flag has been set, or if the file name (without parent folders) starts with the prefix char '~' (tilde).

      Parameters:
      resource - the resource name to check
      Returns:
      true if the given resource name is a temporary file
      See Also:

    • substituteSiteTitleStatic

      public static String substituteSiteTitleStatic(String title, Locale locale)
      Substitutes the site title.

      Parameters:
      title - the raw site title
      locale - the localel
      Returns:
      the locale specific site title

    • updateUserPreferences

      public static void updateUserPreferences(CmsObject cms, javax.servlet.http.HttpServletRequest req)
      Updates the user preferences after changes have been made.

      Parameters:
      cms - the current cms context
      req - the current http request

    • allParamsAsHidden

      public String allParamsAsHidden()
      Returns all parameters of the current workplace class as hidden field tags that can be inserted in a form.

      Returns:
      all parameters of the current workplace class as hidden field tags that can be inserted in a html form

    • allParamsAsRequest

      public String allParamsAsRequest()
      Returns all present request parameters as String.

      The String is formatted as a parameter String (param1=val1&param2=val2) with UTF-8 encoded values.

      Returns:
      all present request parameters as String

    • bodyEnd

      public String bodyEnd()
      Builds the end html of the body.

      Returns:
      the end html of the body

    • bodyStart

      public String bodyStart(String className)
      Builds the start html of the body.

      Parameters:
      className - optional class attribute to add to the body tag
      Returns:
      the start html of the body

    • bodyStart

      public String bodyStart(String className, String parameters)
      Builds the start html of the body.

      Parameters:
      className - optional class attribute to add to the body tag
      parameters - optional parameters to add to the body tag
      Returns:
      the start html of the body

    • buildSelect

      public String buildSelect(String parameters, List<String> options, List<String> values, int selected)
      Generates a html select box out of the provided values.

      Parameters:
      parameters - a string that will be inserted into the initial select tag, if null no parameters will be inserted
      options - the options
      values - the option values, if null the select will have no value attributes
      selected - the index of the pre-selected option, if -1 no option is pre-selected
      Returns:
      a formatted html String representing a html select box

    • button

      public String button(String href, String target, String image, String label, int type)
      Generates a button for the OpenCms workplace.

      Parameters:
      href - the href link for the button, if none is given the button will be disabled
      target - the href link target for the button, if none is given the target will be same window
      image - the image name for the button, skin path will be automattically added as prefix
      label - the label for the text of the button
      type - 0: image only (default), 1: image and text, 2: text only
      Returns:
      a button for the OpenCms workplace

    • button

      public String button(String href, String target, String image, String label, int type, String imagePath)
      Generates a button for the OpenCms workplace.

      Parameters:
      href - the href link for the button, if none is given the button will be disabled
      target - the href link target for the button, if none is given the target will be same window
      image - the image name for the button, skin path will be automattically added as prefix
      label - the label for the text of the button
      type - 0: image only (default), 1: image and text, 2: text only
      imagePath - the path to the image
      Returns:
      a button for the OpenCms workplace

    • buttonBar

      public String buttonBar(int segment)
      Returns the html for a button bar.

      Parameters:
      segment - the HTML segment (START / END)
      Returns:
      a button bar html start / end segment

    • buttonBar

      public String buttonBar(int segment, String attributes)
      Returns the html for a button bar.

      Parameters:
      segment - the HTML segment (START / END)
      attributes - optional attributes for the table tag
      Returns:
      a button bar html start / end segment

    • buttonBarHorizontalLine

      public String buttonBarHorizontalLine()
      Generates a horizontal button bar separator line with maximum width.

      Returns:
      a horizontal button bar separator line

    • buttonBarLabel

      public String buttonBarLabel(String label)
      Generates a button bar label.

      Parameters:
      label - the label to show
      Returns:
      a button bar label

    • buttonBarLabel

      public String buttonBarLabel(String label, String className)
      Generates a button bar label.

      Parameters:
      label - the label to show
      className - the css class name for the formatting
      Returns:
      a button bar label

    • buttonBarLine

      public String buttonBarLine(int leftPixel, int rightPixel, String className)
      Generates a variable button bar separator line.

      Parameters:
      leftPixel - the amount of pixel left to the line
      rightPixel - the amount of pixel right to the line
      className - the css class name for the formatting
      Returns:
      a variable button bar separator line

    • buttonBarLineSpacer

      public String buttonBarLineSpacer(int pixel)
      Generates a variable button bar separator line spacer.

      Parameters:
      pixel - the amount of pixel space
      Returns:
      a variable button bar separator line spacer

    • buttonBarSeparator

      public String buttonBarSeparator(int leftPixel, int rightPixel)
      Generates a button bar separator.

      Parameters:
      leftPixel - the amount of pixel left to the separator
      rightPixel - the amount of pixel right to the separator
      Returns:
      a button bar separator

    • buttonBarSpacer

      public String buttonBarSpacer(int width)
      Returns the html for an invisible spacer between button bar contents like buttons, labels, etc.

      Parameters:
      width - the width of the invisible spacer
      Returns:
      the html for the invisible spacer

    • buttonBarStartTab

      public String buttonBarStartTab(int leftPixel, int rightPixel)
      Generates a button bar starter tab.

      Parameters:
      leftPixel - the amount of pixel left to the starter
      rightPixel - the amount of pixel right to the starter
      Returns:
      a button bar starter tab

    • checkLock

      public void checkLock(String resource) throws CmsException
      Checks the lock state of the resource and locks it if the autolock feature is enabled.

      Parameters:
      resource - the resource name which is checked
      Throws:
      CmsException - if reading or locking the resource fails

    • checkLock

      public void checkLock(String resource, CmsLockType type) throws CmsException
      Checks the lock state of the resource and locks it if the autolock feature is enabled.

      Parameters:
      resource - the resource name which is checked
      type - indicates the mode CmsLockType.EXCLUSIVE or CmsLockType.TEMPORARY
      Throws:
      CmsException - if reading or locking the resource fails

    • fillParamValues

      public void fillParamValues(CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)
      First sets site and project in the workplace settings, then fills all class parameter values from the data provided in the current request.

      Parameters:
      settings - the workplace settings
      request - the current request

    • fillParamValues

      public void fillParamValues(javax.servlet.http.HttpServletRequest request)
      Fills all class parameter values from the data provided in the current request.

      All methods that start with "setParam" are possible candidates to be automatically filled. The remaining part of the method name is converted to lower case. Then a parameter of this name is searched in the request parameters. If the parameter is found, the "setParam" method is automatically invoked by reflection with the value of the parameter.

      Parameters:
      request - the current JSP request

    • getBroadcastMessageString

      public String getBroadcastMessageString()
      Returns the message String for the broadcast message alert of the workplace.

      Caution: returns the pure message String (not escaped) or null, if no message is pending.

      Returns:
      the message String for the broadcast message alert of the workplace

    • getCms

      public CmsObject getCms()
      Returns the initialized cms object for the current user.

      Returns:
      the initialized cms object for the current user

    • getEncoding

      public String getEncoding()
      Returns the current workplace encoding.

      Returns:
      the current workplace encoding

    • getExplorerFileListFullUri

      public String getExplorerFileListFullUri()
      Returns the uri (including context path) to the explorer file list.

      Returns:
      the uri (including context path) to the explorer file list

    • getFrameSource

      public String getFrameSource(String frameName, String uri)
      Returns the html for the frame name and source and stores this information in the workplace settings.

      Parameters:
      frameName - the name of the frame
      uri - the absolute path of the frame
      Returns:
      the html for the frame name and source

    • getJsp

      public CmsJspActionElement getJsp()
      Returns the JSP action element.

      Returns:
      the JSP action element

    • getLocale

      public Locale getLocale()
      Returns the current users workplace locale settings.

      Returns:
      the current users workplace locale setting

    • getMacroResolver

      public CmsMacroResolver getMacroResolver()
      Returns the current used macro resolver instance.

      Returns:
      the macro resolver

    • getMessages

      public CmsMessages getMessages()
      Returns the current used message object.

      Returns:
      the current used message object

    • getMultiPartFileItems

      public List<org.apache.commons.fileupload.FileItem> getMultiPartFileItems()
      Returns a list of FileItem instances parsed from the request, in the order that they were transmitted.

      This list is automatically initialized from the createParameterMapFromMultiPart(HttpServletRequest) method.

      Returns:
      list of FileItem instances parsed from the request, in the order that they were transmitted

    • getResourceUri

      public String getResourceUri()
      Returns the path to the workplace static resources.

      Workplaces static resources are images, css files etc. These are exported during the installation of OpenCms, and are usually only read from this exported location to avoid the overhaead of accessing the database later.

      Returns:
      the path to the workplace static resources

    • getSession

      public javax.servlet.http.HttpSession getSession()
      Returns the current user http session.

      Returns:
      the current user http session

    • getSettings

      public CmsWorkplaceSettings getSettings()
      Returns the current users workplace settings.

      Returns:
      the current users workplace settings

    • getStyleUri

      public String getStyleUri(String filename)
      Returns the path to the cascading stylesheets.

      Parameters:
      filename - the name of the stylesheet
      Returns:
      the path to the cascading stylesheets

    • htmlEnd

      public String htmlEnd()
      Builds the end html of the page.

      Returns:
      the end html of the page

    • htmlStart

      public String htmlStart(String title)
      Builds the start html of the page, including setting of DOCTYPE and inserting a header with the content-type.

      Parameters:
      title - the content for the title tag
      Returns:
      the start html of the page

    • initSettings

      public boolean initSettings(CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)
      Sets site and project in the workplace settings with the request values of parameters PARAM_WP_SITE and PARAM_WP_PROJECT.

      Parameters:
      settings - the workplace settings
      request - the current request
      Returns:
      true, if a reload of the main body frame is required

    • isForwarded

      public boolean isForwarded()
      Returns the forwarded flag.

      Returns:
      the forwarded flag

    • isHelpEnabled

      public boolean isHelpEnabled()
      Returns true if the online help for the users current workplace language is installed.

      Returns:
      true if the online help for the users current workplace language is installed

    • isSubElement

      public boolean isSubElement()
      Returns true if the currently processed element is an included sub element.

      Returns:
      true if the currently processed element is an included sub element

    • key

      public String key(String keyName)
      Returns the localized resource string for a given message key, checking the workplace default resources and all module bundles.

      If the key was not found, the return value is "??? " + keyName + " ???".

      If the key starts with "help." and is not found, the value "index.html" is returned.

      Parameters:
      keyName - the key for the desired string
      Returns:
      the resource string for the given key
      See Also:

    • key

      public String key(String keyName, Object[] params)
      Returns the localized resource string for a given message key, with the provided replacement parameters.

      If the key was found in the bundle, it will be formatted using a MessageFormat using the provided parameters.

      If the key was not found in the bundle, the return value is "??? " + keyName + " ???". This will also be returned if the bundle was not properly initialized first.

      Parameters:
      keyName - the key for the desired string
      params - the parameters to use for formatting
      Returns:
      the resource string for the given key
      See Also:

    • keyDefault

      public String keyDefault(String keyName, String defaultValue)
      Returns the localized resource string for the given message key, checking the workplace default resources and all module bundles.

      If the key was not found, the provided default value is returned.

      Parameters:
      keyName - the key for the desired string
      defaultValue - the default value in case the key does not exist in the bundle
      Returns:
      the resource string for the given key it it exists, or the given default if not
      See Also:

    • nullToEmpty

      public String nullToEmpty(String value)
      Returns the empty String "" if the provided value is null, otherwise just returns the provided value.

      Use this method in forms if a getParamXXX method is used, but a String (not null) is required.

      Parameters:
      value - the String to check
      Returns:
      the empty String "" if the provided value is null, otherwise just returns the provided value

    • pageBody

      public String pageBody(int segment, String className, String parameters)
      Builds the html of the body.

      Parameters:
      segment - the HTML segment (START / END)
      className - optional class attribute to add to the body tag
      parameters - optional parameters to add to the body tag
      Returns:
      the html of the body

    • pageHtml

      public String pageHtml(int segment, String title)
      Returns the default html for a workplace page, including setting of DOCTYPE and inserting a header with the content-type.

      Parameters:
      segment - the HTML segment (START / END)
      title - the title of the page, if null no title tag is inserted
      Returns:
      the default html for a workplace page

    • pageHtmlStyle

      public String pageHtmlStyle(int segment, String title, String stylesheet)
      Returns the default html for a workplace page, including setting of DOCTYPE and inserting a header with the content-type, allowing the selection of an individual style sheet.

      Parameters:
      segment - the HTML segment (START / END)
      title - the title of the page, if null no title tag is inserted
      stylesheet - the used style sheet, if null the default stylesheet 'workplace.css' is inserted
      Returns:
      the default html for a workplace page

    • paramsAsHidden

      public String paramsAsHidden()
      Returns all initialized parameters of the current workplace class as hidden field tags that can be inserted in a form.

      Returns:
      all initialized parameters of the current workplace class as hidden field tags that can be inserted in a html form

    • paramsAsHidden

      public String paramsAsHidden(Collection<String> excludes)
      Returns all initialized parameters of the current workplace class that are not in the given exclusion list as hidden field tags that can be inserted in a form.

      Parameters:
      excludes - the parameters to exclude
      Returns:
      all initialized parameters of the current workplace class that are not in the given exclusion list as hidden field tags that can be inserted in a form

    • paramsAsParameterMap

      public Map<String,String[]> paramsAsParameterMap()
      Returns all initialized parameters of the current workplace class in the form of a parameter map, i.e. the values are arrays.

      Returns:
      all initialized parameters of the current workplace class in the form of a parameter map

    • paramsAsRequest

      public String paramsAsRequest()
      Returns all initialized parameters of the current workplace class as request parameters, i.e. in the form key1=value1&key2=value2 etc.
      Returns:
      all initialized parameters of the current workplace class as request parameters

    • resolveMacros

      public String resolveMacros(String input)
      Resolves the macros in the given String and replaces them by their localized keys.

      The following macro contexts are available in the Workplace:

      • Macros based on the current users OpenCms context (obtained from the current CmsObject).
      • Localized key macros (obtained from the current CmsMessages).
      • Macros from the current JSP page context (obtained by getJsp()).
      Parameters:
      input - the input String containing the macros
      Returns:
      the resolved String
      See Also:

    • sendCmsRedirect

      public void sendCmsRedirect(String location) throws IOException
      Sends a http redirect to the specified URI in the OpenCms VFS.

      Parameters:
      location - the location the response is redirected to
      Throws:
      IOException - in case redirection fails

    • sendForward

      public void sendForward(String location, Map<String,String[]> params) throws IOException, javax.servlet.ServletException
      Forwards to the specified location in the OpenCms VFS.

      Parameters:
      location - the location the response is redirected to
      params - the map of parameters to use for the forwarded request
      Throws:
      IOException - in case the forward fails
      javax.servlet.ServletException - in case the forward fails

    • setForwarded

      public void setForwarded(boolean forwarded)
      Sets the forwarded flag.

      Parameters:
      forwarded - the forwarded flag to set

    • shortKey

      public String shortKey(String keyName)
      Get a localized short key value for the workplace.

      Parameters:
      keyName - name of the key
      Returns:
      a localized short key value

    • addMessages

      protected void addMessages(CmsMessages messages)
      Auxiliary method for initialization of messages.

      Parameters:
      messages - the CmsMessages to add

    • addMessages

      protected void addMessages(String bundleName)
      Auxiliary method for initialization of messages.

      Parameters:
      bundleName - the resource bundle name to add

    • allParamValues

      protected Map<String,Object> allParamValues()
      Returns the values of all parameter methods of this workplace class instance.

      Returns:
      the values of all parameter methods of this workplace class instance

    • checkRole

      protected void checkRole() throws CmsRoleViolationException
      Checks that the current user is a workplace user.

      Throws:
      CmsRoleViolationException - if the user does not have the required role

    • decodeParamValue

      protected String decodeParamValue(String paramName, String paramValue)
      Decodes an individual parameter value.

      In special cases some parameters might require a different-from-default encoding. This is the case if the content of the parameter was encoded using the JavaScript encodeURIComponent() method on the client, which always encodes in UTF-8.

      Parameters:
      paramName - the name of the parameter
      paramValue - the unencoded value of the parameter
      Returns:
      the encoded value of the parameter

    • getParameterMap

      protected Map<String,String[]> getParameterMap()
      Returns the map of parameters read from the current request.

      This method will also handle parameters from forms of type multipart/form-data.

      Returns:
      the map of parameters read from the current request

    • initMessages

      protected void initMessages()
      Initializes the message object.

      By default the CmsWorkplaceMessages are initialized.

      You SHOULD override this method for setting the bundles you really need, using the addMessages(CmsMessages) or addMessages(String) method.

    • initTimeWarp

      protected void initTimeWarp(CmsUserSettings settings, javax.servlet.http.HttpSession session)
      Sets the users time warp if configured and if the current timewarp setting is different or clears the current time warp setting if the user has no configured timewarp.

      Timwarping is controlled by the session attribute CmsContextInfo.ATTRIBUTE_REQUEST_TIME with a value of type Long.

      Parameters:
      settings - the user settings which are configured via the preferences dialog
      session - the session of the user

    • initWorkplaceMembers

      protected void initWorkplaceMembers(CmsJspActionElement jsp)
      Initializes this workplace class instance.

      This method can be used in case there a workplace class was generated using Class.forName(java.lang.String) to initialize the class members.

      Parameters:
      jsp - the initialized JSP context

    • initWorkplaceMembers

      protected void initWorkplaceMembers(CmsObject cms, javax.servlet.http.HttpSession session)
      Initializes this workplace class instance.

      Parameters:
      cms - the user context
      session - the session

    • initWorkplaceRequestValues

      protected abstract void initWorkplaceRequestValues(CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)
      Analyzes the request for workplace parameters and adjusts the workplace settings accordingly.

      Parameters:
      settings - the workplace settings
      request - the current request

    • paramValues

      protected Map<String,Object> paramValues()
      Returns the values of all parameter methods of this workplace class instance.

      Returns:
      the values of all parameter methods of this workplace class instance

    • substituteSiteTitle

      protected String substituteSiteTitle(String title)
      Replaces the site title, if necessary.

      Parameters:
      title - the site title
      Returns:
      the new site title

    • switchToCurrentProject

      protected void switchToCurrentProject() throws CmsException
      Helper method to change back from the temporary project to the current project.

      Throws:
      CmsException - if switching back fails

    • switchToTempProject

      protected CmsUUID switchToTempProject() throws CmsException
      Helper method to change the current project to the temporary file project.

      The id of the old project is stored in a member variable to switch back.

      Returns:
      the id of the tempfileproject
      Throws:
      CmsException - if getting the tempfileproject id fails