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

Class AddHeadersPolicy

java.lang.Object

com.azure.android.core.http.policy.AddHeadersPolicy

All Implemented Interfaces:

HttpPipelinePolicy

public class AddHeadersPolicy
extends java.lang.Object
implements HttpPipelinePolicy

The pipeline policy that adds a particular set of headers to HTTP requests.

Constructor Summary

Constructors

Constructor	Description
AddHeadersPolicy(HttpHeaders headers)	Creates a AddHeadersPolicy.

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

AddHeadersPolicy

public AddHeadersPolicy(HttpHeaders headers)

Creates a AddHeadersPolicy.

Parameters:

headers - The headers to add to outgoing requests.

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.