Package com.azure.core.http.policy

Class PortPolicy

java.lang.Object

com.azure.core.http.policy.PortPolicy

All Implemented Interfaces:

HttpPipelinePolicy

public class PortPolicy
extends Object
implements HttpPipelinePolicy

The PortPolicy class is an implementation of the HttpPipelinePolicy interface. This policy is used to add a specific port to each HttpRequest.

This class is useful when you need to set a specific port for all requests in a pipeline. It ensures that the port is set correctly for each request.

Code sample:

In this example, a PortPolicy is created with a port of 8080 and an overwrite flag set to true. The policy can then be added to the pipeline. Once added to the pipeline, all requests will have their port set to 8080 by the PortPolicy.

 PortPolicy portPolicy = new PortPolicy(8080, true);
 

See Also:

• com.azure.core.http.policy
• HttpPipelinePolicy
• HttpPipeline
• HttpRequest
• HttpResponse

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Mono<HttpResponse>	process(HttpPipelineCallContext context, HttpPipelineNextPolicy next)	Processes provided request context and invokes the next policy.
HttpResponse	processSync(HttpPipelineCallContext context, HttpPipelineNextSyncPolicy next)	Processes provided request context and invokes the next policy synchronously.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.azure.core.http.policy.HttpPipelinePolicy

getPipelinePosition

Constructor Details

PortPolicy

public PortPolicy(int port,
 boolean overwrite)

Creates a new PortPolicy object.

Parameters:

port - The port to set.

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

Method Details

process

public Mono<HttpResponse> process(HttpPipelineCallContext context,
 HttpPipelineNextPolicy next)

Description copied from interface: HttpPipelinePolicy

Processes provided request context and invokes the next policy.

Specified by:

process in interface HttpPipelinePolicy

Parameters:

context - The request context.

next - The next policy to invoke.

Returns:

A publisher that initiates the request upon subscription and emits a response on completion.

processSync

public HttpResponse processSync(HttpPipelineCallContext context,
 HttpPipelineNextSyncPolicy next)

Description copied from interface: HttpPipelinePolicy

Processes provided request context and invokes the next policy synchronously.

Specified by:

processSync in interface HttpPipelinePolicy

Parameters:

context - The request context.

next - The next policy to invoke.

Returns:

A publisher that initiates the request upon subscription and emits a response on completion.