Package org.opencms.ui.login

Class CmsLoginHelper.LoginParameters

    • Constructor Summary

      Constructors 
      Constructor Description
      LoginParameters​(java.lang.String username, java.lang.String pcType, java.lang.String oufqn, java.lang.String requestedResource, java.util.Locale locale, java.lang.String authToken, boolean logout, boolean reset)
      Constructor.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getAuthToken()
      Gets the authorization token.
      java.util.Locale getLocale()
      Returns the locale.
      java.lang.String getOufqn()
      Returns the ou fqn.
      java.lang.String getPcType()
      Returns the pc type.
      java.lang.String getRequestedResource()
      Returns the requested resource.
      java.lang.String getUsername()
      Returns the user name.
      boolean isLogout()
      Returns if a logout is requested.
      boolean isPrivatePc()
      Returns whether the pc type is private.
      boolean isReset()
      Returns true if we are in 'reset password' mode.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • LoginParameters

        public LoginParameters​(java.lang.String username,
                       java.lang.String pcType,
                       java.lang.String oufqn,
                       java.lang.String requestedResource,
                       java.util.Locale locale,
                       java.lang.String authToken,
                       boolean logout,
                       boolean reset)
        Constructor.

        Parameters:
        username - the user name
        pcType - the pc type
        oufqn - the ou fqn
        requestedResource - the requested resource
        locale - the locale
        authToken - the authorization token
        logout - the logout flag
        reset - flag to indicate whether we are in 'reset password' mode

    • Method Detail

      • getAuthToken

        public java.lang.String getAuthToken()
        Gets the authorization token.

        Returns:
        the authorization token

      • getLocale

        public java.util.Locale getLocale()
        Returns the locale.

        Returns:
        the locale

      • getOufqn

        public java.lang.String getOufqn()
        Returns the ou fqn.

        Returns:
        the ou fqn

      • getPcType

        public java.lang.String getPcType()
        Returns the pc type.

        Returns:
        the pc type

      • getRequestedResource

        public java.lang.String getRequestedResource()
        Returns the requested resource.

        Returns:
        the requested resource

      • getUsername

        public java.lang.String getUsername()
        Returns the user name.

        Returns:
        the user name

      • isLogout

        public boolean isLogout()
        Returns if a logout is requested.

        Returns:
        the logout flag

      • isPrivatePc

        public boolean isPrivatePc()
        Returns whether the pc type is private.

        Returns:
        true if the pc type is private

      • isReset

        public boolean isReset()
        Returns true if we are in 'reset password' mode.

        Returns:
        true in reset mode, false otherwise