com.microsoft.azure.sdk.iot.service.transport.http

Class HttpRequest

java.lang.Object

com.microsoft.azure.sdk.iot.service.transport.http.HttpRequest

public class HttpRequest
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected HttpConnection	connection The underlying HTTPS connection stream.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HttpRequest()
	HttpRequest(URL url, HttpMethod method, byte[] body) Constructor.
	HttpRequest(URL url, HttpMethod method, byte[] body, Proxy proxy) Constructor.

Method Summary

Modifier and Type	Method and Description
HttpResponse	send() Executes the HTTPS request.
HttpRequest	setConnectTimeoutMillis(int timeout) Set the connect timeout, in milliseconds, for the request.
HttpRequest	setHeaderField(String field, String value) Sets the header field to the given value.
HttpRequest	setReadTimeoutMillis(int timeout) Sets the read timeout, in milliseconds, for the request.

Methods inherited from class java.lang.Object

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

Field Detail

connection

protected final HttpConnection connection

The underlying HTTPS connection stream.

Constructor Detail

HttpRequest

public HttpRequest(URL url,
                   HttpMethod method,
                   byte[] body)
            throws IOException

Constructor. Takes a URL as an argument and returns an HTTPS request that is ready to be sent.

Parameters:

url - The URL for the request.

method - The HTTPS request method (i.e. GET).

body - The request body. Must be an array of size 0 if the request method is GET or DELETE.

Throws:

IOException - This exception thrown if an IOException occurs in setting up the HTTPS connection.

IllegalArgumentException - This exception thrown if the endpoint given does not use the HTTPS protocol.

HttpRequest

public HttpRequest(URL url,
                   HttpMethod method,
                   byte[] body,
                   Proxy proxy)
            throws IOException

Constructor. Takes a URL as an argument and returns an HTTPS request that is ready to be sent through an optional proxy.

Parameters:

url - The URL for the request.

method - The HTTPS request method (i.e. GET).

body - The request body. Must be an array of size 0 if the request method is GET or DELETE.

proxy - The proxy to send the request through. May be null if no proxy should be used

Throws:

IOException - This exception thrown if an IOException occurs in setting up the HTTPS connection.

IllegalArgumentException - This exception thrown if the endpoint given does not use the HTTPS protocol.

HttpRequest

protected HttpRequest()

Method Detail

send

public HttpResponse send()
                  throws IOException

Executes the HTTPS request.

Returns:

The HTTPS response.

Throws:

IOException - This exception thrown if the connection could not be established, or the input/output streams could not be accessed.

setHeaderField

public HttpRequest setHeaderField(String field,
                                  String value)

Sets the header field to the given value.

Parameters:

field - The header field name.

value - The header field value.

Returns:

The object itself, for fluent setting.

setReadTimeoutMillis

public HttpRequest setReadTimeoutMillis(int timeout)

Sets the read timeout, in milliseconds, for the request. The read timeout is the number of milliseconds after the server receives a request and before the server sends data back.

Parameters:

timeout - The read timeout.

Returns:

The object itself, for fluent setting.

setConnectTimeoutMillis

public HttpRequest setConnectTimeoutMillis(int timeout)

Set the connect timeout, in milliseconds, for the request. The connect timeout is the allowed amount of time for the http connection to be established.

Parameters:

timeout - the connect timeout

Returns:

the object itself, for fluent setting.