com.microsoft.azure.sdk.iot.service

Class RegistryManager

java.lang.Object

com.microsoft.azure.sdk.iot.service.RegistryManager

public class RegistryManager
extends Object

Use the RegistryManager class to manage the identity registry in IoT Hubs.

Constructor Summary

Constructors

Constructor and Description
RegistryManager()

Method Summary

Modifier and Type	Method and Description
Device	addDevice(Device device) Add device using the given Device object Return with the response device object from IotHub
CompletableFuture<Device>	addDeviceAsync(Device device) Async wrapper for add() operation
void	close() Placeholder for close registry operations
static RegistryManager	createFromConnectionString(String connectionString) Static constructor to create instance from connection string
JobProperties	exportDevices(String exportBlobContainerUri, Boolean excludeKeys) Create a bulk export job.
CompletableFuture<JobProperties>	exportDevicesAsync(String exportBlobContainerUri, Boolean excludeKeys) Async wrapper for exportDevices() operation
Device	getDevice(String deviceId) Get device data by device Id from IotHub
CompletableFuture<Device>	getDeviceAsync(String deviceId) Async wrapper for getDevice() operation
String	getDeviceConnectionString(Device device) Return the iothub device connection string for a provided device.
ArrayList<Device>	getDevices(Integer maxCount) Get list of devices
CompletableFuture<ArrayList<Device>>	getDevicesAsync(Integer maxCount) Async wrapper for getDevices() operation
JobProperties	getJob(String jobId) Get the properties of an existing job.
CompletableFuture<JobProperties>	getJobAsync(String jobId) Async wrapper for getJob() operation
RegistryStatistics	getStatistics() Get device statistics
CompletableFuture<RegistryStatistics>	getStatisticsAsync() Async wrapper for getStatistics() operation
JobProperties	importDevices(String importBlobContainerUri, String outputBlobContainerUri) Create a bulk import job.
CompletableFuture<JobProperties>	importDevicesAsync(String importBlobContainerUri, String outputBlobContainerUri) Async wrapper for importDevices() operation
void	open() Placeholder for open registry operations
void	removeDevice(String deviceId) Remove device
CompletableFuture<Boolean>	removeDeviceAsync(String deviceId) Async wrapper for removeDevice() operation
Device	updateDevice(Device device) Update device not forced
Device	updateDevice(Device device, Boolean forceUpdate) Update device with forceUpdate input parameter
CompletableFuture<Device>	updateDeviceAsync(Device device) Async wrapper for updateDevice() operation
CompletableFuture<Device>	updateDeviceAsync(Device device, Boolean forceUpdate) Async wrapper for forced updateDevice() operation

Methods inherited from class java.lang.Object

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

Constructor Detail

RegistryManager

public RegistryManager()

Method Detail

createFromConnectionString

public static RegistryManager createFromConnectionString(String connectionString)
                                                  throws IOException

Static constructor to create instance from connection string

Parameters:

connectionString - The iot hub connection string

Returns:

The instance of RegistryManager

Throws:

IOException - This exception is thrown if the object creation failed

open

public void open()

Placeholder for open registry operations

close

public void close()

Placeholder for close registry operations

addDevice

public Device addDevice(Device device)
                 throws IOException,
                        IotHubException,
                        com.google.gson.JsonSyntaxException

Add device using the given Device object Return with the response device object from IotHub

Parameters:

device - The device object to add

Returns:

The future object for the requested operation

Throws:

IOException - This exception is thrown if the IO operation failed

IotHubException - This exception is thrown if the response verification failed

com.google.gson.JsonSyntaxException

addDeviceAsync

public CompletableFuture<Device> addDeviceAsync(Device device)
                                         throws IOException,
                                                IotHubException

Async wrapper for add() operation

Parameters:

device - The device object to add

Returns:

The future object for the requested operation

Throws:

IOException - This exception is thrown if the IO operation failed

IotHubException - This exception is thrown if the response verification failed

getDevice

public Device getDevice(String deviceId)
                 throws IOException,
                        IotHubException,
                        com.google.gson.JsonSyntaxException

Get device data by device Id from IotHub

Parameters:

deviceId - The id of requested device

Returns:

The device object of requested device

Throws:

IOException - This exception is thrown if the IO operation failed

IotHubException - This exception is thrown if the response verification failed

com.google.gson.JsonSyntaxException

getDeviceAsync

public CompletableFuture<Device> getDeviceAsync(String deviceId)
                                         throws IOException,
                                                IotHubException

Async wrapper for getDevice() operation

Parameters:

deviceId - The id of requested device

Returns:

The future object for the requested operation

Throws:

IOException - This exception is thrown if the IO operation failed

IotHubException - This exception is thrown if the response verification failed

getDevices

public ArrayList<Device> getDevices(Integer maxCount)
                             throws IOException,
                                    IotHubException,
                                    com.google.gson.JsonSyntaxException

Get list of devices

Parameters:

maxCount - The requested count of devices

Returns:

The array of requested device objects

Throws:

IOException - This exception is thrown if the IO operation failed

IotHubException - This exception is thrown if the response verification failed

com.google.gson.JsonSyntaxException

getDevicesAsync

public CompletableFuture<ArrayList<Device>> getDevicesAsync(Integer maxCount)
                                                     throws IOException,
                                                            IotHubException

Async wrapper for getDevices() operation

Parameters:

maxCount - The requested count of devices

Returns:

The future object for the requested operation

Throws:

IOException - This exception is thrown if the IO operation failed

IotHubException - This exception is thrown if the response verification failed

getDeviceConnectionString

public String getDeviceConnectionString(Device device)

Return the iothub device connection string for a provided device.

Parameters:

device - The device object to get the connectionString

Returns:

The iothub device connection string

updateDevice

public Device updateDevice(Device device)
                    throws IOException,
                           IotHubException

Update device not forced

Parameters:

device - The device object containing updated data

Returns:

The updated device object

Throws:

IOException - This exception is thrown if the IO operation failed

IotHubException - This exception is thrown if the response verification failed

updateDevice

public Device updateDevice(Device device,
                           Boolean forceUpdate)
                    throws IOException,
                           IotHubException,
                           com.google.gson.JsonSyntaxException

Update device with forceUpdate input parameter

Parameters:

device - The device object containing updated data

forceUpdate - True if the update has to be forced regardless of the device state

Returns:

The updated device object

Throws:

IOException - This exception is thrown if the IO operation failed

IotHubException - This exception is thrown if the response verification failed

com.google.gson.JsonSyntaxException

updateDeviceAsync

public CompletableFuture<Device> updateDeviceAsync(Device device)
                                            throws IOException,
                                                   IotHubException

Async wrapper for updateDevice() operation

Parameters:

device - The device object containing updated data

Returns:

The future object for the requested operation

Throws:

IOException - This exception is thrown if the IO operation failed

IotHubException - This exception is thrown if the response verification failed

updateDeviceAsync

public CompletableFuture<Device> updateDeviceAsync(Device device,
                                                   Boolean forceUpdate)
                                            throws IOException,
                                                   IotHubException

Async wrapper for forced updateDevice() operation

Parameters:

device - The device object containing updated data

forceUpdate - True is the update has to be forced regardless if the device state

Returns:

The future object for the requested operation

Throws:

IOException - This exception is thrown if the IO operation failed

IotHubException - This exception is thrown if the response verification failed

removeDevice

public void removeDevice(String deviceId)
                  throws IOException,
                         IotHubException

Remove device

Parameters:

deviceId - The device name to remove

Throws:

IOException - This exception is thrown if the IO operation failed

IotHubException - This exception is thrown if the response verification failed

removeDeviceAsync

public CompletableFuture<Boolean> removeDeviceAsync(String deviceId)
                                             throws IOException,
                                                    IotHubException

Async wrapper for removeDevice() operation

Parameters:

deviceId - The device object to remove

Returns:

The future object for the requested operation

Throws:

IOException - This exception is thrown if the IO operation failed

IotHubException - This exception is thrown if the response verification failed

getStatistics

public RegistryStatistics getStatistics()
                                 throws IOException,
                                        IotHubException,
                                        com.google.gson.JsonSyntaxException

Get device statistics

Returns:

RegistryStatistics object containing the requested data

Throws:

IOException - This exception is thrown if the IO operation failed

IotHubException - This exception is thrown if the response verification failed

com.google.gson.JsonSyntaxException

getStatisticsAsync

public CompletableFuture<RegistryStatistics> getStatisticsAsync()
                                                         throws IOException,
                                                                IotHubException

Async wrapper for getStatistics() operation

Returns:

The future object for the requested operation

Throws:

IOException - This exception is thrown if the IO operation failed

IotHubException - This exception is thrown if the response verification failed

exportDevices

public JobProperties exportDevices(String exportBlobContainerUri,
                                   Boolean excludeKeys)
                            throws IllegalArgumentException,
                                   IOException,
                                   IotHubException,
                                   com.google.gson.JsonSyntaxException

Create a bulk export job.

Parameters:

exportBlobContainerUri - URI containing SAS token to a blob container where export data will be placed

excludeKeys - Whether the devices keys should be excluded from the exported data or not

Returns:

A JobProperties object for the newly created bulk export job

Throws:

IllegalArgumentException - This exception is thrown if the exportBlobContainerUri or excludeKeys parameters are null

IOException - This exception is thrown if the IO operation failed

IotHubException - This exception is thrown if the response verification failed

com.google.gson.JsonSyntaxException

exportDevicesAsync

public CompletableFuture<JobProperties> exportDevicesAsync(String exportBlobContainerUri,
                                                           Boolean excludeKeys)
                                                    throws IllegalArgumentException,
                                                           IOException,
                                                           IotHubException,
                                                           com.google.gson.JsonSyntaxException

Async wrapper for exportDevices() operation

Parameters:

excludeKeys - if to exclude keys or not

exportBlobContainerUri - the blob storage container URI to store at.

Returns:

The future object for the requested operation

Throws:

IllegalArgumentException - This exception is thrown if the exportBlobContainerUri or excludeKeys parameters are null

IOException - This exception is thrown if the IO operation failed

IotHubException - This exception is thrown if the response verification failed

com.google.gson.JsonSyntaxException

importDevices

public JobProperties importDevices(String importBlobContainerUri,
                                   String outputBlobContainerUri)
                            throws IllegalArgumentException,
                                   IOException,
                                   IotHubException,
                                   com.google.gson.JsonSyntaxException

Create a bulk import job.

Parameters:

importBlobContainerUri - URI containing SAS token to a blob container that contains registry data to sync

outputBlobContainerUri - URI containing SAS token to a blob container where the result of the bulk import operation will be placed

Returns:

A JobProperties object for the newly created bulk import job

Throws:

IllegalArgumentException - This exception is thrown if the importBlobContainerUri or outputBlobContainerUri parameters are null

IOException - This exception is thrown if the IO operation failed

IotHubException - This exception is thrown if the response verification failed

com.google.gson.JsonSyntaxException

importDevicesAsync

public CompletableFuture<JobProperties> importDevicesAsync(String importBlobContainerUri,
                                                           String outputBlobContainerUri)
                                                    throws IllegalArgumentException,
                                                           IOException,
                                                           IotHubException,
                                                           com.google.gson.JsonSyntaxException

Async wrapper for importDevices() operation

Parameters:

importBlobContainerUri - Uri for importBlobContainer

outputBlobContainerUri - Uri for outputBlobContainer

Returns:

The future object for the requested operation

Throws:

IllegalArgumentException - This exception is thrown if the exportBlobContainerUri or excludeKeys parameters are null

IOException - This exception is thrown if the IO operation failed

IotHubException - This exception is thrown if the response verification failed

com.google.gson.JsonSyntaxException

getJob

public JobProperties getJob(String jobId)
                     throws IllegalArgumentException,
                            IOException,
                            IotHubException,
                            com.google.gson.JsonSyntaxException

Get the properties of an existing job.

Parameters:

jobId - The id of the job to be retrieved.

Returns:

A JobProperties object for the requested job id

Throws:

IllegalArgumentException - This exception is thrown if the jobId parameter is null

IOException - This exception is thrown if the IO operation failed

IotHubException - This exception is thrown if the response verification failed

com.google.gson.JsonSyntaxException

getJobAsync

public CompletableFuture<JobProperties> getJobAsync(String jobId)
                                             throws IllegalArgumentException,
                                                    IOException,
                                                    IotHubException

Async wrapper for getJob() operation

Parameters:

jobId - jobID as String

Returns:

The future object for the requested operation

Throws:

IllegalArgumentException - This exception is thrown if the jobId parameter is null

IOException - This exception is thrown if the IO operation failed

IotHubException - This exception is thrown if the response verification failed