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

Class PortPolicy

java.lang.Object

com.azure.android.core.http.policy.PortPolicy

All Implemented Interfaces:

HttpPipelinePolicy

public class PortPolicy
extends java.lang.Object
implements HttpPipelinePolicy

The pipeline policy that adds a given port to each HttpRequest.

Constructor Summary

Constructors

Constructor	Description
PortPolicy(int port, boolean overwrite)	Creates a new PortPolicy object.

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

PortPolicy

public PortPolicy(int port,
                  boolean overwrite)

Creates a new PortPolicy object.

Parameters:

port - The port to set.

overwrite - Whether or not to overwrite a HttpRequest's port if it already has one.

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.