Top Description Interfaces Annotations Classes Enums

[default module]

Package org.apache.hc.client5.http.auth

Client HTTP authentication APIs.

Interface Summary

Modifier and Type	Interface and Description
public interface	AuthCache This interface represents an cache of `AuthScheme` state information that can be re-used for preemptive authentication by subsequent requests.
public interface	AuthScheme This interface represents an abstract challenge-response oriented authentication scheme.
public interface	AuthSchemeFactory Factory for `AuthScheme` implementations.
public interface	Credentials This interface represents a set of credentials consisting of a security principal and a secret (password) that can be used to establish user identity
public interface	CredentialsProvider Provider of authentication credentials.
public interface	CredentialsStore Abstract store of authentication credentials.

Annotation Summary

Modifier and Type	Annotation and Description
public @interface	AuthStateCacheable Indicates that the state of an `AuthScheme` can be cached and re-used for preemptive authentication by subsequent requests.

Class Summary

Modifier and Type	Class and Description
public class	AuthChallenge This class represents an authentication challenge consisting of a auth scheme and either a single parameter or a list of name / value pairs.
public class	AuthenticationException Signals a failure in authentication process
public class	AuthExchange This class represents the actual state of authentication handshake including the current `AuthScheme` used for request authorization as well as a collection of backup authentication options if available.
public class	AuthScope `AuthScope` represents an authentication scope consisting of an application protocol, a host name, a port number, a realm name and an authentication scheme name.
public class	BasicUserPrincipal Basic username based principal representation.
public class	BearerToken Opaque token `Credentials` usually representing a set of claims, often encrypted or signed.
public class	InvalidCredentialsException Authentication credentials required to respond to a authentication challenge are invalid
public class	KerberosConfig Deprecated Do not use. The GGS based experimental authentication schemes are no longer supported. Consider using Basic or Bearer authentication with TLS instead. Immutable class encapsulating Kerberos configuration options.
public class	KerberosCredentials Deprecated Do not use. The GGS based experimental authentication schemes are no longer supported. Consider using Basic or Bearer authentication with TLS instead. Kerberos specific `Credentials` representation based on `GSSCredential`.
public class	MalformedChallengeException Signals that authentication challenge is in some way invalid or illegal in the given context
public class	NTCredentials Deprecated Do not use. the NTLM authentication scheme is no longer supported. Consider using Basic or Bearer authentication with TLS instead. Microsoft Windows specific `Credentials` representation that includes Windows specific attributes such as name of the domain the user belongs to.
public class	NTUserPrincipal Microsoft Windows specific user principal implementation.
public class	StandardAuthScheme Authentication schemes by their names supported by the HttpClient.
public class	UsernamePasswordCredentials Simple `Credentials` representation based on a user name / password pair.

Enum Summary

Modifier and Type	Enum and Description
public enum	ChallengeType Challenge type (TARGET or PROXY)