Package com.azure.core.http.policy

Class ProtocolPolicy

java.lang.Object

com.azure.core.http.policy.ProtocolPolicy

All Implemented Interfaces:

HttpPipelinePolicy

public class ProtocolPolicy
extends Object
implements HttpPipelinePolicy

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

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

Code sample:

In this example, a ProtocolPolicy is created with a protocol of "https" and an overwrite flag set to true. The policy can then be added to the pipeline. Once added to the pipeline, requests have their protocol set to "https" by the ProtocolPolicy.

 ProtocolPolicy protocolPolicy = new ProtocolPolicy("https", true);
 

See Also:

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

Constructor Summary

Constructors

Constructor	Description
ProtocolPolicy(String protocol, boolean overwrite)	Creates a new ProtocolPolicy.

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

ProtocolPolicy

public ProtocolPolicy(String protocol,
 boolean overwrite)

Creates a new ProtocolPolicy.

Parameters:

protocol - The protocol to set.

overwrite - Whether to overwrite a HttpRequest's protocol 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.