Field Detail

• info

  protected static final java.lang.String info

  Descriptive information about this implementation.

  See Also:

  Constant Field Values

• characterEncoding

  protected java.lang.String characterEncoding

  Character encoding to use to read the username and password parameters from the request. If not set, the encoding of the request body will be used.

• landingPage

  protected java.lang.String landingPage

  Landing page to use if a user tries to access the login page directly or if the session times out during login. If not set, error responses will be sent instead.

Constructor Detail

• FormAuthenticator

  public FormAuthenticator()

Method Detail

• getInfo

  public java.lang.String getInfo()

  Return descriptive information about this Valve implementation.

  Specified by:

  getInfo in interface Valve

  Overrides:

  getInfo in class AuthenticatorBase

• getCharacterEncoding

  public java.lang.String getCharacterEncoding()

  Return the character encoding to use to read the username and password.

• setCharacterEncoding

  public void setCharacterEncoding(java.lang.String encoding)

  Set the character encoding to be used to read the username and password.

• getLandingPage

  public java.lang.String getLandingPage()

  Return the landing page to use when FORM auth is mis-used.

• setLandingPage

  public void setLandingPage(java.lang.String landingPage)

  Set the landing page to use when the FORM auth is mis-used.

• authenticate

  public boolean authenticate(Request request,
                     HttpServletResponse response,
                     LoginConfig config)
                       throws java.io.IOException

  Authenticate the user making this request, based on the specified login configuration. Return true if any specified constraint has been satisfied, or false if we have created a response challenge already.

  Specified by:

  authenticate in interface Authenticator

  Specified by:

  authenticate in class AuthenticatorBase

  Parameters:

  request - Request we are processing

  response - Response we are creating

  config - Login configuration describing how authentication should be performed

  Throws:

  java.io.IOException - if an input/output error occurs

• getAuthMethod

  protected java.lang.String getAuthMethod()

  Specified by:

  getAuthMethod in class AuthenticatorBase

• forwardToLoginPage

  protected void forwardToLoginPage(Request request,
                        HttpServletResponse response,
                        LoginConfig config)
                             throws java.io.IOException

  Called to forward to the login page

  Parameters:

  request - Request we are processing

  response - Response we are populating

  config - Login configuration describing how authentication should be performed

  Throws:

  java.io.IOException - If the forward to the login page fails and the call to HttpServletResponse.sendError(int, String) throws an IOException

• forwardToErrorPage

  protected void forwardToErrorPage(Request request,
                        HttpServletResponse response,
                        LoginConfig config)
                             throws java.io.IOException

  Called to forward to the error page

  Parameters:

  request - Request we are processing

  response - Response we are populating

  config - Login configuration describing how authentication should be performed

  Throws:

  java.io.IOException - If the forward to the error page fails and the call to HttpServletResponse.sendError(int, String) throws an IOException

• matchRequest

  protected boolean matchRequest(Request request)

  Does this request match the saved one (so that it must be the redirect we signaled after successful authentication?

  Parameters:

  request - The request to be verified

• restoreRequest

  protected boolean restoreRequest(Request request,
                       Session session)
                            throws java.io.IOException

  Restore the original request from information stored in our session. If the original request is no longer present (because the session timed out), return false; otherwise, return true.

  Parameters:

  request - The request to be restored

  session - The session containing the saved information

  Throws:

  java.io.IOException

• saveRequest

  protected void saveRequest(Request request,
                 Session session)
                      throws java.io.IOException

  Save the original request information into our session.

  Parameters:

  request - The request to be saved

  session - The session to contain the saved information

  Throws:

  java.io.IOException

• savedRequestURL

  protected java.lang.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.

  Parameters:

  session - Our current session