org.jboss.web.tomcat.tc5.sso
Interface SSOClusterManager

All Known Implementing Classes:

TreeCacheSSOClusterManager (src)

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.

See Also:

ClusteredSingleSignOn (src)

addSession

public void addSession(java.lang.String ssoId,
                       Session session)

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

Parameters:

ssoId - the id of the SSO session

session - the Session that has been added

getSingleSignOnValve

public ClusteredSingleSignOn (src)  getSingleSignOnValve()

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

Returns:

the SingleSignOn valve.

setSingleSignOnValve

public void setSingleSignOnValve(ClusteredSingleSignOn (src)  valve)

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.

Parameters:

valve - a SingleSignOn valve.

logout

public void logout(java.lang.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

public org.jboss.web.tomcat.tc5.sso.SingleSignOnEntry lookup(java.lang.String ssoId)

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

Parameters:

ssoId - the id of the SSO session

Returns:

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

register

public void register(java.lang.String ssoId,
                     java.lang.String authType,
                     java.lang.String username,
                     java.lang.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

public void removeSession(java.lang.String ssoId,
                          Session session)

Notify the cluster of the removal of a Session from an SSO session.

Parameters:

ssoId - the id of the SSO session

session - the Session that has been removed

updateCredentials

public void updateCredentials(java.lang.String ssoId,
                              java.lang.String authType,
                              java.lang.String username,
                              java.lang.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