com.microsoft.azure.sdk.iot.service

Class BaseDevice

java.lang.Object

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

Direct Known Subclasses:

Device, Module

public class BaseDevice
extends Object

The BaseDevice class implementing constructors and serialization functionality.

Field Summary

Fields

Modifier and Type	Field and Description
protected long	cloudToDeviceMessageCount Number of messages received by the device
protected DeviceConnectionState	connectionState Status of the device: {"connected" | "disconnected"}
protected String	connectionStateUpdatedTime Datetime of last time the connection state was updated.
protected String	deviceId Device name A case-sensitive string (up to 128 char long) of ASCII 7-bit alphanumeric chars + {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}.
protected String	eTag A string representing a weak ETAG version of this JSON description.
protected String	generationId Device generation Id
protected String	lastActivityTime Datetime of last time the device authenticated, received, or sent a message.
protected String	OFFSET_TIME_DEFAULT
protected String	UTC_TIME_DEFAULT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseDevice(String deviceId, AuthenticationType authenticationType) Create an BaseDevice instance using the given device name with the given authenticationType
protected	BaseDevice(String deviceId, SymmetricKey symmetricKey) Create an BaseDevice instance using the given device name

Method Summary

Modifier and Type	Method and Description
AuthenticationType	getAuthenticationType() Getter for the authentication type of this device
long	getCloudToDeviceMessageCount() Getter for cloud to device message count
DeviceConnectionState	getConnectionState() Getter for connection state
String	getConnectionStateUpdatedTime() Getter for connection state updated time
String	getDeviceId() Getter for device name
String	geteTag() Getter for eTag
String	getGenerationId() Getter for GenerationId
String	getLastActivityTime() Getter for last activity time
String	getPrimaryKey() Getter for PrimaryKey part of the SymmetricKey
String	getPrimaryThumbprint() Getter for primary thumbprint part of the whole thumbprint
String	getSecondaryKey() Getter for SecondaryKey part of the SymmetricKey
String	getSecondaryThumbprint() Getter for secondary thumbprint part of the whole thumbprint
SymmetricKey	getSymmetricKey() Getter for SymmetricKey object
void	setForceUpdate(Boolean forceUpdate) Deprecated. This method currently only validates forceUpdate parameter
void	setSymmetricKey(SymmetricKey symmetricKey) Setter for SymmetricKey object
void	setThumbprint(String primaryThumbprint, String secondaryThumbprint) Deprecated. as of service-client version 1.15.1, please use setThumbprintFinal(String, String)
void	setThumbprintFinal(String primaryThumbprint, String secondaryThumbprint) Setter for X509 thumbprint

Methods inherited from class java.lang.Object

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

Field Detail

UTC_TIME_DEFAULT

protected final String UTC_TIME_DEFAULT

See Also:

Constant Field Values

OFFSET_TIME_DEFAULT

protected final String OFFSET_TIME_DEFAULT

See Also:

Constant Field Values

deviceId

protected String deviceId

Device name A case-sensitive string (up to 128 char long) of ASCII 7-bit alphanumeric chars + {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}.

generationId

protected String generationId

Device generation Id

eTag

protected String eTag

A string representing a weak ETAG version of this JSON description. This is a hash.

connectionState

protected DeviceConnectionState connectionState

Status of the device: {"connected" | "disconnected"}

connectionStateUpdatedTime

protected String connectionStateUpdatedTime

Datetime of last time the connection state was updated.

lastActivityTime

protected String lastActivityTime

Datetime of last time the device authenticated, received, or sent a message.

cloudToDeviceMessageCount

protected long cloudToDeviceMessageCount

Number of messages received by the device

Constructor Detail

BaseDevice

protected BaseDevice(String deviceId,
                     SymmetricKey symmetricKey)
              throws IllegalArgumentException

Create an BaseDevice instance using the given device name

Parameters:

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

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

Throws:

IllegalArgumentException - if deviceId is null

BaseDevice

protected BaseDevice(String deviceId,
                     AuthenticationType authenticationType)

Create an BaseDevice instance using the given device name with the given authenticationType

Parameters:

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

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

Method Detail

getDeviceId

public String getDeviceId()

Getter for device name

Returns:

The deviceId string

getGenerationId

public String getGenerationId()

Getter for GenerationId

Returns:

The generationId string

getSymmetricKey

public SymmetricKey getSymmetricKey()

Getter for SymmetricKey object

Returns:

The symmetricKey object

setSymmetricKey

public void setSymmetricKey(SymmetricKey symmetricKey)
                     throws IllegalArgumentException

Setter for SymmetricKey object

Parameters:

symmetricKey - symmetricKey to be set

Throws:

IllegalArgumentException - if the provided symmetric key is null

getPrimaryKey

public String getPrimaryKey()

Getter for PrimaryKey part of the SymmetricKey

Returns:

The primaryKey string

getSecondaryKey

public String getSecondaryKey()

Getter for SecondaryKey part of the SymmetricKey

Returns:

The secondaryKey string

setThumbprint

@Deprecated
public void setThumbprint(String primaryThumbprint,
                                       String secondaryThumbprint)

Deprecated. as of service-client version 1.15.1, please use setThumbprintFinal(String, String)

Setter for X509 thumbprint

Parameters:

primaryThumbprint - the primary thumbprint to set

secondaryThumbprint - the secondary thumbprint to set

Throws:

IllegalArgumentException - if primaryThumbprint or secondaryThumbprint is null or empty

setThumbprintFinal

public final void setThumbprintFinal(String primaryThumbprint,
                                     String secondaryThumbprint)

Setter for X509 thumbprint

Parameters:

primaryThumbprint - the primary thumbprint to set

secondaryThumbprint - the secondary thumbprint to set

Throws:

IllegalArgumentException - if primaryThumbprint or secondaryThumbprint is null or empty

getPrimaryThumbprint

public String getPrimaryThumbprint()

Getter for primary thumbprint part of the whole thumbprint

Returns:

The primary thumbprint string

getSecondaryThumbprint

public String getSecondaryThumbprint()

Getter for secondary thumbprint part of the whole thumbprint

Returns:

The secondary thumbprint string

geteTag

public String geteTag()

Getter for eTag

Returns:

The eTag string

getConnectionState

public DeviceConnectionState getConnectionState()

Getter for connection state

Returns:

The connectionState string

getConnectionStateUpdatedTime

public String getConnectionStateUpdatedTime()

Getter for connection state updated time

Returns:

The string containing the time when the connectionState parameter was updated

getLastActivityTime

public String getLastActivityTime()

Getter for last activity time

Returns:

The string containing the time when the lastActivity parameter was updated

getCloudToDeviceMessageCount

public long getCloudToDeviceMessageCount()

Getter for cloud to device message count

Returns:

The string containing the time when the cloudToDeviceMessageCount parameter was updated

setForceUpdate

@Deprecated
public void setForceUpdate(Boolean forceUpdate)
                                 throws IllegalArgumentException

Deprecated. This method currently only validates forceUpdate parameter

Setter for force update boolean

Parameters:

forceUpdate - - Boolean controlling if the update should be forced or not

Throws:

IllegalArgumentException - if the provided argument is null

getAuthenticationType

public AuthenticationType getAuthenticationType()

Getter for the authentication type of this device

Returns:

the authentication type