|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object
|
+--org.apache.catalina.valves.ValveBase
|
+--org.apache.catalina.authenticator.SingleSignOn
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:
Host).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.org.apache.catalina.authenticator package.
| 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 LifecycleSupport |
lifecycle
The lifecycle event support for this component. |
protected java.util.HashMap |
reverse
The cache of single sign on identifiers, keyed by the Session that is associated with them. |
protected static StringManager |
sm
The string manager for this package. |
protected boolean |
started
Component started flag. |
| Fields inherited from class org.apache.catalina.valves.ValveBase |
container |
| Fields inherited from interface org.apache.catalina.Lifecycle |
START_EVENT, STOP_EVENT |
| Constructor Summary | |
SingleSignOn()
|
|
| Method Summary | |
void |
addLifecycleListener(LifecycleListener listener)
Add a lifecycle event listener to this component. |
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 ssoId)
Look up and return the cached SingleSignOn entry associated with this sso id value, if there is one; otherwise return null. |
void |
removeLifecycleListener(LifecycleListener listener)
Remove a lifecycle event listener from this component. |
void |
sessionEvent(SessionEvent event)
Acknowledge the occurrence of the specified event. |
void |
setDebug(int debug)
Set the debugging detail level. |
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. |
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 |
protected java.util.HashMap cache
protected int debug
protected static java.lang.String info
protected LifecycleSupport lifecycle
protected java.util.HashMap reverse
protected static final StringManager sm
protected boolean started
| Constructor Detail |
public SingleSignOn()
| Method Detail |
public int getDebug()
public void setDebug(int debug)
debug - The new debugging detail levelpublic void addLifecycleListener(LifecycleListener listener)
addLifecycleListener in interface Lifecyclelistener - The listener to addpublic void removeLifecycleListener(LifecycleListener listener)
removeLifecycleListener in interface Lifecyclelistener - The listener to remove
public void start()
throws LifecycleException
configure(),
and before any of the public methods of the component are utilized.start in interface Lifecyclejava.lang.IllegalStateException - if this component has already been
startedLifecycleException - if this component detects a fatal error
that prevents this component from being used
public void stop()
throws LifecycleException
stop in interface Lifecyclejava.lang.IllegalStateException - if this component has not been startedLifecycleException - if this component detects a fatal error
that needs to be reportedpublic void sessionEvent(SessionEvent event)
sessionEvent in interface SessionListenerevent - SessionEvent that has occurredpublic java.lang.String getInfo()
getInfo in class ValveBase
public void invoke(Request request,
Response response,
ValveContext context)
throws java.io.IOException,
javax.servlet.ServletException
invoke in class ValveBaserequest - The servlet request we are processingresponse - The servlet response we are creatingcontext - The valve context used to invoke the next valve
in the current processing pipelinejava.io.IOException - if an input/output error occursjavax.servlet.ServletException - if a servlet error occurspublic java.lang.String toString()
toString in class java.lang.Objectprotected void log(java.lang.String message)
message - Message to be logged
protected void log(java.lang.String message,
java.lang.Throwable throwable)
message - Message to be loggedthrowable - Associated exceptionprotected org.apache.catalina.authenticator.SingleSignOnEntry lookup(java.lang.String ssoId)
null.ssoId - Single sign on identifier to look up
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||