com.sun.identity.federation.services.logout

Class FSReturnSessionManager

java.lang.Object

com.sun.identity.federation.services.logout.FSReturnSessionManager

public final class FSReturnSessionManager
extends Object

Contains session information for logout.

Method Summary

Modifier and Type	Method and Description
static FSReturnSessionManager	getInstance(String metaAlias) Gets the singleton instance of FSReturnSessionManager.
HashMap	getUserProviderInfo(String userDN) Returns the provider info where logout was initiated for a certain userDN.
void	removeUserProviderInfo(String userDN) Removes provider information for user.
void	setLogoutStatus(String logoutStatus, String userDN) Set logout status so that control of flow can be returned back to that provider to display status page of that provider.
void	setUserProviderInfo(String userDN, String providerId, String isIDP, String relayState, String responseTo) Sets the provider info where logout was initiated for a user.

Methods inherited from class java.lang.Object

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

Method Detail

getUserProviderInfo

public HashMap getUserProviderInfo(String userDN)

Returns the provider info where logout was initiated for a certain userDN. This is so that control of flow can be returned back to that provider to display status page of that provider.

Parameters:

userDN - user whose provider information is to be retrieved

Returns:

HashMap containing providerId, relaystate, sessionIndex, etc.

setLogoutStatus

public void setLogoutStatus(String logoutStatus,
                            String userDN)

Set logout status so that control of flow can be returned back to that provider to display status page of that provider.

Parameters:

logoutStatus - logout status to be saved

userDN - user whose provider information is to be retrieved

setUserProviderInfo

public void setUserProviderInfo(String userDN,
                                String providerId,
                                String isIDP,
                                String relayState,
                                String responseTo)

Sets the provider info where logout was initiated for a user. Other values that are needed when returning control back like relayState is also stored.

Parameters:

userDN - user whose provider information is to be retrieved

providerId - providerId where logout was initiated for this user

isIDP - the role of the source provider

relayState - url must be sent back in return

responseTo - InResponseTo value

removeUserProviderInfo

public void removeUserProviderInfo(String userDN)

Removes provider information for user. This function is called prior to returning after logout.

Parameters:

userDN - user whose logout is being performed

getInstance

public static FSReturnSessionManager getInstance(String metaAlias)

Gets the singleton instance of FSReturnSessionManager. There is a single instance for each hosted provider.

Returns:

metaAlias the hosted provider whose instance needs to be returned