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

Class RequestIdPolicy

java.lang.Object

com.azure.android.core.http.policy.RequestIdPolicy

All Implemented Interfaces:

HttpPipelinePolicy

public class RequestIdPolicy
extends java.lang.Object
implements HttpPipelinePolicy

The pipeline policy that puts a UUID in the request header. Azure uses the request id as the unique identifier for the request.

Constructor Summary

Constructors

Constructor	Description
RequestIdPolicy()	Creates default RequestIdPolicy with default header name 'x-ms-client-request-id'.
RequestIdPolicy(java.lang.String requestIdHeaderName)	Creates RequestIdPolicy with provided requestIdHeaderName.

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

RequestIdPolicy

public RequestIdPolicy(java.lang.String requestIdHeaderName)

Creates RequestIdPolicy with provided requestIdHeaderName.

Parameters:

requestIdHeaderName - to be used to set in HttpRequest.

RequestIdPolicy

public RequestIdPolicy()

Creates default RequestIdPolicy with default header name 'x-ms-client-request-id'.

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.