Class HttpAuthenticator
- java.lang.Object
-
- org.apache.hc.client5.http.impl.auth.HttpAuthenticator
-
@Contract(threading=STATELESS) public final class HttpAuthenticator extends java.lang.Object
Utility class that implements commons aspects of the client side HTTP authentication.Please note that since version 5.2 this class no longer updated the authentication cache bound to the execution context.
- Since:
- 4.3
-
-
Field Summary
Fields Modifier and Type Field Description private static org.slf4j.Logger
LOG
private AuthChallengeParser
parser
-
Constructor Summary
Constructors Constructor Description HttpAuthenticator()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addAuthResponse(org.apache.hc.core5.http.HttpHost host, ChallengeType challengeType, org.apache.hc.core5.http.HttpRequest request, AuthExchange authExchange, org.apache.hc.core5.http.protocol.HttpContext context)
Generates a response to the authentication challenge based on the actualAuthExchange
state and adds it to the givenHttpRequest
message .boolean
isChallenged(org.apache.hc.core5.http.HttpHost host, ChallengeType challengeType, org.apache.hc.core5.http.HttpResponse response, AuthExchange authExchange, org.apache.hc.core5.http.protocol.HttpContext context)
Determines whether the given response represents an authentication challenge.boolean
updateAuthState(org.apache.hc.core5.http.HttpHost host, ChallengeType challengeType, org.apache.hc.core5.http.HttpResponse response, AuthenticationStrategy authStrategy, AuthExchange authExchange, org.apache.hc.core5.http.protocol.HttpContext context)
Updates theAuthExchange
state based on the challenge presented in the response message using the givenAuthenticationStrategy
.
-
-
-
Field Detail
-
LOG
private static final org.slf4j.Logger LOG
-
parser
private final AuthChallengeParser parser
-
-
Method Detail
-
isChallenged
public boolean isChallenged(org.apache.hc.core5.http.HttpHost host, ChallengeType challengeType, org.apache.hc.core5.http.HttpResponse response, AuthExchange authExchange, org.apache.hc.core5.http.protocol.HttpContext context)
Determines whether the given response represents an authentication challenge.- Parameters:
host
- the hostname of the opposite endpoint.challengeType
- the challenge type (target or proxy).response
- the response message head.authExchange
- the current authentication exchange state.context
- the current execution context.- Returns:
true
if the response message represents an authentication challenge,false
otherwise.
-
updateAuthState
public boolean updateAuthState(org.apache.hc.core5.http.HttpHost host, ChallengeType challengeType, org.apache.hc.core5.http.HttpResponse response, AuthenticationStrategy authStrategy, AuthExchange authExchange, org.apache.hc.core5.http.protocol.HttpContext context)
Updates theAuthExchange
state based on the challenge presented in the response message using the givenAuthenticationStrategy
.- Parameters:
host
- the hostname of the opposite endpoint.challengeType
- the challenge type (target or proxy).response
- the response message head.authStrategy
- the authentication strategy.authExchange
- the current authentication exchange state.context
- the current execution context.- Returns:
true
if the authentication state has been updated,false
if unchanged.
-
addAuthResponse
public void addAuthResponse(org.apache.hc.core5.http.HttpHost host, ChallengeType challengeType, org.apache.hc.core5.http.HttpRequest request, AuthExchange authExchange, org.apache.hc.core5.http.protocol.HttpContext context)
Generates a response to the authentication challenge based on the actualAuthExchange
state and adds it to the givenHttpRequest
message .- Parameters:
host
- the hostname of the opposite endpoint.challengeType
- the challenge type (target or proxy).request
- the request message head.authExchange
- the current authentication exchange state.context
- the current execution context.
-
-