com.microsoft.azure.sdk.iot.service

Class Module

java.lang.Object

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

com.microsoft.azure.sdk.iot.service.Module

public class Module
extends BaseDevice

Field Summary

Fields

Modifier and Type	Field and Description
protected String	id Module name A case-sensitive string (up to 128 char long) of ASCII 7-bit alphanumeric chars + {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}.
protected String	managedBy Specifies the module's managed by owner

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	Module(String deviceId, String moduleId, SymmetricKey symmetricKey) Create an Module instance using the given module name

Method Summary

Modifier and Type	Method and Description
static Module	createFromId(String deviceId, String moduleId, SymmetricKey symmetricKey) Static create function Creates module object using the given name.
static Module	createModule(String deviceId, String moduleId, AuthenticationType authenticationType) Static create function Creates device object using the given name that will use a Certificate Authority signed certificate for authentication.
String	getId() Getter for module name
String	getManagedBy() Getter for module's managed by owner

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, setThumbprintFinal

Methods inherited from class java.lang.Object

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

Field Detail

id

protected String id

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

managedBy

protected String managedBy

Specifies the module's managed by owner

Constructor Detail

Module

protected Module(String deviceId,
                 String moduleId,
                 SymmetricKey symmetricKey)
          throws IllegalArgumentException

Create an Module instance using the given module name

Parameters:

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

moduleId - - ame of the module (used as module id)

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

Throws:

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

Method Detail

createFromId

public static Module createFromId(String deviceId,
                                  String moduleId,
                                  SymmetricKey symmetricKey)
                           throws IllegalArgumentException

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

Parameters:

deviceId - - String containing the device name

moduleId - - String containing the module name

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

Returns:

Module object

Throws:

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

createModule

public static Module createModule(String deviceId,
                                  String moduleId,
                                  AuthenticationType authenticationType)
                           throws IllegalArgumentException

Static create function Creates device object using the given name that will use a Certificate Authority signed certificate for authentication.

Parameters:

deviceId - - String containing the device name

moduleId - - String containing the module name

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

Returns:

Module object

Throws:

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

getId

public String getId()

Getter for module name

Returns:

The module string

getManagedBy

public String getManagedBy()

Getter for module's managed by owner

Returns:

The string containing the managed by owner