com.microsoft.rest.v2.http

Class HttpRequest

java.lang.Object

com.microsoft.rest.v2.http.HttpRequest

public class HttpRequest
extends Object

This class contains all of the details necessary for sending a HTTP request through a HttpClient.

Constructor Summary

Constructors

Constructor and Description
HttpRequest(String callerMethod, HttpMethod httpMethod, URL url, HttpHeaders headers, io.reactivex.Flowable<ByteBuffer> body, HttpResponseDecoder responseDecoder) Create a new HttpRequest object.
HttpRequest(String callerMethod, HttpMethod httpMethod, URL url, HttpResponseDecoder responseDecoder) Create a new HttpRequest object with the provided HTTP method (GET, POST, PUT, etc.) and the provided URL.

Method Summary

Modifier and Type	Method and Description
io.reactivex.Flowable<ByteBuffer>	body() Get the body for this HttpRequest.
HttpRequest	buffer() Performs a deep clone of this HTTP request.
String	callerMethod() Get the fully qualified method that was called to invoke this HTTP request.
Context	context()
HttpHeaders	headers() Get the headers for this request.
HttpMethod	httpMethod() Get the HTTP method that this request will use.
HttpResponseDecoder	responseDecoder() Get the HttpResponseDecoder which decodes messages sent in response to this HttpRequest.
URL	url() Get the URL that this request will be sent to.
HttpRequest	withBody(byte[] body) Set the body of this HTTP request, automatically setting the Content-Length header based on the given body's length.
HttpRequest	withBody(io.reactivex.Flowable<ByteBuffer> body) Set the body of this HTTP request, leaving request headers unmodified.
HttpRequest	withBody(String body) Set the body of this HTTP request.
HttpRequest	withCallerMethod(String callerMethod) Set the caller method for this request.
HttpRequest	withContext(Context context)
HttpRequest	withHeader(String headerName, String headerValue) Add the provided headerName and headerValue to the list of headers for this request.
HttpRequest	withHeaders(HttpHeaders headers) Set the headers for this request.
HttpRequest	withHttpMethod(HttpMethod httpMethod) Set the HTTP method that this request will use.
HttpRequest	withUrl(URL url) Set the URL that this request will be sent to.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpRequest

public HttpRequest(String callerMethod,
                   HttpMethod httpMethod,
                   URL url,
                   HttpResponseDecoder responseDecoder)

Create a new HttpRequest object with the provided HTTP method (GET, POST, PUT, etc.) and the provided URL.

Parameters:

callerMethod - The fully qualified method that was called to invoke this HTTP request.

httpMethod - The HTTP method to use with this request.

url - The URL where this HTTP request should be sent to.

responseDecoder - the which decodes messages sent in response to this HttpRequest.

HttpRequest

public HttpRequest(String callerMethod,
                   HttpMethod httpMethod,
                   URL url,
                   HttpHeaders headers,
                   io.reactivex.Flowable<ByteBuffer> body,
                   HttpResponseDecoder responseDecoder)

Create a new HttpRequest object.

Parameters:

callerMethod - The fully qualified method that was called to invoke this HTTP request.

httpMethod - The HTTP method to use with this request.

url - The URL where this HTTP request should be sent to.

headers - The HTTP headers to use with this request.

body - The body of this HTTP request.

responseDecoder - the which decodes messages sent in response to this HttpRequest.

Method Detail

callerMethod

public String callerMethod()

Get the fully qualified method that was called to invoke this HTTP request.

Returns:

The fully qualified method that was called to invoke this HTTP request.

withCallerMethod

public HttpRequest withCallerMethod(String callerMethod)

Set the caller method for this request.

Parameters:

callerMethod - The fully qualified method that was called to invoke this HTTP request.

Returns:

This HttpRequest instance for chaining.

httpMethod

public HttpMethod httpMethod()

Get the HTTP method that this request will use.

Returns:

The HTTP method that this request will use.

withHttpMethod

public HttpRequest withHttpMethod(HttpMethod httpMethod)

Set the HTTP method that this request will use.

Parameters:

httpMethod - The HTTP method to use, e.g. "GET".

Returns:

This HttpRequest so that multiple operations can be chained together.

url

public URL url()

Get the URL that this request will be sent to.

Returns:

The URL that this request will be sent to.

withUrl

public HttpRequest withUrl(URL url)

Set the URL that this request will be sent to.

Parameters:

url - The new URL that this request will be sent to.

Returns:

This HttpRequest so that multiple operations can be chained together.

responseDecoder

public HttpResponseDecoder responseDecoder()

Get the HttpResponseDecoder which decodes messages sent in response to this HttpRequest.

Returns:

the response decoder

headers

public HttpHeaders headers()

Get the headers for this request.

Returns:

The headers for this request.

withHeaders

public HttpRequest withHeaders(HttpHeaders headers)

Set the headers for this request.

Parameters:

headers - The set of headers to send for this request.

Returns:

This HttpRequest so that multiple operations can be chained together.

withHeader

public HttpRequest withHeader(String headerName,
                              String headerValue)

Add the provided headerName and headerValue to the list of headers for this request.

Parameters:

headerName - The name of the header.

headerValue - The value of the header.

Returns:

This HttpRequest so that multiple operations can be chained together.

body

public io.reactivex.Flowable<ByteBuffer> body()

Get the body for this HttpRequest.

Returns:

The body for this HttpRequest.

withBody

public HttpRequest withBody(String body)

Set the body of this HTTP request.

Parameters:

body - The body of this HTTP request.

Returns:

This HttpRequest so that multiple operations can be chained together.

withBody

public HttpRequest withBody(byte[] body)

Set the body of this HTTP request, automatically setting the Content-Length header based on the given body's length.

Parameters:

body - The body of this HTTP request.

Returns:

This HttpRequest so that multiple operations can be chained together.

withBody

public HttpRequest withBody(io.reactivex.Flowable<ByteBuffer> body)

Set the body of this HTTP request, leaving request headers unmodified. Users must set the Content-Length header to indicate the length of the new body, or use Transfer-Encoding: chunked.

Parameters:

body - The body of this HTTP request.

Returns:

This HttpRequest so that multiple operations can be chained together.

context

public Context context()

Returns:

the Context associated with this HttpRequest

withContext

public HttpRequest withContext(Context context)

Parameters:

context - the context to associate with this HttpRequest

Returns:

This HttpRequest so that multiple operations can be chained together.

buffer

public HttpRequest buffer()

Performs a deep clone of this HTTP request. The main purpose of this is so that this HttpRequest can be changed and the resulting HttpRequest can be a backup. This means that the buffered HttpHeaders and body must not be able to change from side effects of this HttpRequest.

Returns:

A new HTTP request instance with cloned instances of all mutable properties.