Package com.azure.android.core.http.policy

Class AzureKeyCredentialPolicy

java.lang.Object

com.azure.android.core.http.policy.AzureKeyCredentialPolicy

All Implemented Interfaces:

HttpPipelinePolicy

public class AzureKeyCredentialPolicy
extends java.lang.Object
implements HttpPipelinePolicy

Pipeline policy that uses an AzureKeyCredential to set the authorization key for a request.

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

Constructor Summary

Constructors

Constructor	Description
AzureKeyCredentialPolicy(java.lang.String name, com.azure.android.core.credential.AzureKeyCredential credential)	Creates a policy that uses the provided AzureKeyCredential to set the specified header name.

Method Summary

Modifier and Type	Method	Description
void	process(HttpPipelinePolicyChain chain)	Applies the policy to a HttpRequest and the corresponding HttpResponse.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AzureKeyCredentialPolicy

public AzureKeyCredentialPolicy(java.lang.String name,
                                com.azure.android.core.credential.AzureKeyCredential credential)

Creates a policy that uses the provided AzureKeyCredential to set the specified header name.

Parameters:

name - The name of the key header that will be set to AzureKeyCredential.getKey().

credential - The AzureKeyCredential containing the authorization key to use.

Throws:

java.lang.NullPointerException - If name or credential is null.

java.lang.IllegalArgumentException - If name is empty.

Method Detail

process

public void process(HttpPipelinePolicyChain chain)

Description copied from interface: HttpPipelinePolicy

Applies the policy to a HttpRequest and the corresponding HttpResponse.

Policy implementations are expected to use HttpPipelinePolicyChain.getRequest() to access and intercept the request, then proceed to next policy by calling HttpPipelinePolicyChain.processNextPolicy(HttpRequest) or HttpPipelinePolicyChain.processNextPolicy(HttpRequest, NextPolicyCallback). The policy can intercept the resulting response notified to NextPolicyCallback.onSuccess(HttpResponse, PolicyCompleter) or error notified to NextPolicyCallback.onError(Throwable, PolicyCompleter) and must signal the completion of the policy by calling PolicyCompleter.completed(HttpResponse) or PolicyCompleter.completedError(Throwable).

Specified by:

process in interface HttpPipelinePolicy

Parameters:

chain - The chain for the policy to access the request and response.