Class FormAuthenticator

All Implemented Interfaces:

public class FormAuthenticator extends LoginAuthenticator
FORM Authenticator.

This authenticator implements form authentication will use dispatchers to the login page if the __FORM_DISPATCH init parameter is set to true. Otherwise it will redirect.

The form authenticator redirects unauthenticated requests to a log page which should use a form to gather username/password from the user and send them to the /j_security_check URI within the context. FormAuthentication uses SessionAuthentication to wrap Authentication results so that they are associated with the session.

  • Field Details

  • Constructor Details

    • FormAuthenticator

      public FormAuthenticator()
    • FormAuthenticator

      public FormAuthenticator(String login, String error, boolean dispatch)
  • Method Details

    • setAlwaysSaveUri

      public void setAlwaysSaveUri(boolean alwaysSave)
      If true, uris that cause a redirect to a login page will always be remembered. If false, only the first uri that leads to a login page redirect is remembered. See
      alwaysSave - true to always save the uri
    • getAlwaysSaveUri

      public boolean getAlwaysSaveUri()
    • setConfiguration

      public void setConfiguration(Authenticator.AuthConfiguration configuration)
      Description copied from interface: Authenticator
      Configure the Authenticator
      Specified by:
      setConfiguration in interface Authenticator
      setConfiguration in class LoginAuthenticator
      configuration - the configuration
    • getAuthMethod

      public String getAuthMethod()
      The name of the authentication method
    • login

      public UserIdentity login(String username, Object password, jakarta.servlet.ServletRequest request)
      Description copied from class: LoginAuthenticator
      If the UserIdentity is not null after this method calls LoginService.login(String, Object, ServletRequest), it is assumed that the user is fully authenticated and we need to change the session id to prevent session fixation vulnerability. If the UserIdentity is not necessarily fully authenticated, then subclasses must override this method and determine when the UserIdentity IS fully authenticated and renew the session id.
      login in class LoginAuthenticator
      username - the username of the client to be authenticated
      password - the user's credential
      request - the inbound request that needs authentication
    • logout

      public void logout(jakarta.servlet.ServletRequest request)
      logout in class LoginAuthenticator
    • prepareRequest

      public void prepareRequest(jakarta.servlet.ServletRequest request)
      Description copied from interface: Authenticator
      Called prior to validateRequest. The authenticator can manipulate the request to update it with information that can be inspected prior to validateRequest being called. The primary purpose of this method is to satisfy the Servlet Spec 3.1 section 13.6.3 on handling Form authentication where the http method of the original request causing authentication is not the same as the http method resulting from the redirect after authentication.
      Specified by:
      prepareRequest in interface Authenticator
      prepareRequest in class LoginAuthenticator
      request - the request to manipulate
    • validateRequest

      public Authentication validateRequest(jakarta.servlet.ServletRequest req, jakarta.servlet.ServletResponse res, boolean mandatory) throws ServerAuthException
      Description copied from interface: Authenticator
      Validate a request
      req - The request
      res - The response
      mandatory - True if authentication is mandatory.
      An Authentication. If Authentication is successful, this will be a Authentication.User. If a response has been sent by the Authenticator (which can be done for both successful and unsuccessful authentications), then the result will implement Authentication.ResponseSent. If Authentication is not mandatory, then a Authentication.Deferred may be returned.
      ServerAuthException - if unable to validate request
    • isJSecurityCheck

      public boolean isJSecurityCheck(String uri)
    • isLoginOrErrorPage

      public boolean isLoginOrErrorPage(String pathInContext)
    • secureResponse

      public boolean secureResponse(jakarta.servlet.ServletRequest req, jakarta.servlet.ServletResponse res, boolean mandatory, Authentication.User validatedUser) throws ServerAuthException
      Description copied from interface: Authenticator
      is response secure
      req - the request
      res - the response
      mandatory - if security is mandator
      validatedUser - the user that was validated
      true if response is secure
      ServerAuthException - if unable to test response