Package org.apache.http.impl.client

Class AuthenticationStrategyImpl

java.lang.Object
org.apache.http.impl.client.AuthenticationStrategyImpl
All Implemented Interfaces:
AuthenticationStrategy
Direct Known Subclasses:
ProxyAuthenticationStrategy, TargetAuthenticationStrategy
@Contract(threading=IMMUTABLE) abstract class AuthenticationStrategyImpl extends Object implements AuthenticationStrategy

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final int
    challengeCode
     
    private static final List<String>
    DEFAULT_SCHEME_PRIORITY
     
    private final String
    headerName
     
    private final org.apache.commons.logging.Log
    log
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    AuthenticationStrategyImpl(int challengeCode, String headerName)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    authFailed(org.apache.http.HttpHost authhost, AuthScheme authScheme, org.apache.http.protocol.HttpContext context)
    Callback invoked in case of unsuccessful authentication.
    void
    authSucceeded(org.apache.http.HttpHost authhost, AuthScheme authScheme, org.apache.http.protocol.HttpContext context)
    Callback invoked in case of successful authentication.
    Map<String,org.apache.http.Header>
    getChallenges(org.apache.http.HttpHost authhost, org.apache.http.HttpResponse response, org.apache.http.protocol.HttpContext context)
    Generates a map of challenge auth-scheme => Header entries.
    (package private) abstract Collection<String>
    getPreferredAuthSchemes(RequestConfig config)
     
    boolean
    isAuthenticationRequested(org.apache.http.HttpHost authhost, org.apache.http.HttpResponse response, org.apache.http.protocol.HttpContext context)
    Determines if the given HTTP response response represents an authentication challenge that was sent back as a result of authentication failure.
    protected boolean
    isCachable(AuthScheme authScheme)
     
    Queue<AuthOption>
    select(Map<String,org.apache.http.Header> challenges, org.apache.http.HttpHost authhost, org.apache.http.HttpResponse response, org.apache.http.protocol.HttpContext context)
    Selects one authentication challenge out of all available and creates and generates AuthOption instance capable of processing that challenge.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • log

      private final org.apache.commons.logging.Log log

    • DEFAULT_SCHEME_PRIORITY

      private static final List<String> DEFAULT_SCHEME_PRIORITY

    • challengeCode

      private final int challengeCode

    • headerName

      private final String headerName

  • Constructor Details

    • AuthenticationStrategyImpl

      AuthenticationStrategyImpl(int challengeCode, String headerName)
      Parameters:
      challengeCode - for example SC_PROXY_AUTHENTICATION_REQUIRED or SC_UNAUTHORIZED
      headerName - for example "Proxy-Authenticate" or "WWW-Authenticate"

  • Method Details

    • isAuthenticationRequested

      public boolean isAuthenticationRequested(org.apache.http.HttpHost authhost, org.apache.http.HttpResponse response, org.apache.http.protocol.HttpContext context)
      Description copied from interface: AuthenticationStrategy
      Determines if the given HTTP response response represents an authentication challenge that was sent back as a result of authentication failure.
      Specified by:
      isAuthenticationRequested in interface AuthenticationStrategy
      Parameters:
      authhost - authentication host.
      response - HTTP response.
      context - HTTP context.
      Returns:
      true if user authentication is required, false otherwise.

    • getChallenges

      public Map<String,org.apache.http.Header> getChallenges(org.apache.http.HttpHost authhost, org.apache.http.HttpResponse response, org.apache.http.protocol.HttpContext context) throws MalformedChallengeException
      Generates a map of challenge auth-scheme => Header entries.
      Specified by:
      getChallenges in interface AuthenticationStrategy
      Parameters:
      authhost - authentication host.
      response - HTTP response.
      context - HTTP context.
      Returns:
      map: key=lower-cased auth-scheme name, value=Header that contains the challenge
      Throws:
      MalformedChallengeException - if one of the authentication challenges is not valid or malformed.

    • getPreferredAuthSchemes

      abstract Collection<String> getPreferredAuthSchemes(RequestConfig config)

    • select

      public Queue<AuthOption> select(Map<String,org.apache.http.Header> challenges, org.apache.http.HttpHost authhost, org.apache.http.HttpResponse response, org.apache.http.protocol.HttpContext context) throws MalformedChallengeException
      Description copied from interface: AuthenticationStrategy
      Selects one authentication challenge out of all available and creates and generates AuthOption instance capable of processing that challenge.
      Specified by:
      select in interface AuthenticationStrategy
      Parameters:
      challenges - collection of challenges.
      authhost - authentication host.
      response - HTTP response.
      context - HTTP context.
      Returns:
      authentication auth schemes that can be used for authentication. Can be empty.
      Throws:
      MalformedChallengeException - if one of the authentication challenges is not valid or malformed.

    • authSucceeded

      public void authSucceeded(org.apache.http.HttpHost authhost, AuthScheme authScheme, org.apache.http.protocol.HttpContext context)
      Description copied from interface: AuthenticationStrategy
      Callback invoked in case of successful authentication.
      Specified by:
      authSucceeded in interface AuthenticationStrategy
      Parameters:
      authhost - authentication host.
      authScheme - authentication scheme used.
      context - HTTP context.

    • isCachable

      protected boolean isCachable(AuthScheme authScheme)

    • authFailed

      public void authFailed(org.apache.http.HttpHost authhost, AuthScheme authScheme, org.apache.http.protocol.HttpContext context)
      Description copied from interface: AuthenticationStrategy
      Callback invoked in case of unsuccessful authentication.
      Specified by:
      authFailed in interface AuthenticationStrategy
      Parameters:
      authhost - authentication host.
      authScheme - authentication scheme used.
      context - HTTP context.