|
|||||||||
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 static StringManager |
sm
The string manager for this package. |
Fields inherited from class org.apache.catalina.valves.ValveBase |
container, next, previous |
Constructor Summary | |
SingleSignOn()
|
Method Summary | |
void |
deregister(java.lang.String cookie)
Deregister the specified cookie value for the single sign on cookie. |
java.lang.String |
getInfo()
Return descriptive information about this Valve implementation. |
void |
invoke(Request request,
Response response)
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. |
java.lang.String |
toString()
Return a String rendering of this object. |
Methods inherited from class org.apache.catalina.valves.ValveBase |
getContainer, getNext, getPrevious, invokeNext, setContainer, setNext, setPrevious |
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 static final StringManager sm
Constructor Detail |
public SingleSignOn()
Method Detail |
public java.lang.String getInfo()
getInfo
in class ValveBase
public void invoke(Request request, Response response) throws java.io.IOException, javax.servlet.ServletException
invoke
in class ValveBase
request
- The servlet request we are processingresponse
- The servlet response we are creatingjava.io.IOException
- if an input/output error occursjavax.servlet.ServletException
- if a servlet error occurspublic void deregister(java.lang.String cookie)
cookie
- Cookie value for the single sign on cookie to deregisterpublic void register(java.lang.String cookie, java.security.Principal principal, java.lang.String authType)
cookie
- Cookie value for the single sign on cookieprincipal
- Associated user principal that is identifiedauthType
- Authentication type used to authenticate this
user principalpublic java.lang.String toString()
toString
in class java.lang.Object
protected void log(java.lang.String message)
message
- Message to be loggedprotected 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 cookie)
null
.cookie
- Cookie value to look up
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |