Package com.azure.core.util
Class AuthorizationChallengeHandler
java.lang.Object
com.azure.core.util.AuthorizationChallengeHandler
This class handles Basic and Digest authorization challenges, complying to RFC 2617 and RFC 7616.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Header representing additional information a server is expecting during future authentication requests.static final String
Header representing the authorization the client is presenting to a server.static final String
Header representing a proxy server requesting authentication.static final String
Header representing additional information a proxy server is expecting during future authentication requests.static final String
Header representing the authorization the client is presenting to a proxy server.static final String
Header representing a server requesting authentication. -
Constructor Summary
ConstructorDescriptionAuthorizationChallengeHandler
(String username, String password) Creates anAuthorizationChallengeHandler
using theusername
andpassword
to respond to authentication challenges. -
Method Summary
Modifier and TypeMethodDescriptionfinal String
attemptToPipelineAuthorization
(String method, String uri, Supplier<byte[]> entityBodySupplier) Attempts to pipeline requests by applying the most recent authorization type used to create an authorization header.final void
consumeAuthenticationInfoHeader
(Map<String, String> authenticationInfoMap) Consumes either the 'Authentication-Info' or 'Proxy-Authentication-Info' header returned in a response from a server.final String
Handles Basic authentication challenges.final String
handleDigest
(String method, String uri, List<Map<String, String>> challenges, Supplier<byte[]> entityBodySupplier) Handles Digest authentication challenges.Parses theAuthorization
orAuthentication
header into its key-value pairs.
-
Field Details
-
WWW_AUTHENTICATE
Header representing a server requesting authentication.- See Also:
-
PROXY_AUTHENTICATE
Header representing a proxy server requesting authentication.- See Also:
-
AUTHORIZATION
Header representing the authorization the client is presenting to a server.- See Also:
-
PROXY_AUTHORIZATION
Header representing the authorization the client is presenting to a proxy server.- See Also:
-
AUTHENTICATION_INFO
Header representing additional information a server is expecting during future authentication requests.- See Also:
-
PROXY_AUTHENTICATION_INFO
Header representing additional information a proxy server is expecting during future authentication requests.- See Also:
-
-
Constructor Details
-
AuthorizationChallengeHandler
Creates anAuthorizationChallengeHandler
using theusername
andpassword
to respond to authentication challenges.- Parameters:
username
- Username used to response to authorization challenges.password
- Password used to respond to authorization challenges.- Throws:
NullPointerException
- Ifusername
orpassword
arenull
.
-
-
Method Details
-
handleBasic
Handles Basic authentication challenges.- Returns:
- Authorization header for Basic authentication challenges.
-
handleDigest
public final String handleDigest(String method, String uri, List<Map<String, String>> challenges, Supplier<byte[]> entityBodySupplier) Handles Digest authentication challenges.- Parameters:
method
- HTTP method being used in the request.uri
- Relative URI for the request.challenges
- List of challenges that the server returned for the client to choose from and use when creating the authorization header.entityBodySupplier
- Supplies the request entity body, used to compute the hash of the body when using"qop=auth-int"
.- Returns:
- Authorization header for Digest authentication challenges.
-
attemptToPipelineAuthorization
public final String attemptToPipelineAuthorization(String method, String uri, Supplier<byte[]> entityBodySupplier) Attempts to pipeline requests by applying the most recent authorization type used to create an authorization header.- Parameters:
method
- HTTP method being used in the request.uri
- Relative URI for the request.entityBodySupplier
- Supplies the request entity body, used to compute the hash of the body when using"qop=auth-int"
.- Returns:
- A preemptive authorization header for a potential Digest authentication challenge.
-
consumeAuthenticationInfoHeader
Consumes either the 'Authentication-Info' or 'Proxy-Authentication-Info' header returned in a response from a server. This header is used by the server to communicate information about the successful authentication of the client, this header may be returned at any time by the server.See RFC 7615 for more information about these headers.
- Parameters:
authenticationInfoMap
- Either 'Authentication-Info' or 'Proxy-Authentication-Info' header returned from the server split into its key-value pair pieces.
-
parseAuthenticationOrAuthorizationHeader
Parses theAuthorization
orAuthentication
header into its key-value pairs.This will remove quotes on quoted string values.
- Parameters:
header
- Authorization or Authentication header.- Returns:
- The Authorization or Authentication header split into its key-value pairs.
-