Package com.azure.core.management.http.policy

Class ArmChallengeAuthenticationPolicy

java.lang.Object

com.azure.core.http.policy.BearerTokenAuthenticationPolicy

com.azure.core.management.http.policy.ArmChallengeAuthenticationPolicy

All Implemented Interfaces:

HttpPipelinePolicy

public class ArmChallengeAuthenticationPolicy
extends BearerTokenAuthenticationPolicy

The pipeline policy that applies a token credential to an HTTP request with "Bearer" scheme in ARM challenge based authentication scenarios.

Constructor Summary

Constructors

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

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.
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 appropriate TokenRequestContext to be used for re-authentication.
void	authorizeRequestSync(HttpPipelineCallContext context)	Synchronously executed before sending the initial request and authenticates the request.
String[]	getScopes(HttpPipelineCallContext context, String[] scopes)	Gets the scopes for the specific request.

Methods inherited from class com.azure.core.http.policy.BearerTokenAuthenticationPolicy

process, processSync, setAuthorizationHeader, setAuthorizationHeaderSync

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

ArmChallengeAuthenticationPolicy

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

Creates ArmChallengeAuthenticationPolicy.

Parameters:

credential - the token credential to authenticate the request

scopes - the scopes used in credential, using default scopes when empty

Method Details

authorizeRequest

public Mono<Void> authorizeRequest(HttpPipelineCallContext context)

Description copied from class: BearerTokenAuthenticationPolicy

Executed before sending the initial request and authenticates the request.

Overrides:

authorizeRequest in class BearerTokenAuthenticationPolicy

Parameters:

context - The request context.

Returns:

A Mono containing Void

authorizeRequestSync

public void authorizeRequestSync(HttpPipelineCallContext context)

Description copied from class: BearerTokenAuthenticationPolicy

Synchronously executed before sending the initial request and authenticates the request.

Overrides:

authorizeRequestSync in class BearerTokenAuthenticationPolicy

Parameters:

context - The request context.

authorizeRequestOnChallenge

public Mono<Boolean> authorizeRequestOnChallenge(HttpPipelineCallContext context,
 HttpResponse response)

Description copied from class: BearerTokenAuthenticationPolicy

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.

Overrides:

authorizeRequestOnChallenge in class BearerTokenAuthenticationPolicy

Parameters:

context - The request context.

response - The Http Response containing the authentication challenge header.

Returns:

A Mono containing TokenRequestContext

authorizeRequestOnChallengeSync

public boolean authorizeRequestOnChallengeSync(HttpPipelineCallContext context,
 HttpResponse response)

Description copied from class: BearerTokenAuthenticationPolicy

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.

Overrides:

authorizeRequestOnChallengeSync in class BearerTokenAuthenticationPolicy

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

getScopes

public String[] getScopes(HttpPipelineCallContext context,
 String[] scopes)

Gets the scopes for the specific request.

Parameters:

context - The request.

scopes - Default scopes used by the policy.

Returns:

The scopes for the specific request.