Interface Authenticator

    • Method Detail

      • setConfiguration

        void setConfiguration​(Authenticator.AuthConfiguration configuration)
        Configure the Authenticator
        configuration - the configuration
      • getAuthMethod

        java.lang.String getAuthMethod()
        The name of the authentication method
      • prepareRequest

        void prepareRequest​(javax.servlet.ServletRequest request)
        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.
        request - the request to manipulate
      • validateRequest

        Authentication validateRequest​(javax.servlet.ServletRequest request,
                                       javax.servlet.ServletResponse response,
                                       boolean mandatory)
                                throws ServerAuthException
        Validate a request
        request - The request
        response - 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
      • secureResponse

        boolean secureResponse​(javax.servlet.ServletRequest request,
                               javax.servlet.ServletResponse response,
                               boolean mandatory,
                               Authentication.User validatedUser)
                        throws ServerAuthException
        is response secure
        request - the request
        response - the response
        mandatory - if security is mandator
        validatedUser - the user that was validated
        true if response is secure
        ServerAuthException - if unable to test response