org.jboss.web.tomcat.service.sso.spi
Interface SSOClusterManager


public interface SSOClusterManager

Provides communications support between a SingleSignOn valve and other such valves configured for the same hostname within a server cluster.

Implementations of this interface must declare a public no-arguments constructor.

Version:
$Revision: 45726 $ $Date: 2006-06-21 21:50:00 +0200 (mer., 21 juin 2006) $
Author:
Brian E. Stansberry
See Also:
SSOLocalManager

Method Summary
 void addSession(String ssoId, FullyQualifiedSessionId sessionId)
          Notify the cluster of the addition of a Session to an SSO session.
 SSOLocalManager getSSOLocalManager()
          Gets the SSOLocalManager 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 setSSOLocalManager(SSOLocalManager localManager)
          Sets the SSOLocalManager 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.
 

Method Detail

addSession

void addSession(String ssoId,
                FullyQualifiedSessionId sessionId)
Notify the cluster of the addition of a Session to an SSO session.

Parameters:
ssoId - the id of the SSO session
sessionId - id of the Session that has been added

getSSOLocalManager

SSOLocalManager getSSOLocalManager()
Gets the SSOLocalManager valve for which this object is handling cluster communications.

Returns:
the SSOLocalManager valve.

setSSOLocalManager

void setSSOLocalManager(SSOLocalManager localManager)
Sets the SSOLocalManager 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.

Parameters:
localManager - a SSOLocalManager valve.

logout

void logout(String ssoId)
Notifies the cluster that a single sign on session has been terminated due to a user logout.

Parameters:
ssoId - the id of the SSO session

lookup

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.

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

void register(String ssoId,
              String authType,
              String username,
              String password)
Notifies the cluster of the creation of a new SSO entry.

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

void removeSession(String ssoId,
                   FullyQualifiedSessionId sessionId)
Notify the cluster of the removal of a Session from an SSO session.

Parameters:
ssoId - the id of the SSO session
sessionId - id of the Session that has been removed

updateCredentials

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.

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

start

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.

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

stop

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.

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


Copyright © 2009 JBoss, a division of Red Hat, Inc.. All Rights Reserved.