|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
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 |
---|
void addSession(String ssoId, FullyQualifiedSessionId sessionId)
ssoId
- the id of the SSO sessionsessionId
- id of the Session that has been addedSSOLocalManager getSSOLocalManager()
SSOLocalManager
valve.void setSSOLocalManager(SSOLocalManager localManager)
NOTE: This method must be called before calls can be made to the other methods of this interface.
localManager
- a SSOLocalManager
valve.void logout(String ssoId)
ssoId
- the id of the SSO sessionSSOCredentials lookup(String ssoId)
SSOCredentials
if one is found.
ssoId
- the id of the SSO session
SSOCredentials
created using information
found on another cluster node, or null
if no
entry could be found.void register(String ssoId, String authType, String username, String password)
ssoId
- the id of the SSO sessionauthType
- the type of authenticator (BASIC, CLIENT-CERT, DIGEST
or FORM) used to authenticate the SSO.username
- the username (if any) used for the authenticationpassword
- the password (if any) used for the authenticationvoid removeSession(String ssoId, FullyQualifiedSessionId sessionId)
ssoId
- the id of the SSO sessionsessionId
- id of the Session that has been removedvoid updateCredentials(String ssoId, String authType, String username, String password)
ssoId
- the id of the SSO sessionauthType
- the type of authenticator (BASIC, CLIENT-CERT, DIGEST
or FORM) used to authenticate the SSO.username
- the username (if any) used for the authenticationpassword
- the password (if any) used for the authenticationvoid start() throws Exception
Exception
- if this component detects a fatal error
that prevents this component from being usedvoid stop() throws Exception
Exception
- if this component detects a fatal error
that needs to be reported
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |