com.microsoft.azure.sdk.iot.service.devicetwin

Class DeviceOperations

java.lang.Object

com.microsoft.azure.sdk.iot.service.devicetwin.DeviceOperations

public class DeviceOperations
extends Object

Set of common operations for Twin and Method.

Constructor Summary

Constructors

Constructor and Description
DeviceOperations()

Method Summary

Modifier and Type	Method and Description
static HttpResponse	request(IotHubConnectionString iotHubConnectionString, URL url, HttpMethod method, byte[] payload, String requestId, int connectTimeout, int readTimeout, Proxy proxy) Send a http request to the IoTHub using the Twin/Method standard, and return its response.
static HttpResponse	request(IotHubConnectionString iotHubConnectionString, URL url, HttpMethod method, byte[] payload, String requestId, long timeoutInMs) Deprecated. use request(IotHubConnectionString, URL, HttpMethod, byte[], String, int, int, Proxy) instead.
static HttpResponse	request(String credentialToken, URL url, HttpMethod method, byte[] payload, String requestId, int connectTimeout, int readTimeout, Proxy proxy) Send a http request to the IoTHub using the Twin/Method standard, and return its response.
static void	setHeaders(Map<String,String> httpHeaders) Sets headers to be used on next HTTP request.

Methods inherited from class java.lang.Object

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

Constructor Detail

DeviceOperations

public DeviceOperations()

Method Detail

request

@Deprecated
public static HttpResponse request(IotHubConnectionString iotHubConnectionString,
                                                URL url,
                                                HttpMethod method,
                                                byte[] payload,
                                                String requestId,
                                                long timeoutInMs)
                                         throws IOException,
                                                IotHubException,
                                                IllegalArgumentException

Deprecated. use request(IotHubConnectionString, URL, HttpMethod, byte[], String, int, int, Proxy) instead.

Send a http request to the IoTHub using the Twin/Method standard, and return its response.

Parameters:

iotHubConnectionString - is the connection string for the IoTHub.

url - is the Twin URL for the device ID.

method - is the HTTP method (GET, POST, DELETE, PATCH, PUT).

payload - is the array of bytes that contains the payload.

requestId - is an unique number that identify the request.

timeoutInMs - is timeout in milliseconds.

Returns:

the result of the request.

Throws:

IotHubException - This exception is thrown if the response verification failed.

IOException - This exception is thrown if the IO operation failed.

IllegalArgumentException

request

public static HttpResponse request(IotHubConnectionString iotHubConnectionString,
                                   URL url,
                                   HttpMethod method,
                                   byte[] payload,
                                   String requestId,
                                   int connectTimeout,
                                   int readTimeout,
                                   Proxy proxy)
                            throws IOException,
                                   IotHubException,
                                   IllegalArgumentException

Send a http request to the IoTHub using the Twin/Method standard, and return its response.

Parameters:

iotHubConnectionString - is the connection string for the IoTHub.

url - is the Twin URL for the device ID.

method - is the HTTP method (GET, POST, DELETE, PATCH, PUT).

payload - is the array of bytes that contains the payload.

requestId - is an unique number that identify the request.

connectTimeout - the http connect timeout to use, in milliseconds.

readTimeout - the http read timeout to use, in milliseconds.

proxy - the proxy to use, or null if no proxy will be used.

Returns:

the result of the request.

Throws:

IotHubException - This exception is thrown if the response verification failed.

IOException - This exception is thrown if the IO operation failed.

IllegalArgumentException

request

public static HttpResponse request(String credentialToken,
                                   URL url,
                                   HttpMethod method,
                                   byte[] payload,
                                   String requestId,
                                   int connectTimeout,
                                   int readTimeout,
                                   Proxy proxy)
                            throws IOException,
                                   IotHubException,
                                   IllegalArgumentException

Send a http request to the IoTHub using the Twin/Method standard, and return its response.

Parameters:

credentialToken - The authentication token that will be used to authorize the request

url - is the Twin URL for the device ID.

method - is the HTTP method (GET, POST, DELETE, PATCH, PUT).

payload - is the array of bytes that contains the payload.

requestId - is an unique number that identify the request.

connectTimeout - the http connect timeout to use, in milliseconds.

readTimeout - the http read timeout to use, in milliseconds.

proxy - the proxy to use, or null if no proxy will be used.

Returns:

the result of the request.

Throws:

IotHubException - This exception is thrown if the response verification failed.

IOException - This exception is thrown if the IO operation failed.

IllegalArgumentException

setHeaders

public static void setHeaders(Map<String,String> httpHeaders)
                       throws IllegalArgumentException

Sets headers to be used on next HTTP request.

Parameters:

httpHeaders - non null and non empty custom headers.

Throws:

IllegalArgumentException - This exception is thrown if headers were null or empty.