HttpPipelinePolicy Interface

Package:

com.azure.core.http.policy

Maven Artifact:

com.azure:azure-core:1.54.0

public interface HttpPipelinePolicy

A policy within the HttpPipeline.

Method Summary

Modifier and Type	Method and Description
default HttpPipelinePosition	getPipelinePosition() Gets the position to place the policy.
abstract Mono<HttpResponse>	process(HttpPipelineCallContext context, HttpPipelineNextPolicy next) Processes provided request context and invokes the next policy.
default HttpResponse	processSync(HttpPipelineCallContext context, HttpPipelineNextSyncPolicy next) Processes provided request context and invokes the next policy synchronously.

Method Details

getPipelinePosition

public default HttpPipelinePosition getPipelinePosition()

Gets the position to place the policy.

By default pipeline policies are positioned PER_RETRY.

Returns:

The position to place the policy.

process

public abstract Mono process(HttpPipelineCallContext context, HttpPipelineNextPolicy next)

Processes provided request context and invokes the next policy.

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 default HttpResponse processSync(HttpPipelineCallContext context, HttpPipelineNextSyncPolicy next)

Processes provided request context and invokes the next policy synchronously.

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.