|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.catalina.valves.ValveBase org.apache.catalina.authenticator.AuthenticatorBase org.apache.catalina.authenticator.FormAuthenticator
An Authenticator and Valve implementation of FORM BASED Authentication, as described in the Servlet API Specification, Version 2.2.
Field Summary | |
protected java.lang.String |
characterEncoding
Character encoding to use to read the username and password parameters from the request. |
protected static java.lang.String |
info
Descriptive information about this implementation. |
Fields inherited from class org.apache.catalina.authenticator.AuthenticatorBase |
algorithm, cache, context, debug, DEFAULT_ALGORITHM, digest, disableProxyCaching, entropy, lifecycle, random, randomClass, SESSION_ID_BYTES, sm, sso, started |
Fields inherited from class org.apache.catalina.valves.ValveBase |
container |
Fields inherited from interface org.apache.catalina.Lifecycle |
AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, START_EVENT, STOP_EVENT |
Constructor Summary | |
FormAuthenticator()
|
Method Summary | |
boolean |
authenticate(HttpRequest request,
HttpResponse response,
LoginConfig config)
Authenticate the user making this request, based on the specified login configuration. |
java.lang.String |
getCharacterEncoding()
Return the character encoding to use to read the username and password. |
java.lang.String |
getInfo()
Return descriptive information about this Valve implementation. |
protected boolean |
matchRequest(HttpRequest request)
Does this request match the saved one (so that it must be the redirect we signalled after successful authentication? |
protected boolean |
restoreRequest(HttpRequest request,
Session session)
Restore the original request from information stored in our session. |
void |
setCharacterEncoding(java.lang.String encoding)
Set the character encoding to be used to read the username and password. |
Methods inherited from class org.apache.catalina.authenticator.AuthenticatorBase |
accessControl, addLifecycleListener, associate, checkUserData, findConstraint, findLifecycleListeners, generateSessionId, getAlgorithm, getCache, getContainer, getDebug, getDigest, getDisableProxyCaching, getEntropy, getRandom, getRandomClass, getSession, getSession, invoke, log, log, reauthenticateFromSSO, register, removeLifecycleListener, setAlgorithm, setCache, setContainer, setDebug, setDisableProxyCaching, setEntropy, setRandomClass, start, stop |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected static final java.lang.String info
protected java.lang.String characterEncoding
Constructor Detail |
public FormAuthenticator()
Method Detail |
public java.lang.String getInfo()
getInfo
in interface Valve
getInfo
in class AuthenticatorBase
public java.lang.String getCharacterEncoding()
public void setCharacterEncoding(java.lang.String encoding)
public boolean authenticate(HttpRequest request, HttpResponse response, LoginConfig config) throws java.io.IOException
true
if any specified
constraint has been satisfied, or false
if we have
created a response challenge already.
authenticate
in class AuthenticatorBase
request
- Request we are processingresponse
- Response we are creatingconfig
- Login configuration describing how authentication
should be performed
java.io.IOException
- if an input/output error occursprotected boolean matchRequest(HttpRequest request)
request
- The request to be verifiedprotected boolean restoreRequest(HttpRequest request, Session session)
false
; otherwise, return
true
.
request
- The request to be restoredsession
- The session containing the saved information
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |