org.apache.catalina.authenticator
Class SingleSignOn

java.lang.Object
  |
  +--org.apache.catalina.valves.ValveBase
        |
        +--org.apache.catalina.authenticator.SingleSignOn

All Implemented Interfaces:

Contained, Valve

public class SingleSignOn

extends ValveBase

A Valve that supports a "single sign on" user experience, where the security identity of a user who successfully authenticates to one web application is propogated to other web applications in the same security domain. For successful use, the following requirements must be met:

• This Valve must be configured on the Container that represents a virtual host (typically an implementation of Host).
• The Realm that contains the shared user and role information must be configured on the same Container (or a higher one), and not overridden at the web application level.
• The web applications themselves must use one of the standard Authenticators found in the org.apache.catalina.authenticator package.

Version:

$Revision: 1.4 $ $Date: 2001/01/23 02:53:03 $

Author:

Craig R. McClanahan

Field Summary

protected java.util.HashMap	cache The cache of SingleSignOnEntry instances for authenticated Principals, keyed by the cookie value that is used to select them.
protected int	debug The debugging detail level for this component.
protected static java.lang.String	info Descriptive information about this Valve implementation.
protected static StringManager	sm The string manager for this package.

Fields inherited from class org.apache.catalina.valves.ValveBase

container

Constructor Summary

SingleSignOn()

Method Summary

void	deregister(java.lang.String cookie) Deregister the specified cookie value for the single sign on cookie.
int	getDebug() Return the debugging detail level.
java.lang.String	getInfo() Return descriptive information about this Valve implementation.
void	invoke(Request request, Response response, ValveContext context) Perform single-sign-on support processing for this request.
protected void	log(java.lang.String message) Log a message on the Logger associated with our Container (if any).
protected void	log(java.lang.String message, java.lang.Throwable throwable) Log a message on the Logger associated with our Container (if any).
protected org.apache.catalina.authenticator.SingleSignOnEntry	lookup(java.lang.String cookie) Look up and return the cached Principal associated with this cookie value, if there is one; otherwise return null.
void	register(java.lang.String cookie, java.security.Principal principal, java.lang.String authType) Register the specified Principal as being associated with the specified value for the single sign on cookie.
void	setDebug(int debug) Set the debugging detail level.
java.lang.String	toString() Return a String rendering of this object.

Methods inherited from class org.apache.catalina.valves.ValveBase

getContainer, setContainer

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

cache

protected java.util.HashMap cache

The cache of SingleSignOnEntry instances for authenticated Principals, keyed by the cookie value that is used to select them.

debug

protected int debug

The debugging detail level for this component.

info

protected static java.lang.String info

Descriptive information about this Valve implementation.

sm

protected static final StringManager sm

The string manager for this package.

Constructor Detail

SingleSignOn

public SingleSignOn()

Method Detail

getDebug

public int getDebug()

Return the debugging detail level.

setDebug

public void setDebug(int debug)

Set the debugging detail level.

Parameters:

debug - The new debugging detail level

getInfo

public java.lang.String getInfo()

Return descriptive information about this Valve implementation.

Overrides:

getInfo in class ValveBase

invoke

public void invoke(Request request,
                   Response response,
                   ValveContext context)
            throws java.io.IOException,
                   javax.servlet.ServletException

Perform single-sign-on support processing for this request.

Overrides:

invoke in class ValveBase

Parameters:

request - The servlet request we are processing

response - The servlet response we are creating

context - The valve context used to invoke the next valve in the current processing pipeline

Throws:

java.io.IOException - if an input/output error occurs

javax.servlet.ServletException - if a servlet error occurs

deregister

public void deregister(java.lang.String cookie)

Deregister the specified cookie value for the single sign on cookie.

Parameters:

cookie - Cookie value for the single sign on cookie to deregister

register

public void register(java.lang.String cookie,
                     java.security.Principal principal,
                     java.lang.String authType)

Register the specified Principal as being associated with the specified value for the single sign on cookie.

Parameters:

cookie - Cookie value for the single sign on cookie

principal - Associated user principal that is identified

authType - Authentication type used to authenticate this user principal

toString

public java.lang.String toString()

Return a String rendering of this object.

Overrides:

toString in class java.lang.Object

log

protected void log(java.lang.String message)

Log a message on the Logger associated with our Container (if any).

Parameters:

message - Message to be logged

log

protected void log(java.lang.String message,
                   java.lang.Throwable throwable)

Log a message on the Logger associated with our Container (if any).

Parameters:

message - Message to be logged

throwable - Associated exception

lookup

protected org.apache.catalina.authenticator.SingleSignOnEntry lookup(java.lang.String cookie)

Look up and return the cached Principal associated with this cookie value, if there is one; otherwise return null.

Parameters:

cookie - Cookie value to look up