|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ILoginHelper
This interface defines the extensible login helper code. This is used by the Interpreter and SSO.
Method Summary | |
---|---|
java.lang.Object |
AttemptBasicAuthLogin(java.lang.String sEncodedCredentials)
Attempts to create and connect a new user session. |
java.lang.Object |
AttemptGuestLogin(int nUserID,
java.lang.Object token,
ISessionManager session,
IApplication application,
java.lang.String sRequestURL)
Multiple-guest-user support. |
java.lang.Object |
AttemptGuestLogin(java.lang.Object token,
ISessionManager session,
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 session,
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 session,
IApplication application,
java.lang.String sRequestURL)
Attempts to create and connect a new user session. |
ILink |
GetDefaultPageRedirect(ILink suppliedLink,
java.lang.Object userSession,
AActivitySpace asOwner)
Call this method to obtain a redirect to the default space. |
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. |
boolean |
GetIsGuestUser(java.lang.Object userSession)
This method returns whether or not the user is a guest user. |
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 COM process has been recycled - retuns a new session in the new process if it has, otherwise returns null. |
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. |
Method Detail |
---|
java.lang.Object AttemptLogin(java.lang.String sUserName, java.lang.String sPassword, java.lang.Object token, boolean bUseNumericConnect, ISessionManager session, IApplication application, java.lang.String sRequestURL)
java.lang.Object AttemptGuestLogin(java.lang.Object token, ISessionManager session, IApplication application, java.lang.String sRequestURL)
java.lang.Object AttemptGuestLogin(int nUserID, java.lang.Object token, ISessionManager session, IApplication application, java.lang.String sRequestURL)
java.lang.Object AttemptLogin(java.lang.String sLoginToken, ISessionManager session, IApplication application, java.lang.String sRequestURL, IXPRequest request)
java.lang.Object AttemptBasicAuthLogin(java.lang.String sEncodedCredentials)
java.lang.String GetUserSessionID(java.lang.Object userSession)
Object
- the user session
java.lang.String GetUserSessionName(java.lang.Object userSession)
Object
- the user session
boolean GetIsGuestUser(java.lang.Object userSession)
Object
- the user session
java.lang.String GetDetailedFailureMessage(java.lang.Exception exception, ISessionManager subSession, IApplication application)
Exception
- the login exception to interpretISessionManager
- the current subsession to useIApplication
- the application
ILink GetDefaultPageRedirect(ILink suppliedLink, java.lang.Object userSession, AActivitySpace asOwner)
ILink
- user supplied link that will get filled in with the
proper parameters. (Redirect or ASURL object)Object
- userSessionAActivitySpace
-
void SetAutologinToken(IWebData oWebData, java.lang.Object oUserSession, int nExpires, boolean bIsPersistentCookie, boolean bIsSecure)
oWebData
- oUserSession
- nExpires
- cookie expiration time in seconds. -1 means use default value.bIsPersistentCookie
- false means don't set an expires time
(expire at end of session).
* @param bIsSecure whether or not the login cookie is securejava.lang.Object HandleCOMPlusProcessRecycled(java.lang.Object userSession)
userSession
- Current user session
HTMLElementCollection GetStyleSheetLinks(java.lang.Object userSession, AActivitySpace asOwner)
userSession
- AActivitySpace
-
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |