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

Class HttpLoggingPolicy

java.lang.Object

com.azure.android.core.http.policy.HttpLoggingPolicy

All Implemented Interfaces:

HttpPipelinePolicy

public class HttpLoggingPolicy
extends java.lang.Object
implements HttpPipelinePolicy

The pipeline policy that handles logging of HTTP requests and responses.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	RETRY_COUNT_CONTEXT	Key for RequestContext to pass request retry count metadata for logging.

Constructor Summary

Constructors

Constructor	Description
HttpLoggingPolicy(HttpLogOptions httpLogOptions)	Creates an HttpLoggingPolicy with the given log configurations.

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

Field Detail

RETRY_COUNT_CONTEXT

public static final java.lang.String RETRY_COUNT_CONTEXT

Key for RequestContext to pass request retry count metadata for logging.

See Also:

Constant Field Values

Constructor Detail

HttpLoggingPolicy

public HttpLoggingPolicy(HttpLogOptions httpLogOptions)

Creates an HttpLoggingPolicy with the given log configurations.

Parameters:

httpLogOptions - The HTTP logging configuration options.

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.