com.plumtree.uiinfrastructure.activityspace.utils
Class LoginHandlers

java.lang.Object
  com.plumtree.uiinfrastructure.activityspace.utils.LoginHandlers

public class LoginHandlers
extends java.lang.Object

This class contains helper methods for the Interpreter class that handle Login.

Author:

donh

Field Summary

static java.lang.String	DEFAULTLOGINCONTROL
static boolean	DEFAULTSPACEISLOGIN mj: boolean value used by sso
static java.lang.String	LOGIN_OCCURED_COOKIE_NAME login occurred cookie name
static java.lang.String	LOGINCONTROL
static java.lang.String	LOGINSPACE Default login space information
static boolean	s_bGuestAccessAllowed mj: whether guest access is enabled.

Constructor Summary

LoginHandlers()

Method Summary

static void	ClearLoginOccurredCookiePresent(IXPResponse response) This method clears the login occurred cookie in the response.
static Redirect	DoGuestLogin(RequestData tempData) Handles guest login.
static Redirect	DoLogin(IControl loginControl, RequestData tempData) This helper method handles logging users in and out from the Login Control.
static Redirect	DoLogin(RequestData tempData) Helper method for login which can be called from SSO login code outside this class.
static void	DoLogin(java.lang.String strLoginToken, RequestData tempData) Helper method for login which can be called from SSO login code outside this class.
static void	DoLogout(RequestData tempData) helper method to log users out.
static boolean	GetIsAutoConnectEnabled(RequestData tempData) This method is used to determine if auto connect is enabled Turning off auto-connect only disables displaying the 'remember my password' checkbox on login and checking for the login token cookie.
static boolean	GetIsGuestRedirectToLoginEnabled(IApplication application, ISessionManager sessionManager) This method is used to determine if the guest user should be redirected to their default page or to the login page if a space is not specified.
static boolean	GetIsGuestRedirectToLoginEnabled(RequestData tempData) This method is used to determine if the guest user should be redirected to their default page or to the login page if a space is not specified.
static boolean	IsLoginOccurredCookiePresent(IXPRequest request) This helper method determines whether or not the login occurred cookie is present.
static void	StaticInit(ConfigVarPack varpack) Initializes static member variables from ConfigVarPack.

Methods inherited from class java.lang.Object

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

Field Detail

s_bGuestAccessAllowed

public static boolean s_bGuestAccessAllowed

mj: whether guest access is enabled.

LOGINSPACE

public static final java.lang.String LOGINSPACE

Default login space information

See Also:

Constant Field Values

LOGINCONTROL

public static final java.lang.String LOGINCONTROL

See Also:

Constant Field Values

DEFAULTLOGINCONTROL

public static final java.lang.String DEFAULTLOGINCONTROL

See Also:

Constant Field Values

DEFAULTSPACEISLOGIN

public static final boolean DEFAULTSPACEISLOGIN

mj: boolean value used by sso

See Also:

Constant Field Values

LOGIN_OCCURED_COOKIE_NAME

public static final java.lang.String LOGIN_OCCURED_COOKIE_NAME

login occurred cookie name

See Also:

Constant Field Values

Constructor Detail

LoginHandlers

public LoginHandlers()

Method Detail

StaticInit

public static void StaticInit(ConfigVarPack varpack)

Initializes static member variables from ConfigVarPack.

Parameters:

varpack - a ConfigVarPack

DoGuestLogin

public static Redirect DoGuestLogin(RequestData tempData)

Handles guest login. This is not technically thread safe, but the odds of anything catastrophic happening are fairly low, since multiple threads calling this simultaneously will only be writing the same data to the same places, with the sole exception of the IPTSession.

Parameters:

RequestData -

Returns:

Redirect object from login PEIs

DoLogin

public static Redirect DoLogin(RequestData tempData)

Helper method for login which can be called from SSO login code outside this class.

Parameters:

RequestData - the data for this HTTPRequest

Returns:

Redirect a redirect object from Guest Login PEIs, if it occured

DoLogin

public static void DoLogin(java.lang.String strLoginToken,
                           RequestData tempData)

Helper method for login which can be called from SSO login code outside this class.

Parameters:

RequestData - the data for this HTTPRequest

DoLogout

public static void DoLogout(RequestData tempData)

helper method to log users out.

Parameters:

RequestData - the data for this HTTPRequest

IsLoginOccurredCookiePresent

public static boolean IsLoginOccurredCookiePresent(IXPRequest request)

This helper method determines whether or not the login occurred cookie is present.

Parameters:

request -

Returns:

boolean true implies the cookie is present.

ClearLoginOccurredCookiePresent

public static void ClearLoginOccurredCookiePresent(IXPResponse response)

This method clears the login occurred cookie in the response.

Parameters:

response - IXPResponse The current response.

DoLogin

public static Redirect DoLogin(IControl loginControl,
                               RequestData tempData)

This helper method handles logging users in and out from the Login Control.

Parameters:

loginControl -

RequestData - the data for this HTTPRequest

GetIsAutoConnectEnabled

public static boolean GetIsAutoConnectEnabled(RequestData tempData)

This method is used to determine if auto connect is enabled Turning off auto-connect only disables displaying the 'remember my password' checkbox on login and checking for the login token cookie. Checking for the admin QS login token is always enabled.

Parameters:

RequestData -

Returns:

boolean true implies auto connect is enabled

GetIsGuestRedirectToLoginEnabled

public static boolean GetIsGuestRedirectToLoginEnabled(RequestData tempData)

This method is used to determine if the guest user should be redirected to their default page or to the login page if a space is not specified.

Parameters:

RequestData -

Returns:

boolean true implies the guest should redirect to login if no space is specified. Login is default.

GetIsGuestRedirectToLoginEnabled

public static boolean GetIsGuestRedirectToLoginEnabled(IApplication application,
                                                       ISessionManager sessionManager)

This method is used to determine if the guest user should be redirected to their default page or to the login page if a space is not specified.

Parameters:

application -

sessionManager -

Returns:

boolean true implies the guest should redirect to login if no space is specified. Login is default.