Interface AuthCache

All Known Implementing Classes:
BasicAuthCache
public interface AuthCache
This interface represents an cache of AuthScheme state information that can be re-used for preemptive authentication by subsequent requests.
Since:
4.1

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    clear()
     
    AuthScheme
    get(org.apache.hc.core5.http.HttpHost host)
    Returns the authentication state with the given authentication scope from the cache if available.
    default AuthScheme
    get(org.apache.hc.core5.http.HttpHost host, String pathPrefix)
    Returns the authentication state with the given authentication scope from the cache if available.
    default void
    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
    put(org.apache.hc.core5.http.HttpHost host, AuthScheme authScheme)
    Stores the authentication state with the given authentication scope in the cache.
    void
    remove(org.apache.hc.core5.http.HttpHost host)
    Removes the authentication state with the given authentication scope from the cache if found.
    default void
    remove(org.apache.hc.core5.http.HttpHost host, String pathPrefix)
    Removes the authentication state with the given authentication scope from the cache if found.

  • Method Details

    • put

      void put(org.apache.hc.core5.http.HttpHost host, AuthScheme authScheme)
      Stores the authentication state with the given authentication scope in the cache.
      Parameters:
      host - the authentication authority.
      authScheme - the cacheable authentication state.

    • get

      AuthScheme get(org.apache.hc.core5.http.HttpHost host)
      Returns the authentication state with the given authentication scope from the cache if available.
      Parameters:
      host - the authentication authority.
      Returns:
      the authentication state ir null if not available in the cache.

    • remove

      void remove(org.apache.hc.core5.http.HttpHost host)
      Removes the authentication state with the given authentication scope from the cache if found.
      Parameters:
      host - the authentication authority.

    • clear

      void clear()

    • put

      default void put(org.apache.hc.core5.http.HttpHost host, String pathPrefix, AuthScheme authScheme)
      Stores the authentication state with the given authentication scope in the cache.
      Parameters:
      host - the authentication authority.
      pathPrefix - the path prefix (the path component up to the last segment separator). Can be null.
      authScheme - the cacheable authentication state.
      Since:
      5.2

    • get

      default AuthScheme get(org.apache.hc.core5.http.HttpHost host, String pathPrefix)
      Returns the authentication state with the given authentication scope from the cache if available.
      Parameters:
      host - the authentication authority.
      pathPrefix - the path prefix (the path component up to the last segment separator). Can be null.
      Returns:
      the authentication state ir null if not available in the cache.
      Since:
      5.2

    • remove

      default void remove(org.apache.hc.core5.http.HttpHost host, String pathPrefix)
      Removes the authentication state with the given authentication scope from the cache if found.
      Parameters:
      host - the authentication authority.
      pathPrefix - the path prefix (the path component up to the last segment separator). Can be null.
      Since:
      5.2