|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.plumtree.uiinfrastructure.login.Authenticator
public class Authenticator
This is the main authenticator module, the single entry point for performing authentication. Internally, it communicates with other authentication modules (TokenAuthenticator, HTTPBasicAuthenticator and SSOAuthenticator) to decide which authentication method is applicable to current request, and it may fail over to a different authentication method if one method fails (e.g., if login token auth fails, it will try HTTP basic auth, and if that fails, it will log in as guest).
Field Summary | |
---|---|
static java.lang.String |
GUESTLOGIN_GUESTUSERID
|
static java.lang.String |
GUESTLOGIN_GUESTUSERNAME
|
static java.lang.String |
GUESTLOGIN_REDIRECTONLOGOUT
|
static java.lang.String |
GUESTLOGIN_REDIRECTTOLOGIN
|
static java.lang.String |
GUESTLOGIN_SSOVENDOR
|
static java.lang.String |
LOGINPAGESPACE_ATTR_KEY
|
protected HTTPBasicAuthenticator |
m_HTTPBasicAuth
|
protected SSOAuthenticator |
m_SSOAuth
|
protected TokenAuthenticator |
m_TokenAuth
|
Method Summary | |
---|---|
static Redirect |
GetGuestLoginRedirect(IApplication application,
ISessionManager sessionManager,
IXPRequest request,
java.lang.Object userSession)
This method calculates the appropriate login page for the guest user. |
static Redirect |
GetGuestLoginRedirect(RequestData _requestData)
This method calculates the appropriate login page for the guest user. |
static Authenticator |
GetInstance()
|
Redirect |
GetOrSendLoginChallenge(RequestData requestData)
Returns a Redirect object to the login page, or issues an HTTP redirect to the login page. |
LoginResult |
Login(RequestData requestData)
Performs the login operation. |
boolean |
Logout(RequestData requestData)
Performs the logout operation. |
boolean |
UseThisAuth(RequestData requestData)
Since this is the main authenticator module, it always returns a boolean true. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String GUESTLOGIN_GUESTUSERNAME
public static final java.lang.String GUESTLOGIN_GUESTUSERID
public static final java.lang.String GUESTLOGIN_SSOVENDOR
public static final java.lang.String GUESTLOGIN_REDIRECTTOLOGIN
public static final java.lang.String GUESTLOGIN_REDIRECTONLOGOUT
public static final java.lang.String LOGINPAGESPACE_ATTR_KEY
protected TokenAuthenticator m_TokenAuth
protected HTTPBasicAuthenticator m_HTTPBasicAuth
protected SSOAuthenticator m_SSOAuth
Method Detail |
---|
public static Authenticator GetInstance()
public LoginResult Login(RequestData requestData)
Login
in interface IAuthenticator
requestData
- the request
com.plumtree.uiinfrastructure.login.IAuthenticator#Login(com.plumtree.uiinfrastructure.application.RequestData)
public Redirect GetOrSendLoginChallenge(RequestData requestData)
GetOrSendLoginChallenge
in interface IAuthenticator
requestData
- the request
com.plumtree.uiinfrastructure.login.IAuthenticator#GetOrSendLoginChallenge(com.plumtree.uiinfrastructure.application.RequestData)
public static Redirect GetGuestLoginRedirect(RequestData _requestData)
_requestData
- The current request data.
public static Redirect GetGuestLoginRedirect(IApplication application, ISessionManager sessionManager, IXPRequest request, java.lang.Object userSession)
application
- sessionManager
- request
- userSession
-
public boolean Logout(RequestData requestData)
Logout
in interface IAuthenticator
requestData
- the request
com.plumtree.uiinfrastructure.login.IAuthenticator#Logout(com.plumtree.uiinfrastructure.application.RequestData)
public boolean UseThisAuth(RequestData requestData)
UseThisAuth
in interface IAuthenticator
com.plumtree.uiinfrastructure.login.IAuthenticator#UseThisAuth(com.plumtree.uiinfrastructure.application.RequestData)
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |