|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.plumtree.portaluiinfrastructure.login.PTLoginHelper
public class PTLoginHelper
This class handles IPTSession login code.
Field Summary | |
---|---|
static long |
ALLOW_USER_CREATION_LINK_CACHE_LIFE_MS
This is the number of milliseconds for which the Boolean indicating whether or not the allow user creation link is cached on the application. |
Constructor Summary | |
---|---|
PTLoginHelper()
|
Method Summary | |
---|---|
static boolean |
AllowAuthDropdown()
Whether or not to allow the authentication source dropdown. |
java.lang.Object |
AttemptBasicAuthLogin(java.lang.String sEncodedCredentials)
Attempts to create and connect a new user session. |
protected IPTSession |
AttemptBasicAuthLogin(java.lang.String sEncodedCredentials,
java.lang.String sEncoding)
This helper method attempts to login using the credentials and decodes them with the specified encoding. |
java.lang.Object |
AttemptGuestLogin(int nUserID,
java.lang.Object token,
ISessionManager subSession,
IApplication application,
java.lang.String sRequestURL)
Multiple-guest-user support. |
java.lang.Object |
AttemptGuestLogin(java.lang.Object token,
ISessionManager subSession,
IApplication application,
java.lang.String sRequestURL)
Attempts to create and connect a new default guest user session. |
java.lang.Object |
AttemptLogin(java.lang.String sLoginToken,
ISessionManager subSession,
IApplication application,
java.lang.String sRequestURL,
IXPRequest request)
Attempts to create and connect a new user session. |
java.lang.Object |
AttemptLogin(java.lang.String sUserName,
java.lang.String sPassword,
java.lang.Object token,
boolean bUseNumericConnect,
ISessionManager subSession,
IApplication application,
java.lang.String sRequestURL)
Attempts to create and connect a new user session. |
static boolean |
GetAllowUserCreation(AActivitySpace space,
IApplication application)
This method returns whether or not to allow user creation and handles caching and refreshing of this value. |
ILink |
GetDefaultPageRedirect(ILink suppliedLink,
java.lang.Object userSession,
AActivitySpace asOwner)
Call this method to obtain a redirect to the default space. |
static java.lang.String |
GetDefaultPrefix()
The default prefix |
java.lang.String |
GetDetailedFailureMessage(java.lang.Exception exception,
ISessionManager subSession,
IApplication application)
This method gets an error message suitable for display to the user from the supplied exception (i.e. |
static int |
GetDropdownMode()
Return the dropdown mode specified in the portal configuration. |
boolean |
GetIsGuestUser(java.lang.Object userSession)
This method returns whether or not the user is a guest user. |
static IPTSession |
GetPTSession(AActivitySpace aSpace)
Method GetPTSession. |
HTMLElementCollection |
GetStyleSheetLinks(java.lang.Object userSession,
AActivitySpace asOwner)
Returns an HTMLElementCollection of style sheet links. |
java.lang.String |
GetUserSessionID(java.lang.Object userSession)
This method gets the user ID from the supplied user session object. |
java.lang.String |
GetUserSessionName(java.lang.Object userSession)
This method gets the user Name from the supplied user session object. |
java.lang.Object |
HandleCOMPlusProcessRecycled(java.lang.Object userSession)
Checks if the current process has been recycled. |
static void |
SetAllowUserCreation(AActivitySpace space,
IApplication application,
boolean b)
This method sets whether or not to allow user creation. |
void |
SetAutologinToken(IWebData oWebData,
java.lang.Object oUserSession,
int nExpires,
boolean bIsPersistentCookie,
boolean bIsSecure)
Call this method to set an autologin token for the user. |
static boolean |
ShowAuthDropdown()
Whether or not to show the authentication source dropdown. |
static boolean |
ShowRememberMyPassword()
Whether or not to show the remember my password checkbox. |
static void |
StaticInit(PTConfigVarPack vpConfig)
Initialize various variables from the xml file. |
protected boolean |
VerifyNoAlternateLogins(java.lang.String sEncodedCredentials,
int nSuccessfulEncoding)
This helper method verifies that after a successful login, no other character encodings could be used to get a successful login. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final long ALLOW_USER_CREATION_LINK_CACHE_LIFE_MS
Constructor Detail |
---|
public PTLoginHelper()
Method Detail |
---|
public java.lang.Object AttemptLogin(java.lang.String sUserName, java.lang.String sPassword, java.lang.Object token, boolean bUseNumericConnect, ISessionManager subSession, IApplication application, java.lang.String sRequestURL)
ILoginHelper
AttemptLogin
in interface ILoginHelper
com.plumtree.uiinfrastructure.login.ILoginHelper#AttemptLogin(String, String, Object, ISessionManager, IApplication)
public java.lang.Object AttemptGuestLogin(java.lang.Object token, ISessionManager subSession, IApplication application, java.lang.String sRequestURL)
ILoginHelper
AttemptGuestLogin
in interface ILoginHelper
com.plumtree.uiinfrastructure.login.ILoginHelper#AttemptGuestLogin(Object, ISessionManager, IApplication)
public java.lang.Object AttemptGuestLogin(int nUserID, java.lang.Object token, ISessionManager subSession, IApplication application, java.lang.String sRequestURL)
ILoginHelper
AttemptGuestLogin
in interface ILoginHelper
com.plumtree.uiinfrastructure.login.ILoginHelper#AttemptGuestLogin(int, Object, ISessionManager, IApplication)
public java.lang.Object AttemptLogin(java.lang.String sLoginToken, ISessionManager subSession, IApplication application, java.lang.String sRequestURL, IXPRequest request)
ILoginHelper
AttemptLogin
in interface ILoginHelper
com.plumtree.uiinfrastructure.login.ILoginHelper#AttemptLogin(String, ISessionManager, IApplication)
public java.lang.String GetUserSessionID(java.lang.Object userSession)
ILoginHelper
GetUserSessionID
in interface ILoginHelper
ILoginHelper.GetUserSessionID(Object)
public java.lang.String GetUserSessionName(java.lang.Object userSession)
ILoginHelper
GetUserSessionName
in interface ILoginHelper
ILoginHelper.GetUserSessionName(Object)
public boolean GetIsGuestUser(java.lang.Object userSession)
ILoginHelper
GetIsGuestUser
in interface ILoginHelper
ILoginHelper.GetIsGuestUser(Object)
public java.lang.String GetDetailedFailureMessage(java.lang.Exception exception, ISessionManager subSession, IApplication application)
ILoginHelper
GetDetailedFailureMessage
in interface ILoginHelper
ILoginHelper.GetDetailedFailureMessage(Exception, ISessionManager, IApplication)
public java.lang.Object AttemptBasicAuthLogin(java.lang.String sEncodedCredentials)
AttemptBasicAuthLogin
in interface ILoginHelper
protected IPTSession AttemptBasicAuthLogin(java.lang.String sEncodedCredentials, java.lang.String sEncoding)
sEncodedCredentials
- sEncoding
-
protected boolean VerifyNoAlternateLogins(java.lang.String sEncodedCredentials, int nSuccessfulEncoding)
sEncodedCredentials
- nSuccessfulEncoding
- the index into HTTPBasicAuthenticator.BASIC_AUTH_ENCODINGS_ORDERED
of the successful encoding.
public ILink GetDefaultPageRedirect(ILink suppliedLink, java.lang.Object userSession, AActivitySpace asOwner)
ILoginHelper
GetDefaultPageRedirect
in interface ILoginHelper
com.plumtree.uiinfrastructure.login.ILoginHelper#GetDefaultPageRedirect()
public static void SetAllowUserCreation(AActivitySpace space, IApplication application, boolean b)
space
- the current Activity Spaceapplication
- the applicationboolean
- whether or not to allow user creation.public static boolean GetAllowUserCreation(AActivitySpace space, IApplication application)
space
- The Activity Spaceapplication
- The Application
public static boolean ShowAuthDropdown()
public static boolean AllowAuthDropdown()
public static boolean ShowRememberMyPassword()
public static java.lang.String GetDefaultPrefix()
public static void StaticInit(PTConfigVarPack vpConfig)
public static IPTSession GetPTSession(AActivitySpace aSpace)
as
-
public void SetAutologinToken(IWebData oWebData, java.lang.Object oUserSession, int nExpires, boolean bIsPersistentCookie, boolean bIsSecure)
SetAutologinToken
in interface ILoginHelper
oWebData
- oUserSession
- nExpires
- cookie expiration time in minutes. -1 means use default value.
0 means don't set an expires time (expire at end of session).bIsPersistentCookie
- false means don't set an expires time
(expire at end of session).bIsSecure
- whether or not the login cookie is securepublic HTMLElementCollection GetStyleSheetLinks(java.lang.Object userSession, AActivitySpace asOwner)
GetStyleSheetLinks
in interface ILoginHelper
Pass
- in the userSession, this function will look up the stylesheet name
from the user's subportal.Pass
- in the ActivitySpace, this function will look up the current
user's language.public java.lang.Object HandleCOMPlusProcessRecycled(java.lang.Object userSession)
HandleCOMPlusProcessRecycled
in interface ILoginHelper
userSession
- Current user session
ILoginHelper.HandleCOMPlusProcessRecycled(java.lang.Object)
public static int GetDropdownMode()
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |