public interface

ContextAwareAuthScheme

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

Class Overview

This interface represents an extended authentication scheme that requires access to HttpContext in order to generate an authorization string. TODO: Fix AuthScheme interface in the next major version

Summary

Public Methods
abstract Header authenticate(Credentials credentials, HttpRequest request, HttpContext context)
Produces an authorization string for the given set of Credentials.
[Expand]
Inherited Methods
From interface org.apache.http.auth.AuthScheme

Public Methods

public abstract Header authenticate (Credentials credentials, HttpRequest request, HttpContext context)

Also: HttpClient

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
context HTTP context
Returns
  • the authorization string
Throws
AuthenticationException if authorization string cannot be generated due to an authentication failure