com.microsoft.azure.sdk.iot.service

Class Device

java.lang.Object

com.microsoft.azure.sdk.iot.service.BaseDevice

com.microsoft.azure.sdk.iot.service.Device

public class Device
extends BaseDevice

The Device class extends the Device class implementing constructors and serialization functionality.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.microsoft.azure.sdk.iot.deps.twin.DeviceCapabilities	capabilities
protected DeviceStatus	status "Enabled", "Disabled".
protected String	statusReason A 128 char long string storing the reason of suspension.
protected String	statusUpdatedTime Datetime of last time the state was updated.

Fields inherited from class com.microsoft.azure.sdk.iot.service.BaseDevice

cloudToDeviceMessageCount, connectionState, connectionStateUpdatedTime, deviceId, eTag, generationId, lastActivityTime, OFFSET_TIME_DEFAULT, UTC_TIME_DEFAULT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Device(String deviceId, DeviceStatus status, SymmetricKey symmetricKey) Create an Device instance using the given device name

Method Summary

Modifier and Type	Method and Description
static Device	createDevice(String deviceId, AuthenticationType authenticationType) Static create function Creates device object using the given name that will use a Certificate Authority signed certificate for authentication.
static Device	createFromId(String deviceId, DeviceStatus status, SymmetricKey symmetricKey) Static create function Creates device object using the given name.
com.microsoft.azure.sdk.iot.deps.twin.DeviceCapabilities	getCapabilities() Getter for capabilities
DeviceStatus	getStatus() Getter for DeviceStatus object
String	getStatusReason() Getter for status reason
String	getStatusUpdatedTime() Getter for status updated time string
void	setCapabilities(com.microsoft.azure.sdk.iot.deps.twin.DeviceCapabilities capabilities) Setter for DeviceCapabilities object
void	setStatus(DeviceStatus status) Setter for DeviceStatus object

Methods inherited from class com.microsoft.azure.sdk.iot.service.BaseDevice

getAuthenticationType, getCloudToDeviceMessageCount, getConnectionState, getConnectionStateUpdatedTime, getDeviceId, geteTag, getGenerationId, getLastActivityTime, getPrimaryKey, getPrimaryThumbprint, getSecondaryKey, getSecondaryThumbprint, getSymmetricKey, setForceUpdate, setSymmetricKey, setThumbprint

Methods inherited from class java.lang.Object

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

Field Detail

status

protected DeviceStatus status

"Enabled", "Disabled". If "Enabled", this device is authorized to connect. If "Disabled" this device cannot receive or send messages, and statusReason must be set.

statusReason

protected String statusReason

A 128 char long string storing the reason of suspension. (all UTF-8 chars allowed).

statusUpdatedTime

protected String statusUpdatedTime

Datetime of last time the state was updated.

capabilities

protected com.microsoft.azure.sdk.iot.deps.twin.DeviceCapabilities capabilities

Constructor Detail

Device

protected Device(String deviceId,
                 DeviceStatus status,
                 SymmetricKey symmetricKey)
          throws IllegalArgumentException

Create an Device instance using the given device name

Parameters:

deviceId - Name of the device (used as device id)

status - - Device status. If parameter is null, then the status will be set to Enabled.

symmetricKey - - Device key. If parameter is null, then the key will be auto generated.

Throws:

IllegalArgumentException - This exception is thrown if the encryption method is not supported by the keyGenerator

Method Detail

createFromId

public static Device createFromId(String deviceId,
                                  DeviceStatus status,
                                  SymmetricKey symmetricKey)
                           throws IllegalArgumentException

Static create function Creates device object using the given name. If input device status and symmetric key are null then they will be auto generated.

Parameters:

deviceId - - String containing the device name

status - - Device status. If parameter is null, then the status will be set to Enabled.

symmetricKey - - Device key. If parameter is null, then the key will be auto generated.

Returns:

Device object

Throws:

IllegalArgumentException - This exception is thrown if deviceId is null or empty.

createDevice

public static Device createDevice(String deviceId,
                                  AuthenticationType authenticationType)

Static create function Creates device object using the given name that will use a Certificate Authority signed certificate for authentication. If input device status is null then it will be auto generated.

Parameters:

deviceId - - String containing the device name

authenticationType - - The type of authentication used by this device.

Returns:

Device object

Throws:

IllegalArgumentException - This exception is thrown if deviceId is null or empty.

getStatus

public DeviceStatus getStatus()

Getter for DeviceStatus object

Returns:

The deviceStatus object

setStatus

public void setStatus(DeviceStatus status)

Setter for DeviceStatus object

Parameters:

status - status to be set

getStatusReason

public String getStatusReason()

Getter for status reason

Returns:

The statusReason string

getStatusUpdatedTime

public String getStatusUpdatedTime()

Getter for status updated time string

Returns:

The string containing the time when the statusUpdated parameter was updated

getCapabilities

public com.microsoft.azure.sdk.iot.deps.twin.DeviceCapabilities getCapabilities()

Getter for capabilities

Returns:

The DeviceCapabilities containing capabilites that are enabled on the device

setCapabilities

public void setCapabilities(com.microsoft.azure.sdk.iot.deps.twin.DeviceCapabilities capabilities)

Setter for DeviceCapabilities object

Parameters:

capabilities - capabilities to be set