public class FormAuthenticator extends AuthenticatorBase
| Modifier and Type | Field and Description |
|---|---|
protected String |
characterEncoding
Character encoding to use to read the username and password parameters
from the request.
|
protected String |
landingPage
Landing page to use if a user tries to access the login page directly or
if the session times out during login.
|
alwaysUseSession, AUTH_HEADER_NAME, cache, changeSessionIdOnAuthentication, context, disableProxyCaching, REALM_NAME, securePagesWithPragma, secureRandomAlgorithm, secureRandomClass, secureRandomProvider, sessionIdGenerator, sm, ssoasyncSupported, container, containerLog, nextmserverAFTER_DESTROY_EVENT, AFTER_INIT_EVENT, AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_DESTROY_EVENT, BEFORE_INIT_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, CONFIGURE_START_EVENT, CONFIGURE_STOP_EVENT, PERIODIC_EVENT, START_EVENT, STOP_EVENT| Constructor and Description |
|---|
FormAuthenticator() |
| Modifier and Type | Method and Description |
|---|---|
boolean |
authenticate(Request request,
HttpServletResponse response)
Authenticate the user making this request, based on the specified
login configuration.
|
protected void |
forwardToErrorPage(Request request,
HttpServletResponse response,
LoginConfig config)
Called to forward to the error page
|
protected void |
forwardToLoginPage(Request request,
HttpServletResponse response,
LoginConfig config)
Called to forward to the login page
|
protected String |
getAuthMethod() |
String |
getCharacterEncoding()
Return the character encoding to use to read the username and password.
|
String |
getLandingPage()
Return the landing page to use when FORM auth is mis-used.
|
protected boolean |
matchRequest(Request request)
Does this request match the saved one (so that it must be the redirect
we signaled after successful authentication?
|
protected boolean |
restoreRequest(Request request,
Session session)
Restore the original request from information stored in our session.
|
protected String |
savedRequestURL(Session session)
Return the request URI (with the corresponding query string, if any)
from the saved request so that we can redirect to it.
|
protected void |
saveRequest(Request request,
Session session)
Save the original request information into our session.
|
void |
setCharacterEncoding(String encoding)
Set the character encoding to be used to read the username and password.
|
void |
setLandingPage(String landingPage)
Set the landing page to use when the FORM auth is mis-used.
|
associate, doLogin, getAlwaysUseSession, getCache, getChangeSessionIdOnAuthentication, getContainer, getDisableProxyCaching, getRealmName, getRequestCertificates, getSecurePagesWithPragma, getSecureRandomAlgorithm, getSecureRandomClass, getSecureRandomProvider, invoke, login, logout, reauthenticateFromSSO, register, setAlwaysUseSession, setCache, setChangeSessionIdOnAuthentication, setContainer, setDisableProxyCaching, setSecurePagesWithPragma, setSecureRandomAlgorithm, setSecureRandomClass, setSecureRandomProvider, startInternal, stopInternalbackgroundProcess, event, getDomainInternal, getNext, getObjectNameKeyProperties, initInternal, isAsyncSupported, setAsyncSupported, setNext, toStringdestroyInternal, getDomain, getObjectName, postDeregister, postRegister, preDeregister, preRegister, register, setDomain, unregisteraddLifecycleListener, destroy, findLifecycleListeners, fireLifecycleEvent, getState, getStateName, init, removeLifecycleListener, setState, setState, start, stopprotected String characterEncoding
protected String landingPage
public String getCharacterEncoding()
public void setCharacterEncoding(String encoding)
public String getLandingPage()
public void setLandingPage(String landingPage)
public boolean authenticate(Request request, HttpServletResponse response) throws IOException
true if any specified
constraint has been satisfied, or false if we have
created a response challenge already.authenticate in interface Authenticatorauthenticate in class AuthenticatorBaserequest - Request we are processingresponse - Response we are creatingtrue if any specified constraints have been
satisfied, or false if one more constraints were not
satisfied (in which case an authentication challenge will have
been written to the response).IOException - if an input/output error occursprotected String getAuthMethod()
getAuthMethod in class AuthenticatorBaseprotected void forwardToLoginPage(Request request, HttpServletResponse response, LoginConfig config) throws IOException
request - Request we are processingresponse - Response we are populatingconfig - Login configuration describing how authentication
should be performedIOException - If the forward to the login page fails and the call
to HttpServletResponse.sendError(int, String)
throws an IOExceptionprotected void forwardToErrorPage(Request request, HttpServletResponse response, LoginConfig config) throws IOException
request - Request we are processingresponse - Response we are populatingconfig - Login configuration describing how authentication
should be performedIOException - If the forward to the error page fails and the call
to HttpServletResponse.sendError(int, String)
throws an IOExceptionprotected boolean matchRequest(Request request)
request - The request to be verifiedprotected boolean restoreRequest(Request request, Session session) throws IOException
false; otherwise, return
true.request - The request to be restoredsession - The session containing the saved informationIOExceptionprotected void saveRequest(Request request, Session session) throws IOException
request - The request to be savedsession - The session to contain the saved informationIOExceptionCopyright © 2000-2014 Apache Software Foundation. All Rights Reserved.