Summary: Methods | [Expand All]
public interface

AuthScheme

org.apache.http.auth.AuthScheme
Known Indirect Subclasses

Class Overview

This interface represents an abstract challenge-response oriented authentication scheme.

An authentication scheme should be able to support the following functions:

  • Parse and process the challenge sent by the targer server in response to request for a protected resource
  • Provide its textual designation
  • Provide its parameters, if available
  • Provide the realm this authentication scheme is applicable to, if available
  • Generate authorization string for the given set of credentials, request method and URI as specificed in the HTTP request line in response to the actual authorization challenge

Authentication schemes may ignore method name and URI parameters if they are not relevant for the given authentication mechanism

Authentication schemes may be stateful involving a series of challenge-response exchanges

Summary

Public Methods
abstract Header authenticate(Credentials credentials, HttpRequest request)
Produces an authorization string for the given set of Credentials.
abstract String getParameter(String name)
Returns authentication parameter with the given name, if available.
abstract String getRealm()
Returns authentication realm.
abstract String getSchemeName()
Returns textual designation of the given authentication scheme.
abstract boolean isComplete()
Authentication process may involve a series of challenge-response exchanges.
abstract boolean isConnectionBased()
Tests if the authentication scheme is provides authorization on a per connection basis instead of usual per request basis
abstract void processChallenge(Header header)
Processes the given challenge token.

Public Methods

public abstract Header authenticate (Credentials credentials, HttpRequest request)

Produces an authorization string for the given set of Credentials.

Parameters
credentials The set of credentials to be used for athentication
request The request being authenticated
Returns
  • the authorization string
Throws
AuthenticationException if authorization string cannot be generated due to an authentication failure

public abstract String getParameter (String name)

Returns authentication parameter with the given name, if available.

Parameters
name The name of the parameter to be returned
Returns
  • the parameter with the given name

public abstract String getRealm ()

Returns authentication realm. If the concept of an authentication realm is not applicable to the given authentication scheme, returns null.

Returns
  • the authentication realm

public abstract String getSchemeName ()

Returns textual designation of the given authentication scheme.

Returns
  • the name of the given authentication scheme

public abstract boolean isComplete ()

Authentication process may involve a series of challenge-response exchanges. This method tests if the authorization process has been completed, either successfully or unsuccessfully, that is, all the required authorization challenges have been processed in their entirety.

Returns
  • true if the authentication process has been completed, false otherwise.

public abstract boolean isConnectionBased ()

Tests if the authentication scheme is provides authorization on a per connection basis instead of usual per request basis

Returns
  • true if the scheme is connection based, false if the scheme is request based.

public abstract void processChallenge (Header header)

Processes the given challenge token. Some authentication schemes may involve multiple challenge-response exchanges. Such schemes must be able to maintain the state information when dealing with sequential challenges

Parameters
header the challenge header
Throws
MalformedChallengeException