com.plumtree.uiinfrastructure.login
Class SSOAuthenticator

java.lang.Object
  extended by com.plumtree.uiinfrastructure.login.SSOAuthenticator
All Implemented Interfaces:
IAuthenticator

public class SSOAuthenticator
extends java.lang.Object
implements IAuthenticator

The authentication module for SSO. It allows the caller to send a redirect to the SSO Login / Logout URL.

Author:
Mike Jahr (Original SSO code), WilliamA (Writing this new class)

Method Summary
static SSOAuthenticator GetInstance()
           
 Redirect GetOrSendLoginChallenge(RequestData requestData)
          This method sends an HTTP redirect to the SSO login URL.
 LoginResult Login(RequestData requestData)
          The actual login is performed by the SSO server, not here.
 boolean Logout(RequestData requestData)
          The method sends an HTTP redirect to the SSO logout URL.
 boolean UseThisAuth(RequestData requestData)
          This method indicates whether SSO authentication is applicable to current request.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

GetInstance

public static SSOAuthenticator GetInstance()

Login

public LoginResult Login(RequestData requestData)
The actual login is performed by the SSO server, not here. Thus, this method does nothing for SSO case.

Specified by:
Login in interface IAuthenticator
Parameters:
requestData - the request
Returns:
null since login is not performed here.
See Also:
com.plumtree.uiinfrastructure.login.IAuthenticator#Login(com.plumtree.uiinfrastructure.application.RequestData)

GetOrSendLoginChallenge

public Redirect GetOrSendLoginChallenge(RequestData requestData)
This method sends an HTTP redirect to the SSO login URL. If for some reason the redirect can not be generated/sent, this method will throw an InterpreterException.

Specified by:
GetOrSendLoginChallenge in interface IAuthenticator
Parameters:
requestData - the request
Returns:
null, indicating the login challenge redirect has been sent internally.
See Also:
com.plumtree.uiinfrastructure.login.IAuthenticator#GetOrSendLoginChallenge(com.plumtree.uiinfrastructure.application.RequestData)

Logout

public boolean Logout(RequestData requestData)
The method sends an HTTP redirect to the SSO logout URL.

Specified by:
Logout in interface IAuthenticator
Parameters:
requestData - the request
Returns:
a boolean indicating whether an HTTP redirect has been sent.
See Also:
com.plumtree.uiinfrastructure.login.IAuthenticator#Logout(com.plumtree.uiinfrastructure.application.RequestData)

UseThisAuth

public boolean UseThisAuth(RequestData requestData)
This method indicates whether SSO authentication is applicable to current request. Currently, SSO setting is portal-wide, and is not on per-request basis, so this method will return true as long as SSO is enabled in the configuration.

Specified by:
UseThisAuth in interface IAuthenticator
Returns:
a boolean indicating whether SSO is enabled.
See Also:
com.plumtree.uiinfrastructure.login.IAuthenticator#UseThisAuth(com.plumtree.uiinfrastructure.application.RequestData)



Copyright © 2002,2003,2004,2005 Plumtree Software, Inc., All Rights Reserved.