Dela via

HttpPipeline Class

  • Reference
Package:
com.azure.core.http
Maven Artifact:
com.azure:azure-core:1.54.1
  • java.lang.Object
    • com.azure.core.http.HttpPipeline

public final class HttpPipeline

The HTTP pipeline through which HTTP requests and responses flow.

This class encapsulates the HTTP pipeline that applies a set of HttpPipelinePolicy to the request before it is sent and on the response as it is being returned.

It provides methods to get the policy at a specific index in the pipeline, get the count of policies in the pipeline, get the associated HttpClient, and send the HTTP request through the pipeline.

This class is useful when you want to send an HTTP request and apply a set of policies to the request and response.

Method Summary

Modifier and Type Method and Description
HttpClient getHttpClient()

Get the HttpClient associated with the pipeline.
HttpPipelinePolicy getPolicy(int index)

Get the policy at the passed index in the pipeline.
int getPolicyCount()

Get the count of policies in the pipeline.
Tracer getTracer()

Get the Tracer associated with the pipeline.
Mono<HttpResponse> send(HttpPipelineCallContext context)

Sends the context (containing an HTTP request) through pipeline.
Mono<HttpResponse> send(HttpRequest request)

Wraps the request in a context and sends it through pipeline.
Mono<HttpResponse> send(HttpRequest request, Context data)

Wraps the request in a context with additional metadata and sends it through the pipeline.
HttpResponse sendSync(HttpRequest request, Context data)

Wraps the request in a context with additional metadata and sends it through the pipeline.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

getHttpClient

public HttpClient getHttpClient()

Get the HttpClient associated with the pipeline.

Returns:

the HttpClient associated with the pipeline

getPolicy

public HttpPipelinePolicy getPolicy(int index)

Get the policy at the passed index in the pipeline.

Parameters:

index - index of the policy to retrieve.

Returns:

the policy stored at that index.

getPolicyCount

public int getPolicyCount()

Get the count of policies in the pipeline.

Returns:

count of policies.

getTracer

public Tracer getTracer()

Get the Tracer associated with the pipeline.

Returns:

the Tracer associated with the pipeline

send

public Mono send(HttpPipelineCallContext context)

Sends the context (containing an HTTP request) through pipeline.

Parameters:

context - The request context.

Returns:

A publisher upon subscription flows the context through policies, sends the request and emits response upon completion.

send

public Mono send(HttpRequest request)

Wraps the request in a context and sends it through pipeline.

Parameters:

request - The HTTP request to send.

Returns:

A publisher upon subscription flows the context through policies, sends the request, and emits response upon completion.

send

public Mono send(HttpRequest request, Context data)

Wraps the request in a context with additional metadata and sends it through the pipeline.

Parameters:

request - THe HTTP request to send.
data - Additional metadata to pass along with the request.

Returns:

A publisher upon subscription flows the context through policies, sends the request, and emits response upon completion.

sendSync

public HttpResponse sendSync(HttpRequest request, Context data)

Wraps the request in a context with additional metadata and sends it through the pipeline.

Parameters:

request - THe HTTP request to send.
data - Additional metadata to pass along with the request.

Returns:

A publisher upon subscription flows the context through policies, sends the request, and emits response upon completion.

Applies to