Package org.wildfly.security.http.util.sso

Class DefaultSingleSignOnSession

java.lang.Object

org.wildfly.security.http.util.sso.DefaultSingleSignOnSession

All Implemented Interfaces:

AutoCloseable, IdentityCache, SingleSignOnSession

public class DefaultSingleSignOnSession
extends Object
implements SingleSignOnSession

SingleSignOnSession that delegates its persistence strategy to a SingleSignOnManager. SingleSignOn entries are created lazily in response to put(SecurityIdentity).
This implementation supports single logout in order to invalidate local sessions for each participant of a single sign-on session, where participants represent the applications with active sessions associated with a given single sign-on session.

Author:

Paul Ferraro

Constructor Summary

Constructors

Constructor	Description
DefaultSingleSignOnSession(SingleSignOnSessionContext context, HttpServerRequest request, String mechanismName, boolean programmatic)
DefaultSingleSignOnSession(SingleSignOnSessionContext context, HttpServerRequest request, SingleSignOn sso)

Method Summary

Modifier and Type	Method	Description
void	close()	Closes any resources associated with this single sign-on session.
CachedIdentity	get()	Returns an identity previously cached.
String	getId()	The identifier associated with this session.
boolean	logout()	Performs a local logout if the incoming request is a logout message, otherwise do nothing.
void	put(SecurityIdentity identity)	Puts a SecurityIdentity into the cache.
CachedIdentity	remove()	Removes an identity from the cache.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultSingleSignOnSession

public DefaultSingleSignOnSession(SingleSignOnSessionContext context,
                                  HttpServerRequest request,
                                  String mechanismName,
                                  boolean programmatic)

DefaultSingleSignOnSession

public DefaultSingleSignOnSession(SingleSignOnSessionContext context,
                                  HttpServerRequest request,
                                  SingleSignOn sso)

Method Detail

getId

public String getId()

Description copied from interface: SingleSignOnSession

The identifier associated with this session.

Specified by:

getId in interface SingleSignOnSession

Returns:

identifier associated with this session

get

public CachedIdentity get()

Description copied from interface: IdentityCache

Returns an identity previously cached.

Specified by:

get in interface IdentityCache

Returns:

the cached identity or null if there is no identity in the cache

put

public void put(SecurityIdentity identity)

Description copied from interface: IdentityCache

Puts a SecurityIdentity into the cache.

Specified by:

put in interface IdentityCache

Parameters:

identity - the identity to cache (not null)

remove

public CachedIdentity remove()

Description copied from interface: IdentityCache

Removes an identity from the cache.

Specified by:

remove in interface IdentityCache

Returns:

the cached identity or null if there is no identity in the cache

logout

public boolean logout()

Description copied from interface: SingleSignOnSession

Performs a local logout if the incoming request is a logout message, otherwise do nothing.

Specified by:

logout in interface SingleSignOnSession

Returns:

true if local session was invalidated. Otherwise, false

close

public void close()

Description copied from interface: SingleSignOnSession

Closes any resources associated with this single sign-on session.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface SingleSignOnSession