Interface SSORealm

All Known Implementing Classes:
HashSSORealm, HashUserRealm, JDBCUserRealm

public interface SSORealm

Single Sign On Realm. This interface is a mix-in interface for the UserRealm interface. If an implementation of UserRealm also implements SSORealm, then single signon is supported for that realm.

Greg Wilkins (gregw)
See Also:

Method Summary
 void clearSingleSignOn(String username)
          Clear SSO for user.
 Credential getSingleSignOn(Request request, Response response)
          Get SSO credentials.
 void setSingleSignOn(Request request, Response response, Principal principal, Credential credential)
          Set SSO principal and credential.

Method Detail


Credential getSingleSignOn(Request request,
                           Response response)
Get SSO credentials. This call is used by an authenticator to check if a SSO exists for a request. If SSO authentiation is successful, the requests UserPrincipal and AuthUser fields are set. If available, the credential used to authenticate the user is returned. If recoverable credentials are not required then null may be return.

request - The request to SSO.
response - The response to SSO.
A credential if available for SSO authenticated requests.


void setSingleSignOn(Request request,
                     Response response,
                     Principal principal,
                     Credential credential)
Set SSO principal and credential. This call is used by an authenticator to inform the SSO mechanism that a user has signed on. The SSO mechanism should record the principal and credential and update the response with any cookies etc. required.

request - The authenticated request.
response - The authenticated response/
principal - The principal that has been authenticated.
credential - The credentials used to authenticate.


void clearSingleSignOn(String username)
Clear SSO for user.

username - The user to clear.