## Uses of Interface
org.apache.hc.client5.http.auth.AuthScheme

- Packages that use AuthScheme
  Package | Description
  --- | ---
  org.apache.hc.client5.http | Client component APIs common to all client transports such as connection route information and resolution as well as common HTTP method definitions and exception classes.
  org.apache.hc.client5.http.auth | Client HTTP authentication APIs.
  org.apache.hc.client5.http.impl |
  org.apache.hc.client5.http.impl.auth | Standard and common HTTP authentication schemes.
  org.apache.hc.client5.http.impl.win | Auth scheme that makes use of JNA to implement Negotiate and NTLM on Windows Platforms.
  org.apache.hc.client5.http.protocol | HTTP protocol interceptors that enable advanced functionality such as HTTP state management and authentication state caching.

- - ### Uses of AuthScheme in org.apache.hc.client5.http

    Methods in org.apache.hc.client5.http that return types with arguments of type AuthScheme
    Modifier and Type | Method and Description
    --- | ---
    `List<AuthScheme>` | AuthenticationStrategy.`select(ChallengeType challengeType, Map<String,AuthChallenge> challenges, org.apache.hc.core5.http.protocol.HttpContext context)` Returns an list of `AuthScheme`s to handle the given `AuthChallenge`s in their order of preference.

    Methods in org.apache.hc.client5.http with parameters of type AuthScheme
    Modifier and Type | Method and Description
    --- | ---
    `ContextBuilder` | ContextBuilder.`preemptiveAuth(org.apache.hc.core5.http.HttpHost host, AuthScheme authScheme)`

  - ### Uses of AuthScheme in org.apache.hc.client5.http.auth

    Methods in org.apache.hc.client5.http.auth that return AuthScheme
    Modifier and Type | Method and Description
    --- | ---
    `AuthScheme` | AuthSchemeFactory.`create(org.apache.hc.core5.http.protocol.HttpContext context)` Creates an instance of `AuthScheme`.
    `AuthScheme` | AuthCache.`get(org.apache.hc.core5.http.HttpHost host)` Returns the authentication state with the given authentication scope from the cache if available.
    `default AuthScheme` | AuthCache.`get(org.apache.hc.core5.http.HttpHost host, String pathPrefix)` Returns the authentication state with the given authentication scope from the cache if available.
    `AuthScheme` | AuthExchange.`getAuthScheme()` Returns actual `AuthScheme`.

    Methods in org.apache.hc.client5.http.auth that return types with arguments of type AuthScheme
    Modifier and Type | Method and Description
    --- | ---
    `Queue<AuthScheme>` | AuthExchange.`getAuthOptions()` Returns available auth options.

    Methods in org.apache.hc.client5.http.auth with parameters of type AuthScheme
    Modifier and Type | Method and Description
    --- | ---
    `void` | AuthCache.`put(org.apache.hc.core5.http.HttpHost host, AuthScheme authScheme)` Stores the authentication state with the given authentication scope in the cache.
    `default void` | AuthCache.`put(org.apache.hc.core5.http.HttpHost host, String pathPrefix, AuthScheme authScheme)` Stores the authentication state with the given authentication scope in the cache.
    `void` | AuthExchange.`select(AuthScheme authScheme)` Resets the auth state with `AuthScheme` and clears auth options.

    Method parameters in org.apache.hc.client5.http.auth with type arguments of type AuthScheme
    Modifier and Type | Method and Description
    --- | ---
    `void` | AuthExchange.`setOptions(Queue<AuthScheme> authOptions)` Updates the auth state with a queue of auth options.

  - ### Uses of AuthScheme in org.apache.hc.client5.http.impl

    Methods in org.apache.hc.client5.http.impl that return types with arguments of type AuthScheme
    Modifier and Type | Method and Description
    --- | ---
    `List<AuthScheme>` | DefaultAuthenticationStrategy.`select(ChallengeType challengeType, Map<String,AuthChallenge> challenges, org.apache.hc.core5.http.protocol.HttpContext context)`

  - ### Uses of AuthScheme in org.apache.hc.client5.http.impl.auth

    Classes in org.apache.hc.client5.http.impl.auth that implement AuthScheme
    Modifier and Type | Class and Description
    --- | ---
    `class` | `BasicScheme` Basic authentication scheme as defined in RFC 2617.
    `class` | `DigestScheme` Digest authentication scheme as defined in RFC 2617.
    `class` | `GGSSchemeBase` Common behavior for `GSS` based authentication schemes.
    `class` | `KerberosScheme` Kerberos authentication scheme.
    `class` | `NTLMScheme` NTLM is a proprietary authentication scheme developed by Microsoft and optimized for Windows platforms.
    `class` | `SPNegoScheme` SPNEGO (Simple and Protected GSSAPI Negotiation Mechanism) authentication scheme.

    Methods in org.apache.hc.client5.http.impl.auth that return AuthScheme
    Modifier and Type | Method and Description
    --- | ---
    `AuthScheme` | BasicSchemeFactory.`create(org.apache.hc.core5.http.protocol.HttpContext context)`
    `AuthScheme` | SPNegoSchemeFactory.`create(org.apache.hc.core5.http.protocol.HttpContext context)`
    `AuthScheme` | NTLMSchemeFactory.`create(org.apache.hc.core5.http.protocol.HttpContext context)`
    `AuthScheme` | KerberosSchemeFactory.`create(org.apache.hc.core5.http.protocol.HttpContext context)`
    `AuthScheme` | DigestSchemeFactory.`create(org.apache.hc.core5.http.protocol.HttpContext context)`
    `AuthScheme` | BasicAuthCache.`get(org.apache.hc.core5.http.HttpHost host)`
    `AuthScheme` | BasicAuthCache.`get(org.apache.hc.core5.http.HttpHost host, String pathPrefix)`

    Methods in org.apache.hc.client5.http.impl.auth with parameters of type AuthScheme
    Modifier and Type | Method and Description
    --- | ---
    `void` | BasicAuthCache.`put(org.apache.hc.core5.http.HttpHost host, AuthScheme authScheme)`
    `void` | BasicAuthCache.`put(org.apache.hc.core5.http.HttpHost host, String pathPrefix, AuthScheme authScheme)`

  - ### Uses of AuthScheme in org.apache.hc.client5.http.impl.win

    Classes in org.apache.hc.client5.http.impl.win that implement AuthScheme
    Modifier and Type | Class and Description
    --- | ---
    `class` | `WindowsNegotiateScheme` Auth scheme that makes use of JNA to implement Negotiate and NTLM on Windows Platforms.

    Methods in org.apache.hc.client5.http.impl.win that return AuthScheme
    Modifier and Type | Method and Description
    --- | ---
    `AuthScheme` | WindowsNTLMSchemeFactory.`create(org.apache.hc.core5.http.protocol.HttpContext context)`
    `AuthScheme` | WindowsNegotiateSchemeFactory.`create(org.apache.hc.core5.http.protocol.HttpContext context)`

  - ### Uses of AuthScheme in org.apache.hc.client5.http.protocol

    Methods in org.apache.hc.client5.http.protocol with parameters of type AuthScheme
    Modifier and Type | Method and Description
    --- | ---
    `void` | HttpClientContext.`resetAuthExchange(org.apache.hc.core5.http.HttpHost host, AuthScheme authScheme)`

Copyright © 1999–2022 The Apache Software Foundation. All rights reserved.