com.microsoft.rest.v2.http

Class HttpPipelineBuilder

java.lang.Object

com.microsoft.rest.v2.http.HttpPipelineBuilder

public final class HttpPipelineBuilder
extends Object

A builder class that can be used to create a HttpPipeline.

Constructor Summary

Constructors

Constructor and Description
HttpPipelineBuilder() Create a new HttpPipeline builder.
HttpPipelineBuilder(HttpPipelineOptions options) Create a new HttpPipeline builder.

Method Summary

Modifier and Type	Method and Description
HttpPipeline	build() Create a new HttpPipeline from the RequestPolicy factories that have been added to this HttpPipeline builder.
HttpPipelineBuilder	withCookiePolicy() Add a RequestPolicy which stores and adds cookies across multiple requests and responses.
HttpPipelineBuilder	withCredentialsPolicy(ServiceClientCredentials credentials) Add a RequestPolicy which applies the given ServiceClientCredentials to outgoing requests.
HttpPipelineBuilder	withDecodingPolicy() Adds a RequestPolicy which decodes the headers and body of incoming responses.
HttpPipelineBuilder	withHostPolicy(String host) Adds a RequestPolicy which sets the host on all outgoing requests.
HttpPipelineBuilder	withHttpClient(HttpClient httpClient) Set the HttpClient that will be used by HttpPipelines that are created by this Builder.
HttpPipelineBuilder	withHttpLoggingPolicy(HttpLogDetailLevel level) Adds a RequestPolicy which logs all HTTP traffic using SLF4J.
HttpPipelineBuilder	withHttpLoggingPolicy(HttpLogDetailLevel level, boolean prettyPrintJSON) Adds a RequestPolicy which logs all HTTP traffic using SLF4J.
HttpPipelineBuilder	withLogger(HttpPipelineLogger logger) Set the Logger that will be used for each RequestPolicy within the created HttpPipeline.
HttpPipelineBuilder	withProxyAuthenticationPolicy(String username, String password) Adds a RequestPolicy which adds proxy authentication headers to outgoing requests.
HttpPipelineBuilder	withRequestIdPolicy() Adds a RequestPolicy which adds a per-request ID to the "x-ms-client-request-id" header to outgoing requests.
HttpPipelineBuilder	withRequestPolicies(RequestPolicyFactory... requestPolicyFactories) Add the provided RequestPolicy factories to this HttpPipeline builder.
HttpPipelineBuilder	withRequestPolicy(int index, RequestPolicyFactory requestPolicyFactory) Add the provided RequestPolicy factory to this HttpPipeline builder at the provided index in the pipeline.
HttpPipelineBuilder	withRequestPolicy(RequestPolicyFactory requestPolicyFactory) Add the provided RequestPolicy factory to this HttpPipeline builder.
HttpPipelineBuilder	withRetryPolicy(int maxRetries, long delayTime, TimeUnit timeUnit) Adds a RequestPolicy which retries a failed request up to the given number of times.
HttpPipelineBuilder	withTimeoutPolicy(long timeout, TimeUnit unit) Adds a RequestPolicy which fails a request if it does not complete by the time the given interval elapses.
HttpPipelineBuilder	withUserAgentPolicy(String userAgent) Add a RequestPolicy that will add the provided UserAgent header to each outgoing HttpRequest.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpPipelineBuilder

public HttpPipelineBuilder()

Create a new HttpPipeline builder.

HttpPipelineBuilder

public HttpPipelineBuilder(HttpPipelineOptions options)

Create a new HttpPipeline builder.

Parameters:

options - The optional properties that will be set on the created HTTP pipelines.

Method Detail

withHttpClient

public HttpPipelineBuilder withHttpClient(HttpClient httpClient)

Set the HttpClient that will be used by HttpPipelines that are created by this Builder.

Parameters:

httpClient - The HttpClient to use.

Returns:

This HttpPipeline builder.

withLogger

public HttpPipelineBuilder withLogger(HttpPipelineLogger logger)

Set the Logger that will be used for each RequestPolicy within the created HttpPipeline.

Parameters:

logger - The Logger to provide to each RequestPolicy.

Returns:

This HttpPipeline options object.

withRequestPolicy

public HttpPipelineBuilder withRequestPolicy(RequestPolicyFactory requestPolicyFactory)

Add the provided RequestPolicy factory to this HttpPipeline builder.

Parameters:

requestPolicyFactory - The RequestPolicy factory to add to this HttpPipeline builder.

Returns:

This HttpPipeline builder.

withRequestPolicy

public HttpPipelineBuilder withRequestPolicy(int index,
                                             RequestPolicyFactory requestPolicyFactory)

Add the provided RequestPolicy factory to this HttpPipeline builder at the provided index in the pipeline.

Parameters:

index - The index to insert the provided RequestPolicy factory.

requestPolicyFactory - The RequestPolicy factory to add to this HttpPipeline builder.

Returns:

This HttpPipeline builder.

withRequestPolicies

public HttpPipelineBuilder withRequestPolicies(RequestPolicyFactory... requestPolicyFactories)

Add the provided RequestPolicy factories to this HttpPipeline builder.

Parameters:

requestPolicyFactories - The RequestPolicy factories to add to this HttpPipeline builder.

Returns:

This HttpPipeline builder.

withCookiePolicy

public HttpPipelineBuilder withCookiePolicy()

Add a RequestPolicy which stores and adds cookies across multiple requests and responses.

Returns:

This HttpPipeline builder.

withCredentialsPolicy

public HttpPipelineBuilder withCredentialsPolicy(ServiceClientCredentials credentials)

Add a RequestPolicy which applies the given ServiceClientCredentials to outgoing requests.

Parameters:

credentials - The credentials to apply to requests.

Returns:

This HttpPipeline builder.

withDecodingPolicy

public HttpPipelineBuilder withDecodingPolicy()

Adds a RequestPolicy which decodes the headers and body of incoming responses. Required for services that need to deserialize JSON or XML responses.

Returns:

This HttpPipeline builder.

withHostPolicy

public HttpPipelineBuilder withHostPolicy(String host)

Adds a RequestPolicy which sets the host on all outgoing requests.

Parameters:

host - The hostname to use in all outgoing requests.

Returns:

This HttpPipelineBuilder.

withHttpLoggingPolicy

public HttpPipelineBuilder withHttpLoggingPolicy(HttpLogDetailLevel level)

Adds a RequestPolicy which logs all HTTP traffic using SLF4J.

Parameters:

level - The HTTP logging detail level.

Returns:

This HttpPipeline builder.

withHttpLoggingPolicy

public HttpPipelineBuilder withHttpLoggingPolicy(HttpLogDetailLevel level,
                                                 boolean prettyPrintJSON)

Adds a RequestPolicy which logs all HTTP traffic using SLF4J.

Parameters:

level - The HTTP logging detail level.

prettyPrintJSON - Whether or not to pretty print JSON message bodies.

Returns:

This HttpPipeline builder.

withProxyAuthenticationPolicy

public HttpPipelineBuilder withProxyAuthenticationPolicy(String username,
                                                         String password)

Adds a RequestPolicy which adds proxy authentication headers to outgoing requests.

Parameters:

username - The username for authentication.

password - The password for authentication.

Returns:

This HttpPipeline builder.

withRequestIdPolicy

public HttpPipelineBuilder withRequestIdPolicy()

Adds a RequestPolicy which adds a per-request ID to the "x-ms-client-request-id" header to outgoing requests.

Returns:

This HttpPipeline builder.

withRetryPolicy

public HttpPipelineBuilder withRetryPolicy(int maxRetries,
                                           long delayTime,
                                           TimeUnit timeUnit)

Adds a RequestPolicy which retries a failed request up to the given number of times.

Parameters:

maxRetries - The maximum number of times to retry failed requests.

delayTime - the delay between retries

timeUnit - the time unit of the delay

Returns:

This HttpPipeline builder.

withTimeoutPolicy

public HttpPipelineBuilder withTimeoutPolicy(long timeout,
                                             TimeUnit unit)

Adds a RequestPolicy which fails a request if it does not complete by the time the given interval elapses.

Parameters:

timeout - The amount of time to wait before timing out a request.

unit - The unit of time associated with the timeout parameter.

Returns:

This HttpPipeline builder.

withUserAgentPolicy

public HttpPipelineBuilder withUserAgentPolicy(String userAgent)

Add a RequestPolicy that will add the provided UserAgent header to each outgoing HttpRequest.

Parameters:

userAgent - The userAgent header value to add to each outgoing HttpRequest.

Returns:

This HttpPipeline builder.

build

public HttpPipeline build()

Create a new HttpPipeline from the RequestPolicy factories that have been added to this HttpPipeline builder.

Returns:

The created HttpPipeline.