Top Description Methods
org.mortbay.jetty.security

public Interface SSORealm

Known Direct Implementers
org.mortbay.jetty.security.HashSSORealm, org.mortbay.jetty.security.HashUserRealm
Imports
java.security.Principal, org.mortbay.jetty.Request, .Response, .UserRealm
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.
Author
Greg Wilkins (gregw)
See Also
UserRealm

Method Summary

Modifier and TypeMethod and Description
public void
clearSingleSignOn(String
The user to clear.
username)

Clear SSO for user.

public Credential

Returns:

A credential if available for SSO authenticated requests.
getSingleSignOn(Request
The request to SSO.
request, Response
The response to SSO.
response)

Get SSO credentials.

public void
setSingleSignOn(Request
The authenticated request.
request, Response
The authenticated response/
response, Principal
The principal that has been authenticated.
principal, Credential
The credentials used to authenticate.
credential)

Set SSO principal and credential.

Method Detail

clearSingleSignOnback to summary
public void clearSingleSignOn(String username)

Clear SSO for user.

Parameters
username:String

The user to clear.

getSingleSignOnback to summary
public 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.

Parameters
request:Request

The request to SSO.

response:Response

The response to SSO.

Returns:Credential

A credential if available for SSO authenticated requests.

setSingleSignOnback to summary
public 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.

Parameters
request:Request

The authenticated request.

response:Response

The authenticated response/

principal:Principal

The principal that has been authenticated.

credential:Credential

The credentials used to authenticate.