Package org.opencms.ui.login

Class CmsLoginHelper.LoginParameters

java.lang.Object

org.opencms.ui.login.CmsLoginHelper.LoginParameters

All Implemented Interfaces:

Serializable

Enclosing class:

CmsLoginHelper

public static class CmsLoginHelper.LoginParameters
extends Object
implements Serializable

Holds the current login parameters.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
LoginParameters(String username, String pcType, String oufqn, String requestedResource, Locale locale, String authToken, boolean logout, boolean reset)	Constructor.

Method Summary

Modifier and Type	Method	Description
String	getAuthToken()	Gets the authorization token.
Locale	getLocale()	Returns the locale.
String	getOufqn()	Returns the ou fqn.
String	getPcType()	Returns the pc type.
String	getRequestedResource()	Returns the requested resource.
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 Details

LoginParameters

public LoginParameters(String username,
 String pcType,
 String oufqn,
 String requestedResource,
 Locale locale,
 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 Details

getAuthToken

public String getAuthToken()

Gets the authorization token.

Returns:

the authorization token

getLocale

public Locale getLocale()

Returns the locale.

Returns:

the locale

getOufqn

public String getOufqn()

Returns the ou fqn.

Returns:

the ou fqn

getPcType

public String getPcType()

Returns the pc type.

Returns:

the pc type

getRequestedResource

public String getRequestedResource()

Returns the requested resource.

Returns:

the requested resource

getUsername

public 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