com.azure.core.experimental.http.policy

Class ArmChallengeAuthenticationPolicy

java.lang.Object

com.azure.core.experimental.http.policy.BearerTokenAuthenticationChallengePolicy

com.azure.core.experimental.http.policy.ArmChallengeAuthenticationPolicy

All Implemented Interfaces:

HttpPipelinePolicy

public class ArmChallengeAuthenticationPolicy
extends BearerTokenAuthenticationChallengePolicy

The pipeline policy that applies a token credential to an HTTP request with "Bearer" scheme in ARM challenge based authentication scenarios . This is a temporary class to support ARM Challenge based authentication. It will move to azure-resource-manager package.

Constructor Summary

Constructors

Constructor and Description
ArmChallengeAuthenticationPolicy(TokenCredential credential, com.azure.core.experimental.implementation.AzureEnvironment environment, String... scopes) Creates ArmChallengeAuthenticationPolicy.

Method Summary

Modifier and Type	Method and 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.

Methods inherited from class com.azure.core.experimental.http.policy.BearerTokenAuthenticationChallengePolicy

process, setAuthorizationHeader

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

ArmChallengeAuthenticationPolicy

public ArmChallengeAuthenticationPolicy(TokenCredential credential,
                                        com.azure.core.experimental.implementation.AzureEnvironment environment,
                                        String... scopes)

Creates ArmChallengeAuthenticationPolicy.

Parameters:

credential - the token credential to authenticate the request

environment - the environment with endpoints for authentication

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

Method Detail

authorizeRequest

public Mono<Void> authorizeRequest(HttpPipelineCallContext context)

Description copied from class: BearerTokenAuthenticationChallengePolicy

Executed before sending the initial request and authenticates the request.

Overrides:

authorizeRequest in class BearerTokenAuthenticationChallengePolicy

Parameters:

context - The request context.

Returns:

A Mono containing Void

authorizeRequestOnChallenge

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

Description copied from class: BearerTokenAuthenticationChallengePolicy

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 BearerTokenAuthenticationChallengePolicy

Parameters:

context - The request context.

response - The Http Response containing the authentication challenge header.

Returns:

A Mono containing TokenRequestContext