Package com.azure.core.http.policy
Class BearerTokenAuthenticationPolicy
java.lang.Object
com.azure.core.http.policy.BearerTokenAuthenticationPolicy
- All Implemented Interfaces:
HttpPipelinePolicy
- Direct Known Subclasses:
ArmChallengeAuthenticationPolicy
The pipeline policy that applies a token credential to an HTTP request with "Bearer" scheme.
-
Constructor Summary
ConstructorDescriptionBearerTokenAuthenticationPolicy
(TokenCredential credential, String... scopes) Creates BearerTokenAuthenticationPolicy. -
Method Summary
Modifier and TypeMethodDescriptionauthorizeRequest
(HttpPipelineCallContext context) Executed before sending the initial request and authenticates the request.authorizeRequestOnChallenge
(HttpPipelineCallContext context, HttpResponse response) Handles the authentication challenge in the event a 401 response with a WWW-Authenticate authentication challenge header is received after the initial request and returns appropriateTokenRequestContext
to be used for re-authentication.boolean
authorizeRequestOnChallengeSync
(HttpPipelineCallContext context, HttpResponse response) Handles the authentication challenge in the event a 401 response with a WWW-Authenticate authentication challenge header is received after the initial request and returns appropriateTokenRequestContext
to be used for re-authentication.void
Synchronously executed before sending the initial request and authenticates the request.process
(HttpPipelineCallContext context, HttpPipelineNextPolicy next) Processes provided request context and invokes the next policy.processSync
(HttpPipelineCallContext context, HttpPipelineNextSyncPolicy next) Processes provided request context and invokes the next policy synchronously.setAuthorizationHeader
(HttpPipelineCallContext context, TokenRequestContext tokenRequestContext) Authorizes the request with the bearer token acquired using the specifiedtokenRequestContext
void
setAuthorizationHeaderSync
(HttpPipelineCallContext context, TokenRequestContext tokenRequestContext) Authorizes the request with the bearer token acquired using the specifiedtokenRequestContext
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.azure.core.http.policy.HttpPipelinePolicy
getPipelinePosition
-
Constructor Details
-
BearerTokenAuthenticationPolicy
Creates BearerTokenAuthenticationPolicy.- Parameters:
credential
- the token credential to authenticate the requestscopes
- the scopes of authentication the credential should get token for
-
-
Method Details
-
authorizeRequest
Executed before sending the initial request and authenticates the request. -
authorizeRequestSync
Synchronously executed before sending the initial request and authenticates the request.- Parameters:
context
- The request context.
-
authorizeRequestOnChallenge
public Mono<Boolean> authorizeRequestOnChallenge(HttpPipelineCallContext context, HttpResponse response) Handles the authentication challenge in the event a 401 response with a WWW-Authenticate authentication challenge header is received after the initial request and returns appropriateTokenRequestContext
to be used for re-authentication.- Parameters:
context
- The request context.response
- The Http Response containing the authentication challenge header.- Returns:
- A
Mono
containingTokenRequestContext
-
authorizeRequestOnChallengeSync
public boolean authorizeRequestOnChallengeSync(HttpPipelineCallContext context, HttpResponse response) Handles the authentication challenge in the event a 401 response with a WWW-Authenticate authentication challenge header is received after the initial request and returns appropriateTokenRequestContext
to be used for re-authentication.- Parameters:
context
- The request context.response
- The Http Response containing the authentication challenge header.- Returns:
- A boolean indicating if containing the
TokenRequestContext
for re-authentication
-
process
Description copied from interface:HttpPipelinePolicy
Processes provided request context and invokes the next policy.- Specified by:
process
in interfaceHttpPipelinePolicy
- Parameters:
context
- The request context.next
- The next policy to invoke.- Returns:
- A publisher that initiates the request upon subscription and emits a response on completion.
-
processSync
Description copied from interface:HttpPipelinePolicy
Processes provided request context and invokes the next policy synchronously.- Specified by:
processSync
in interfaceHttpPipelinePolicy
- Parameters:
context
- The request context.next
- The next policy to invoke.- Returns:
- A publisher that initiates the request upon subscription and emits a response on completion.
-
setAuthorizationHeader
public Mono<Void> setAuthorizationHeader(HttpPipelineCallContext context, TokenRequestContext tokenRequestContext) Authorizes the request with the bearer token acquired using the specifiedtokenRequestContext
-
setAuthorizationHeaderSync
public void setAuthorizationHeaderSync(HttpPipelineCallContext context, TokenRequestContext tokenRequestContext) Authorizes the request with the bearer token acquired using the specifiedtokenRequestContext
- Parameters:
context
- the HTTP pipeline context.tokenRequestContext
- the token request context to be used for token acquisition.
-