org.jaggeryjs.modules.sso.common.managers

Class SSOSessionManager

java.lang.Object

org.jaggeryjs.modules.sso.common.managers.SSOSessionManager

public class SSOSessionManager
extends Object

Maintains the sessions of apps which are SSOed together against the IDP provided session index It provides a set of convenience methods to Single Sign On and Single Logout.

Method Summary

Methods

Modifier and Type	Method and Description
void	cleanUp(org.jaggeryjs.hostobjects.web.SessionHostObject session, String serviceProvider) Removes the Service Provider session and IDP index details.This method should be called from a session destroy listener.Please note that this method will not attempt to invalidate the session and will assume that the session invalidate method has been already called.
static SSOSessionManager	getInstance()
void	login(String idpSessionIndex, String serviceProvider, org.jaggeryjs.hostobjects.web.SessionHostObject session) Registers the provided Session HostObject against the IDP session index.This mapping is used to Single Logout all sessions when the logout method is called
void	logout(org.jaggeryjs.hostobjects.web.SessionHostObject session, String serviceProvider) Handles the Single Logout operation by first resolving the session ID to a IDP session index
void	logout(String idpSessionIndex, String serviceProvider) Handles the Single Logout operation by invalidating the sessions mapped to the provided IDP session index.
void	logoutClusteredNodes(String idpSessionIndex, String serviceProvider) Handles the Single Logout operation by invalidating the sessions mapped to the provided IDP session index.It will attempt to notify all members with a message indicating that any sessions registered against the provided IDP session index should be invalidated.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static SSOSessionManager getInstance()

login

public void login(String idpSessionIndex,
         String serviceProvider,
         org.jaggeryjs.hostobjects.web.SessionHostObject session)

Registers the provided Session HostObject against the IDP session index.This mapping is used to Single Logout all sessions when the logout method is called

Parameters:

idpSessionIndex - The IDP session index provided in the SAML login response

session - A Session HostObject

logout

public void logout(String idpSessionIndex,
          String serviceProvider)

Handles the Single Logout operation by invalidating the sessions mapped to the provided IDP session index.

Parameters:

idpSessionIndex - A String key which is provided in the SAML login response indicating IDP session index

logout

public void logout(org.jaggeryjs.hostobjects.web.SessionHostObject session,
          String serviceProvider)

Handles the Single Logout operation by first resolving the session ID to a IDP session index

Parameters:

session -

cleanUp

public void cleanUp(org.jaggeryjs.hostobjects.web.SessionHostObject session,
           String serviceProvider)

Removes the Service Provider session and IDP index details.This method should be called from a session destroy listener.Please note that this method will not attempt to invalidate the session and will assume that the session invalidate method has been already called.

Parameters:

session -

serviceProvider -

logoutClusteredNodes

public void logoutClusteredNodes(String idpSessionIndex,
                        String serviceProvider)

Handles the Single Logout operation by invalidating the sessions mapped to the provided IDP session index.It will attempt to notify all members with a message indicating that any sessions registered against the provided IDP session index should be invalidated. Note: Message delivery is not guaranteed but this method will attempt to retry sending the message for a predefined retry count

Parameters:

idpSessionIndex - A String key which is provided in the SAML login response indicating IDP session index