| java.lang.Object
 org.apache.catalina.valves.ValveBase
org.apache.catalina.authenticator.SingleSignOn
| SingleSignOn | | public class SingleSignOn extends ValveBase implements Lifecycle,SessionListener(Code) | | 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.
author:
Craig R. McClanahan
version:
$Revision: 1.11 $ $Date: 2002/06/09 02:19:41 $ |
| Field Summary | |
| protected 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 String | info
Descriptive information about this Valve implementation. | | protected LifecycleSupport | lifecycle
The lifecycle event support for this component. | | protected HashMap | reverse
The cache of single sign on identifiers, keyed by the Session that is
associated with them. | | final protected static StringManager | sm
The string manager for this package. | | protected boolean | started
Component started flag. |
| Method Summary | |
| public void | addLifecycleListener(LifecycleListener listener)
Add a lifecycle event listener to this component. | | void | associate(String ssoId, Session session)
Associate the specified single sign on identifier with the
specified Session. | | void | deregister(String ssoId)
Deregister the specified single sign on identifier, and invalidate
any associated sessions. | | public LifecycleListener[] | findLifecycleListeners()
Get the lifecycle listeners associated with this lifecycle. | | public int | getDebug()
Return the debugging detail level. | | public String | getInfo()
Return descriptive information about this Valve implementation. | | public void | invoke(Request request, Response response, ValveContext context)
Perform single-sign-on support processing for this request. | | protected void | log(String message)
Log a message on the Logger associated with our Container (if any). | | protected void | log(String message, Throwable throwable)
Log a message on the Logger associated with our Container (if any). | | protected SingleSignOnEntry | lookup(String ssoId)
Look up and return the cached SingleSignOn entry associated with this
sso id value, if there is one; otherwise return null. | | void | register(String ssoId, Principal principal, String authType, String username, String password)
Register the specified Principal as being associated with the specified
value for the single sign on identifier. | | public void | removeLifecycleListener(LifecycleListener listener)
Remove a lifecycle event listener from this component. | | public void | sessionEvent(SessionEvent event)
Acknowledge the occurrence of the specified event. | | public void | setDebug(int debug)
Set the debugging detail level. | | public void | start()
Prepare for the beginning of active use of the public methods of this
component. | | public void | stop()
Gracefully terminate the active use of the public methods of this
component. | | public String | toString()
Return a String rendering of this object. |
| cache | | protected HashMap cache(Code) | | The cache of SingleSignOnEntry instances for authenticated Principals,
keyed by the cookie value that is used to select them.
|
| debug | | protected int debug(Code) | | The debugging detail level for this component.
|
| info | | protected static String info(Code) | | Descriptive information about this Valve implementation.
|
| reverse | | protected HashMap reverse(Code) | | The cache of single sign on identifiers, keyed by the Session that is
associated with them.
|
| started | | protected boolean started(Code) | | Component started flag.
|
| addLifecycleListener | | public void addLifecycleListener(LifecycleListener listener)(Code) | | Add a lifecycle event listener to this component.
Parameters:
listener - The listener to add |
| associate | | void associate(String ssoId, Session session)(Code) | | Associate the specified single sign on identifier with the
specified Session.
Parameters:
ssoId - Single sign on identifier
Parameters:
session - Session to be associated |
| deregister | | void deregister(String ssoId)(Code) | | Deregister the specified single sign on identifier, and invalidate
any associated sessions.
Parameters:
ssoId - Single sign on identifier to deregister |
| findLifecycleListeners | | public LifecycleListener[] findLifecycleListeners()(Code) | | Get the lifecycle listeners associated with this lifecycle. If this
Lifecycle has no listeners registered, a zero-length array is returned.
|
| getDebug | | public int getDebug()(Code) | | Return the debugging detail level.
|
| getInfo | | public String getInfo()(Code) | | Return descriptive information about this Valve implementation.
|
| invoke | | public void invoke(Request request, Response response, ValveContext context) throws IOException, ServletException(Code) | | Perform single-sign-on support processing for this request.
Parameters:
request - The servlet request we are processing
Parameters:
response - The servlet response we are creating
Parameters:
context - The valve context used to invoke the next valvein the current processing pipeline
exception:
IOException - if an input/output error occurs
exception:
ServletException - if a servlet error occurs |
| log | | protected void log(String message)(Code) | | Log a message on the Logger associated with our Container (if any).
Parameters:
message - Message to be logged |
| log | | protected void log(String message, Throwable throwable)(Code) | | Log a message on the Logger associated with our Container (if any).
Parameters:
message - Message to be logged
Parameters:
throwable - Associated exception |
| lookup | | protected SingleSignOnEntry lookup(String ssoId)(Code) | | Look up and return the cached SingleSignOn entry associated with this
sso id value, if there is one; otherwise return null.
Parameters:
ssoId - Single sign on identifier to look up |
| register | | void register(String ssoId, Principal principal, String authType, String username, String password)(Code) | | Register the specified Principal as being associated with the specified
value for the single sign on identifier.
Parameters:
ssoId - Single sign on identifier to register
Parameters:
principal - Associated user principal that is identified
Parameters:
authType - Authentication type used to authenticate thisuser principal
Parameters:
username - Username used to authenticate this user
Parameters:
password - Password used to authenticate this user |
| removeLifecycleListener | | public void removeLifecycleListener(LifecycleListener listener)(Code) | | Remove a lifecycle event listener from this component.
Parameters:
listener - The listener to remove |
| sessionEvent | | public void sessionEvent(SessionEvent event)(Code) | | Acknowledge the occurrence of the specified event.
Parameters:
event - SessionEvent that has occurred |
| setDebug | | public void setDebug(int debug)(Code) | | Set the debugging detail level.
Parameters:
debug - The new debugging detail level |
| start | | public void start() throws LifecycleException(Code) | | Prepare for the beginning of active use of the public methods of this
component. This method should be called after configure(),
and before any of the public methods of the component are utilized.
exception:
LifecycleException - if this component detects a fatal errorthat prevents this component from being used |
| stop | | public void stop() throws LifecycleException(Code) | | Gracefully terminate the active use of the public methods of this
component. This method should be the last one called on a given
instance of this component.
exception:
LifecycleException - if this component detects a fatal errorthat needs to be reported |
| toString | | public String toString()(Code) | | Return a String rendering of this object.
|
|
|