com.sun.identity.federation.services

Class FSSessionManager

java.lang.Object

com.sun.identity.federation.services.FSSessionManager

public final class FSSessionManager
extends Object

The class FSSessionManager is a final class that provides interfaces to manage FSSessions.

It is a singleton class; an instance of this class can be obtained by calling FSSessionManager.getInstance().

Field Summary

Fields

Modifier and Type	Field and Description
static Stats	sessStats For managing session statistics.

Method Summary

Modifier and Type	Method and Description
void	addSession(String userID, FSSession session) Adds a federation session to a user.
FSAuthnRequest	getAuthnRequest(String requestID) Returns authentication request associated with requestID.
String	getIDPEntityID(String requestID) Returns IDP's entity ID associated with requestID.
static FSSessionManager	getInstance(String metaAlias) Gets the singleton instance of FSSessionManager.
Object	getLocalSessionToken(String requestID) Returns local token associated with the request ID.
FSAuthnRequest	getProxySPAuthnRequest(String requestID) Returns proxy authentication request.
com.sun.identity.liberty.ws.meta.jaxb.SPDescriptorType	getProxySPDescriptor(String requestID) Returns proxy service provider descriptor.
String	getRelayState(String requestID) Gets the RelayState value which maps to the request ID.
FSSession	getSession(List sessions, String sessionIndex) Returns the session in sessions whose session index is sessionIndex.
FSSession	getSession(Object token) Returns session associated with token.
FSSession	getSession(String userID, String sessionID) Returns session with sessionID for userID.
List	getSessionList(String userID) Returns list of sessions associated with userID.
void	removeAuthnRequest(String requestID) Removes an authentication request.
void	removeLocalSessionToken(String requestID) Removes a local token associated with requestID.
void	removeProvider(String userID, String entityID, FSSession localSession) Removes entityID from userID's session partner list.
void	removeRelayState(String requestID) Removes the mapping for this request ID from the relayStateMap.
void	removeSession(String userID, FSSession session) Removes a federation session of an user.
void	removeSessionList(String userID) Removes session list associated with userID.
void	setAuthnRequest(String requestID, FSAuthnRequest authnRequest) Sets authentication request.
void	setIDPEntityID(String requestID, String idpEntityId) Sets IDP's entity ID.
void	setLocalSessionToken(String requestID, Object localSession) Sets local token.
void	setProxySPAuthnRequest(String requestID, FSAuthnRequest authnRequest) Sets proxy authentication request.
void	setProxySPDescriptor(String requestID, com.sun.identity.liberty.ws.meta.jaxb.SPDescriptorType spDescriptor) Sets proxy service provider descriptor.
void	setRelayState(String requestID, String relayState) Sets the RelayState value with the specified request ID in the relayStateMap.
void	setSessionList(String userID, List sessionList) Sets session list.

Methods inherited from class java.lang.Object

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

Field Detail

sessStats

public static Stats sessStats

For managing session statistics.

Method Detail

getRelayState

public String getRelayState(String requestID)

Gets the RelayState value which maps to the request ID.

Parameters:

requestID - request ID

Returns:

the RelayState value

setRelayState

public void setRelayState(String requestID,
                          String relayState)

Sets the RelayState value with the specified request ID in the relayStateMap.

Parameters:

requestID - request ID

relayState - the RelayState value

removeRelayState

public void removeRelayState(String requestID)

Removes the mapping for this request ID from the relayStateMap.

Parameters:

requestID - request ID

getAuthnRequest

public FSAuthnRequest getAuthnRequest(String requestID)

Returns authentication request associated with requestID.

Parameters:

requestID - authentication request ID

Returns:

authentication request associated with the request ID

setAuthnRequest

public void setAuthnRequest(String requestID,
                            FSAuthnRequest authnRequest)

Sets authentication request.

Parameters:

requestID - authentication request ID

authnRequest - authentication request

removeAuthnRequest

public void removeAuthnRequest(String requestID)

Removes an authentication request.

Parameters:

requestID - ID of the request to be removed

getLocalSessionToken

public Object getLocalSessionToken(String requestID)

Returns local token associated with the request ID.

Parameters:

requestID - request ID

Returns:

session object associated with the request ID

setLocalSessionToken

public void setLocalSessionToken(String requestID,
                                 Object localSession)

Sets local token.

Parameters:

requestID - request ID

localSession - token to be set

removeLocalSessionToken

public void removeLocalSessionToken(String requestID)

Removes a local token associated with requestID.

Parameters:

requestID - request ID

getIDPEntityID

public String getIDPEntityID(String requestID)

Returns IDP's entity ID associated with requestID.

Parameters:

requestID - request ID

Returns:

identity provider's entity ID

setIDPEntityID

public void setIDPEntityID(String requestID,
                           String idpEntityId)

Sets IDP's entity ID.

Parameters:

requestID - authentication request ID

idpEntityId - identity provider's entity ID to be set

setProxySPDescriptor

public void setProxySPDescriptor(String requestID,
                                 com.sun.identity.liberty.ws.meta.jaxb.SPDescriptorType spDescriptor)

Sets proxy service provider descriptor.

Parameters:

requestID - authentication request ID

spDescriptor - provider descriptor to be set

getProxySPDescriptor

public com.sun.identity.liberty.ws.meta.jaxb.SPDescriptorType getProxySPDescriptor(String requestID)

Returns proxy service provider descriptor.

Parameters:

requestID - request ID

Returns:

provider descriptor

getProxySPAuthnRequest

public FSAuthnRequest getProxySPAuthnRequest(String requestID)

Returns proxy authentication request.

Parameters:

requestID - authentication request ID

setProxySPAuthnRequest

public void setProxySPAuthnRequest(String requestID,
                                   FSAuthnRequest authnRequest)

Sets proxy authentication request.

Parameters:

requestID - request ID

authnRequest - proxy authentication request to be set.

getSessionList

public List getSessionList(String userID)

Returns list of sessions associated with userID.

Parameters:

userID - user ID

Returns:

list of sessions

setSessionList

public void setSessionList(String userID,
                           List sessionList)

Sets session list.

Parameters:

userID - user ID

sessionList - list of sessions to be set

removeSessionList

public void removeSessionList(String userID)

Removes session list associated with userID.

Parameters:

userID - user ID

getSession

public FSSession getSession(String userID,
                            String sessionID)

Returns session with sessionID for userID.

Parameters:

userID - user ID

sessionID - session ID

Returns:

FSSession object

getSession

public FSSession getSession(List sessions,
                            String sessionIndex)

Returns the session in sessions whose session index is sessionIndex.

Parameters:

sessions - list of FSSessions.

sessionIndex - session index

Returns:

FSSession object whose session index is sessionIndex

getSession

public FSSession getSession(Object token)

Returns session associated with token.

Parameters:

token - session object

Returns:

FSSession associated with the token

removeProvider

public void removeProvider(String userID,
                           String entityID,
                           FSSession localSession)

Removes entityID from userID's session partner list.

Parameters:

userID - user ID

entityID - entity ID of the provider to be removed

localSession - FSSession object

removeSession

public void removeSession(String userID,
                          FSSession session)

Removes a federation session of an user.

Parameters:

userID - user ID

session - federation session to be removed

addSession

public void addSession(String userID,
                       FSSession session)

Adds a federation session to a user.

Parameters:

userID - user ID

session - federation session to be added

getInstance

public static FSSessionManager getInstance(String metaAlias)

Gets the singleton instance of FSSessionManager.

Parameters:

metaAlias - hosted provider's metaAlias

Returns:

The singleton FSSessionManager instance for this provider