Interface Authentication

All Known Implementing Classes:
AbstractAuthentication, BasicAuthentication, DigestAuthentication, SPNEGOAuthentication

public interface Authentication
Authentication represents a mechanism to authenticate requests for protected resources.

Authentications are added to an AuthenticationStore, which is then queried to find the right Authentication mechanism to use based on its type, URI and realm, as returned by WWW-Authenticate response headers.

If an Authentication mechanism is found, it is then executed for the given request, returning an Authentication.Result, which is then stored in the AuthenticationStore so that subsequent requests can be preemptively authenticated.

  • Field Details

  • Method Details

    • matches

      boolean matches(String type, URI uri, String realm)
      Matches Authentications based on the given parameters
      type - the Authentication type such as "Basic" or "Digest"
      uri - the request URI
      realm - the authentication realm as provided in the WWW-Authenticate response header
      true if this authentication matches, false otherwise
    • authenticate

      Authentication.Result authenticate(Request request, ContentResponse response, Authentication.HeaderInfo headerInfo, Attributes context)
      Executes the authentication mechanism for the given request, returning a Authentication.Result that can be used to actually authenticate the request via Authentication.Result.apply(Request).

      If a request for "/secure" returns a Authentication.Result, then the result may be used for other requests such as "/secure/foo" or "/secure/bar", unless those resources are protected by other realms.

      request - the request to execute the authentication mechanism for
      response - the 401 response obtained in the previous attempt to request the protected resource
      headerInfo - the WWW-Authenticate (or Proxy-Authenticate) header chosen for this authentication (among the many that the response may contain)
      context - the conversation context in case the authentication needs multiple exchanges to be completed and information needs to be stored across exchanges
      the authentication result, or null if the authentication could not be performed