org.jboss.as.clustering.web.sso.infinispan

Class SSOClusterManager

java.lang.Object

org.jboss.as.clustering.web.sso.infinispan.SSOClusterManager

All Implemented Interfaces:

SSOClusterManager

public final class SSOClusterManager
extends Object
implements SSOClusterManager

An implementation of SSOClusterManager that uses a Infinispan cache to share SSO information between cluster nodes.

Version:

$Revision: 109002 $ $Date: 2007-01-12 03:39:24 +0100 (ven., 12 janv. 2007) $

Author:

Brian E. Stansberry, Scott Marlow

Constructor Summary

Constructors

Constructor and Description
SSOClusterManager()

Method Summary

Methods

Modifier and Type	Method and Description
void	addDependencies(org.jboss.msc.service.ServiceTarget target, org.jboss.msc.service.ServiceBuilder<?> builder)
void	addSession(String ssoId, FullyQualifiedSessionId sessionId) Notify the cluster of the addition of a Session to an SSO session.
void	cacheEntryModified(org.infinispan.notifications.cachelistener.event.CacheEntryModifiedEvent<SSOKey,?> event) Extracts an SSO session id and uses it in an invocation of ClusteredSingleSignOn.update().
void	cacheEntryRemoved(org.infinispan.notifications.cachelistener.event.CacheEntryRemovedEvent<SSOKey,?> event) Extracts an SSO session id and uses it in an invocation of ClusteredSingleSignOn.deregister(String).
SSOLocalManager	getSSOLocalManager() Gets the SingleSignOn valve for which this object is handling cluster communications.
void	logout(String ssoId) Notifies the cluster that a single sign on session has been terminated due to a user logout.
SSOCredentials	lookup(String ssoId) Queries the cluster for the existence of a SSO session with the given id, returning a SSOCredentials if one is found.
void	register(String ssoId, String authType, String username, String password) Notifies the cluster of the creation of a new SSO entry.
void	removeSession(String ssoId, FullyQualifiedSessionId sessionId) Notify the cluster of the removal of a Session from an SSO session.
void	setCacheContainerName(String cacheContainerName)
void	setCacheName(String cacheName)
void	setSSOLocalManager(SSOLocalManager localManager) Sets the SingleSignOn valve for which this object is handling cluster communications.
void	start() Prepare for the beginning of active use of the public methods of this component.
void	stop() Gracefully terminate the active use of the public methods of this component.
void	updateCredentials(String ssoId, String authType, String username, String password) Notifies the cluster of an update of the security credentials associated with an SSO session.

Methods inherited from class java.lang.Object

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

Constructor Detail

SSOClusterManager

public SSOClusterManager()

Method Detail

addDependencies

public void addDependencies(org.jboss.msc.service.ServiceTarget target,
                   org.jboss.msc.service.ServiceBuilder<?> builder)

Specified by:

addDependencies in interface SSOClusterManager

setCacheContainerName

public void setCacheContainerName(String cacheContainerName)

Specified by:

setCacheContainerName in interface SSOClusterManager

setCacheName

public void setCacheName(String cacheName)

Specified by:

setCacheName in interface SSOClusterManager

addSession

public void addSession(String ssoId,
              FullyQualifiedSessionId sessionId)

Notify the cluster of the addition of a Session to an SSO session.

Specified by:

addSession in interface SSOClusterManager

Parameters:

ssoId - the id of the SSO session

sessionId - id of the Session that has been added

getSSOLocalManager

public SSOLocalManager getSSOLocalManager()

Gets the SingleSignOn valve for which this object is handling cluster communications.

Specified by:

getSSOLocalManager in interface SSOClusterManager

Returns:

the SingleSignOn valve.

setSSOLocalManager

public void setSSOLocalManager(SSOLocalManager localManager)

Sets the SingleSignOn valve for which this object is handling cluster communications.

NOTE: This method must be called before calls can be made to the other methods of this interface.

Specified by:

setSSOLocalManager in interface SSOClusterManager

Parameters:

localManager - a SingleSignOn valve.

logout

public void logout(String ssoId)

Notifies the cluster that a single sign on session has been terminated due to a user logout.

Specified by:

logout in interface SSOClusterManager

Parameters:

ssoId -

lookup

public SSOCredentials lookup(String ssoId)

Description copied from interface: SSOClusterManager

Queries the cluster for the existence of a SSO session with the given id, returning a SSOCredentials if one is found.

Specified by:

lookup in interface SSOClusterManager

Parameters:

ssoId - the id of the SSO session

Returns:

a SSOCredentials created using information found on another cluster node, or null if no entry could be found.

register

public void register(String ssoId,
            String authType,
            String username,
            String password)

Notifies the cluster of the creation of a new SSO entry.

Specified by:

register in interface SSOClusterManager

Parameters:

ssoId - the id of the SSO session

authType - the type of authenticator (BASIC, CLIENT-CERT, DIGEST or FORM) used to authenticate the SSO.

username - the username (if any) used for the authentication

password - the password (if any) used for the authentication

removeSession

public void removeSession(String ssoId,
                 FullyQualifiedSessionId sessionId)

Notify the cluster of the removal of a Session from an SSO session. May be called from ssoValue.deregister(String ssoId, String session)

Specified by:

removeSession in interface SSOClusterManager

Parameters:

ssoId - the id of the SSO session

sessionId - id of the Session that has been removed

updateCredentials

public void updateCredentials(String ssoId,
                     String authType,
                     String username,
                     String password)

Notifies the cluster of an update of the security credentials associated with an SSO session.

Specified by:

updateCredentials in interface SSOClusterManager

Parameters:

ssoId - the id of the SSO session

authType - the type of authenticator (BASIC, CLIENT-CERT, DIGEST or FORM) used to authenticate the SSO.

username - the username (if any) used for the authentication

password - the password (if any) used for the authentication

cacheEntryRemoved

public void cacheEntryRemoved(org.infinispan.notifications.cachelistener.event.CacheEntryRemovedEvent<SSOKey,?> event)

Extracts an SSO session id and uses it in an invocation of ClusteredSingleSignOn.deregister(String).

Ignores invocations resulting from Cache changes originated by this object.

Parameters:

event -

cacheEntryModified

public void cacheEntryModified(org.infinispan.notifications.cachelistener.event.CacheEntryModifiedEvent<SSOKey,?> event)

Extracts an SSO session id and uses it in an invocation of ClusteredSingleSignOn.update().

Ignores invocations resulting from Cache changes originated by this object.

Ignores invocations for SSO session id's that are not registered with the local SingleSignOn valve.

Parameters:

event -

start

public void start()
           throws Exception

Prepare for the beginning of active use of the public methods of this component. This method should be called before any of the public methods of this component are utilized. It should also send a LifecycleEvent of type START_EVENT to any registered listeners.

Specified by:

start in interface SSOClusterManager

Throws:

Exception - if this component detects a fatal error that prevents this component from being used

stop

public void stop()
          throws Exception

Gracefully terminate the active use of the public methods of this component. This method should be the last one called on a given instance of this component. It should also send a LifecycleEvent of type STOP_EVENT to any registered listeners.

Specified by:

stop in interface SSOClusterManager

Throws:

Exception - if this component detects a fatal error that needs to be reported