com.azure.core.http.policy

Interface HttpPipelinePolicy

All Known Implementing Classes:

AddDatePolicy, AddHeadersFromContextPolicy, AddHeadersPolicy, AzureKeyCredentialPolicy, AzureSasCredentialPolicy, BearerTokenAuthenticationPolicy, CookiePolicy, HostPolicy, HttpLoggingPolicy, PortPolicy, ProtocolPolicy, RequestIdPolicy, RetryPolicy, TimeoutPolicy, UserAgentPolicy

@FunctionalInterface
public interface HttpPipelinePolicy

A policy within the HttpPipeline.

See Also:

HttpPipeline

Method Summary

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

Method Detail

process

Mono<HttpResponse> 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.

getPipelinePosition

default HttpPipelinePosition getPipelinePosition()

Gets the position to place the policy.

By default pipeline policies are positioned HttpPipelinePosition.PER_RETRY.

Returns:

The position to place the policy.