Package org.opencms.jsp.userdata

Class CmsJspUserDataRequestBean

  • public class CmsJspUserDataRequestBean
extends java.lang.Object
    Bean used by the dynamic function JSP for user data requests.

    The dynamic function calls the action() method on this bean, which returns the new state for the JSP to render. Error/status messages are also available to the JSP via getters.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String ACTION_REQUEST
      Action id.
      static java.lang.String ACTION_VIEW
      Action id.
      static java.lang.String ACTION_VIEWAUTH
      Action id.
      static java.lang.String PARAM_ACTION
      Request parameter for the action.
      static java.lang.String PARAM_AUTH
      Request parameter for the authorization code.
      static java.lang.String PARAM_EMAIL
      Request parameter.
      static java.lang.String PARAM_PASSWORD
      Request parameter.
      static java.lang.String PARAM_ROOTPATH
      Request parameter.
      static java.lang.String PARAM_UDRID
      Request parameter.
      static java.lang.String PARAM_USER
      Request parameter.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String action​(CmsObject cms, java.util.Map<java.lang.String,​java.lang.String[]> reqParameters)
      Called by the user data request function JSP to handle the user data request logic.
      java.lang.String getDownloadLink()
      Gets the user data download link.
      java.lang.String getErrorHtml()
      Gets the error HTML (this is only shown in the error state).
      java.lang.String getInfoHtml()
      Gets the user data HTML.
      java.util.Map<java.lang.String,​java.lang.String> getTexts()
      Gets the lazy map used to access the configurable texts to display by the user data request dynamic function.
      boolean isError()
      Checks if the error HTML has been set.
      boolean isOnlyEmailRequired()
      Checks if we need to confirm the user's email rather than their user name and password.

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • action

        public java.lang.String action​(CmsObject cms,
                               java.util.Map<java.lang.String,​java.lang.String[]> reqParameters)
                        throws CmsException
        Called by the user data request function JSP to handle the user data request logic. Returns the next state which should be shown by the JSP.
        Parameters:
        cms - the CMS context
        reqParameters - the request parameters
        Returns:
        the next state to render
        Throws:
        CmsException - if something goes wrong

      • getDownloadLink

        public java.lang.String getDownloadLink()
        Gets the user data download link.
        Returns:
        the user data download link

      • getErrorHtml

        public java.lang.String getErrorHtml()
        Gets the error HTML (this is only shown in the error state).
        Returns:
        the error HTML

      • getInfoHtml

        public java.lang.String getInfoHtml()
        Gets the user data HTML.

        Returns:
        the user data HTML

      • getTexts

        public java.util.Map<java.lang.String,​java.lang.String> getTexts()
        Gets the lazy map used to access the configurable texts to display by the user data request dynamic function.
        Returns:
        the lazy map

      • isError

        public boolean isError()
        Checks if the error HTML has been set.
        Returns:
        true if the error HTML has been set

      • isOnlyEmailRequired

        public boolean isOnlyEmailRequired()
        Checks if we need to confirm the user's email rather than their user name and password.
        Returns:
        true if we only need the email address