com.sun.identity.saml2.profile

Class IDPSession

java.lang.Object

com.sun.identity.saml2.profile.IDPSession

public class IDPSession
extends Object

This class represents a session in the identity provider side. It keeps track of information that is needed for single sign on as well as single log out.

Constructor Summary

Constructors

Constructor and Description
IDPSession(IDPSessionCopy idpSessionCopy)
IDPSession(Object session) Constructor for a IDPSession.

Method Summary

Modifier and Type	Method and Description
void	addSessionPartner(SAML2SessionPartner sessionPartner) Adds a session partner.
String	getAuthnContext() Returns authentication context.
SAML2SessionPartner	getCurrentSessionPartner() Returns the first session partner of the list of session partners.
boolean	getLogoutAll() Returns the logoutAll property.
String	getMetaAlias() Returns the IDP Meta Alias.
List<NameIDandSPpair>	getNameIDandSPpairs() Returns the list of NameID and SPEntityID pair of the session.
String	getOriginatingLogoutRequestBinding() Returns the original logout request binding.
String	getOriginatingLogoutRequestID() Returns the original log out request id of the session.
String	getOriginatingLogoutSPEntityID() Returns the original log out SPEntityID of the session.
String	getPendingLogoutRequestID() Returns the pending log out request id of the session.
Object	getSession() Returns the session object.
List	getSessionPartners() Returns list of session partners.
void	removeSessionPartner(String sessionPartner) Removes a session partner.
void	setAuthnContext(String authnContext) Sets authentication context.
void	setLogoutAll(boolean enable) Sets the logoutAll property.
void	setMetaAlias(String metaAlias) Sets the IDP Meta Alias.
void	setOriginatingLogoutRequestBinding(String originatingLogoutRequestBinding) Sets the original logout request binding.
void	setOriginatingLogoutRequestID(String id) Sets the original log out request id of the session.
void	setOriginatingLogoutSPEntityID(String id) Sets the original log out SPEntityID of the session.
void	setPendingLogoutRequestID(String id) Sets the pending log out request id of the session.
void	setSession(Object session) Sets the session object.

Methods inherited from class java.lang.Object

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

Constructor Detail

IDPSession

public IDPSession(Object session)

Constructor for a IDPSession.

Parameters:

session - the session object corresponding to the IDPSession

IDPSession

public IDPSession(IDPSessionCopy idpSessionCopy)

Method Detail

getSession

public Object getSession()

Returns the session object.

Returns:

the session object.

setSession

public void setSession(Object session)

Sets the session object.

Parameters:

session - The session object.

getNameIDandSPpairs

public List<NameIDandSPpair> getNameIDandSPpairs()

Returns the list of NameID and SPEntityID pair of the session.

Returns:

the list of NameID and SPEntityID pair of the session

setPendingLogoutRequestID

public void setPendingLogoutRequestID(String id)

Sets the pending log out request id of the session.

Parameters:

id - the request id

getPendingLogoutRequestID

public String getPendingLogoutRequestID()

Returns the pending log out request id of the session.

Returns:

id the pending log out request id

setOriginatingLogoutRequestBinding

public void setOriginatingLogoutRequestBinding(String originatingLogoutRequestBinding)

Sets the original logout request binding.

Parameters:

originatingLogoutRequestBinding - the original logout request binding.

getOriginatingLogoutRequestBinding

public String getOriginatingLogoutRequestBinding()

Returns the original logout request binding.

Returns:

The original logout request binding.

setOriginatingLogoutRequestID

public void setOriginatingLogoutRequestID(String id)

Sets the original log out request id of the session.

Parameters:

id - the request id

getOriginatingLogoutRequestID

public String getOriginatingLogoutRequestID()

Returns the original log out request id of the session.

Returns:

the original log out request id

setOriginatingLogoutSPEntityID

public void setOriginatingLogoutSPEntityID(String id)

Sets the original log out SPEntityID of the session.

Parameters:

id - the SPEntityID

getOriginatingLogoutSPEntityID

public String getOriginatingLogoutSPEntityID()

Returns the original log out SPEntityID of the session.

Returns:

the original log out SPEntityID

setLogoutAll

public void setLogoutAll(boolean enable)

Sets the logoutAll property.

Parameters:

enable - true or false

getLogoutAll

public boolean getLogoutAll()

Returns the logoutAll property.

Returns:

the logoutAll property.

getSessionPartners

public List getSessionPartners()

Returns list of session partners.

Returns:

list of session partners

addSessionPartner

public void addSessionPartner(SAML2SessionPartner sessionPartner)

Adds a session partner.

Parameters:

sessionPartner - session partner to be added

getCurrentSessionPartner

public SAML2SessionPartner getCurrentSessionPartner()

Returns the first session partner of the list of session partners.

Returns:

the first session partner of the list

removeSessionPartner

public void removeSessionPartner(String sessionPartner)

Removes a session partner.

Parameters:

sessionPartner - session partner to be removed

getAuthnContext

public String getAuthnContext()

Returns authentication context.

Returns:

authentication context

See Also:

setAuthnContext(String)

setAuthnContext

public void setAuthnContext(String authnContext)

Sets authentication context.

Parameters:

authnContext - authentication context to be set

See Also:

getAuthnContext()

setMetaAlias

public void setMetaAlias(String metaAlias)

Sets the IDP Meta Alias.

Parameters:

metaAlias - Meta Alias

getMetaAlias

public String getMetaAlias()

Returns the IDP Meta Alias.

Returns:

the IDP Meta Alias