Package org.opencms.ui.login
Class CmsLoginHelper.LoginParameters
- java.lang.Object
-
- org.opencms.ui.login.CmsLoginHelper.LoginParameters
-
- All Implemented Interfaces:
java.io.Serializable
- Enclosing class:
- CmsLoginHelper
public static class CmsLoginHelper.LoginParameters extends java.lang.Object implements java.io.Serializable
Holds the current login parameters.- See Also:
- Serialized Form
-
-
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.
-
-
-
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 namepcType
- the pc typeoufqn
- the ou fqnrequestedResource
- the requested resourcelocale
- the localeauthToken
- the authorization tokenlogout
- the logout flagreset
- 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
-
-