Package com.azure.core.http.policy

Class BearerTokenAuthenticationPolicy

java.lang.Object

com.azure.core.http.policy.BearerTokenAuthenticationPolicy

All Implemented Interfaces:

HttpPipelinePolicy

public class BearerTokenAuthenticationPolicy
extends Object
implements HttpPipelinePolicy

The pipeline policy that applies a token credential to an HTTP request with "Bearer" scheme.

Constructor Summary

Constructors

Constructor	Description
BearerTokenAuthenticationPolicy(TokenCredential credential, String... scopes)	Creates BearerTokenAuthenticationPolicy.

Method Summary

Modifier and Type	Method	Description
Mono<Void>	authorizeRequest(HttpPipelineCallContext context)	Executed before sending the initial request and authenticates the request.
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 appropriate TokenRequestContext to be used for re-authentication.
Mono<HttpResponse>	process(HttpPipelineCallContext context, HttpPipelineNextPolicy next)	Processes provided request context and invokes the next policy.
Mono<Void>	setAuthorizationHeader(HttpPipelineCallContext context, TokenRequestContext tokenRequestContext)	Authorizes the request with the bearer token acquired using the specified tokenRequestContext

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 Detail

BearerTokenAuthenticationPolicy

public BearerTokenAuthenticationPolicy(TokenCredential credential,
                                       String... scopes)

Creates BearerTokenAuthenticationPolicy.

Parameters:

credential - the token credential to authenticate the request

scopes - the scopes of authentication the credential should get token for

Method Detail

authorizeRequest

public Mono<Void> authorizeRequest(HttpPipelineCallContext context)

Executed before sending the initial request and authenticates the request.

Parameters:

context - The request context.

Returns:

A Mono containing Void

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 appropriate TokenRequestContext to be used for re-authentication.

Parameters:

context - The request context.

response - The Http Response containing the authentication challenge header.

Returns:

A Mono containing TokenRequestContext

process

public Mono<HttpResponse> process(HttpPipelineCallContext context,
                                  HttpPipelineNextPolicy next)

Description copied from interface: HttpPipelinePolicy

Processes provided request context and invokes the next policy.

Specified by:

process in interface HttpPipelinePolicy

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 specified tokenRequestContext

Parameters:

context - the HTTP pipeline context.

tokenRequestContext - the token request context to be used for token acquisition.

Returns:

a Mono containing Void