Package com.azure.core.http.policy

Class AzureSasCredentialPolicy

java.lang.Object

com.azure.core.http.policy.AzureSasCredentialPolicy

All Implemented Interfaces:

HttpPipelinePolicy

public final class AzureSasCredentialPolicy
extends Object
implements HttpPipelinePolicy

Pipeline policy that uses an AzureSasCredential to set the shared access signature for a request.

Constructor Summary

Constructors

Constructor	Description
AzureSasCredentialPolicy(AzureSasCredential credential)	Creates a policy that uses the passed AzureSasCredential to append sas to query string.
AzureSasCredentialPolicy(AzureSasCredential credential, boolean requireHttps)	Creates a policy that uses the passed AzureSasCredential to append sas to query string.

Method Summary

Modifier and Type	Method	Description
Mono<HttpResponse>	process(HttpPipelineCallContext context, HttpPipelineNextPolicy next)	Processes provided request context and invokes the next policy.
HttpResponse	processSync(HttpPipelineCallContext context, HttpPipelineNextSyncPolicy next)	Processes provided request context and invokes the next policy synchronously.

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

AzureSasCredentialPolicy

public AzureSasCredentialPolicy(AzureSasCredential credential)

Creates a policy that uses the passed AzureSasCredential to append sas to query string.

Requests sent with this pipeline policy are required to use HTTPS. If the request isn't using HTTPS an exception will be thrown to prevent leaking the shared access signature.

Parameters:

credential - The AzureSasCredential containing the shared access signature to use.

Throws:

NullPointerException - If credential is null.

AzureSasCredentialPolicy

public AzureSasCredentialPolicy(AzureSasCredential credential,
 boolean requireHttps)

Creates a policy that uses the passed AzureSasCredential to append sas to query string.

Parameters:

credential - The AzureSasCredential containing the shared access signature to use.

requireHttps - A flag indicating whether HTTPS is required.

Throws:

NullPointerException - If credential is null.

Method Details

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.

processSync

public HttpResponse processSync(HttpPipelineCallContext context,
 HttpPipelineNextSyncPolicy next)

Description copied from interface: HttpPipelinePolicy

Processes provided request context and invokes the next policy synchronously.

Specified by:

processSync 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.