com.microsoft.azure.sdk.iot.device.transport.https

Class HttpsRequest

java.lang.Object

com.microsoft.azure.sdk.iot.device.transport.https.HttpsRequest

public class HttpsRequest
extends Object

An HTTPS request.

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HttpsRequest()
	HttpsRequest(URL url, HttpsMethod method, byte[] body) Constructor.

Method Summary

Modifier and Type	Method and Description
HttpsResponse	send() Executes the HTTPS request.
HttpsRequest	setHeaderField(String field, String value) Sets the header field to the given value.
HttpsRequest	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 HttpsConnection connection

The underlying HTTPS connection stream.

Constructor Detail

HttpsRequest

public HttpsRequest(URL url,
                    HttpsMethod 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 - if an IOException occurs in setting up the HTTPS connection.

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

HttpsRequest

protected HttpsRequest()

Method Detail

send

public HttpsResponse send()
                   throws IOException

Executes the HTTPS request.

Returns:

an HTTPS response.

Throws:

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

setHeaderField

public HttpsRequest 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:

itself, for fluent setting.

setReadTimeoutMillis

public HttpsRequest 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:

itself, for fluent setting.