com.microsoft.azure.sdk.iot.device

Class DeviceClientConfig

java.lang.Object

com.microsoft.azure.sdk.iot.device.DeviceClientConfig

public final class DeviceClientConfig
extends Object

Configuration settings for an IoT Hub client. Validates all user-defined settings.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MESSAGE_LOCK_TIMEOUT_SECS The default value for messageLockTimeoutSecs.
static int	DEFAULT_READ_TIMEOUT_MILLIS The default value for readTimeoutMillis.
protected String	deviceId
protected String	deviceKey
protected String	iotHubHostname
protected String	iotHubName
protected MessageCallback	messageCallback The callback to be invoked if a message is received.
protected Object	messageContext The context to be passed in to the message callback.
protected String	pathToCertificate
protected String	sharedAccessToken

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DeviceClientConfig()
	DeviceClientConfig(String iotHubHostname, String deviceId, String deviceKey, String sharedAccessToken) Constructor.

Method Summary

Modifier and Type	Method and Description
String	getDeviceId() Getter for the device ID.
String	getDeviceKey() Getter for the device key.
String	getIotHubHostname() Getter for the IoT Hub hostname.
String	getIotHubName() Getter for the IoT Hub name.
MessageCallback	getMessageCallback() Getter for the message callback.
Object	getMessageContext() Getter for the context to be passed in to the message callback.
int	getMessageLockTimeoutSecs() Getter for the timeout, in seconds, for the lock that the client has on a received message.
String	getPathToCertificate() Getter for the path to the certificate.
int	getReadTimeoutMillis() Getter for the timeout, in milliseconds, after a connection is established for the server to respond to the request.
String	getSharedAccessToken() Getter for the shared access signature.
long	getTokenValidSecs() Getter for the number of seconds a SAS token should be valid for.
void	setMessageCallback(MessageCallback callback, Object context) Setter for the message callback.
void	setPathToCert(String pathToCertificate) Setter for the providing trusted certificate.
void	setTokenValidSecs(long expiryTime) Setter for the number of seconds a SAS token should be valid for.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_READ_TIMEOUT_MILLIS

public static final int DEFAULT_READ_TIMEOUT_MILLIS

The default value for readTimeoutMillis.

See Also:

Constant Field Values

DEFAULT_MESSAGE_LOCK_TIMEOUT_SECS

public static final int DEFAULT_MESSAGE_LOCK_TIMEOUT_SECS

The default value for messageLockTimeoutSecs.

See Also:

Constant Field Values

iotHubHostname

protected final String iotHubHostname

iotHubName

protected final String iotHubName

deviceId

protected final String deviceId

deviceKey

protected final String deviceKey

sharedAccessToken

protected final String sharedAccessToken

pathToCertificate

protected String pathToCertificate

messageCallback

protected MessageCallback messageCallback

The callback to be invoked if a message is received.

messageContext

protected Object messageContext

The context to be passed in to the message callback.

Constructor Detail

DeviceClientConfig

public DeviceClientConfig(String iotHubHostname,
                          String deviceId,
                          String deviceKey,
                          String sharedAccessToken)
                   throws URISyntaxException

Constructor.

Parameters:

iotHubHostname - the IoT Hub hostname.

deviceId - the device ID.

deviceKey - the device key.

sharedAccessToken - the shared access token.

Throws:

URISyntaxException - if the IoT Hub hostname does not conform to RFC 3986.

IllegalArgumentException - if the IoT Hub hostname does not contain a valid IoT Hub name as its prefix.

DeviceClientConfig

protected DeviceClientConfig()

Method Detail

setPathToCert

public void setPathToCert(String pathToCertificate)

Setter for the providing trusted certificate.

Parameters:

pathToCertificate - path to the certificate for one way authentication.

setMessageCallback

public void setMessageCallback(MessageCallback callback,
                               Object context)

Setter for the message callback. Can be null.

Parameters:

callback - the message callback. Can be null.

context - the context to be passed in to the callback.

getIotHubHostname

public String getIotHubHostname()

Getter for the IoT Hub hostname.

Returns:

the IoT Hub hostname.

getIotHubName

public String getIotHubName()

Getter for the IoT Hub name.

Returns:

the IoT Hub name.

getDeviceId

public String getDeviceId()

Getter for the device ID.

Returns:

the device ID.

getDeviceKey

public String getDeviceKey()

Getter for the device key.

Returns:

the device key.

getSharedAccessToken

public String getSharedAccessToken()

Getter for the shared access signature.

Returns:

the shared access signature.

getTokenValidSecs

public long getTokenValidSecs()

Getter for the number of seconds a SAS token should be valid for. A message that arrives at an IoT Hub in time of length greater than this value will be rejected by the IoT Hub.

Returns:

the number of seconds a message in transit to an IoT Hub is valid for.

setTokenValidSecs

public void setTokenValidSecs(long expiryTime)

Setter for the number of seconds a SAS token should be valid for. A message that arrives at an IoT Hub in time of length greater than this value will be rejected by the IoT Hub.

getReadTimeoutMillis

public int getReadTimeoutMillis()

Getter for the timeout, in milliseconds, after a connection is established for the server to respond to the request.

Returns:

the timeout, in milliseconds, after a connection is established for the server to respond to the request.

getMessageCallback

public MessageCallback getMessageCallback()

Getter for the message callback.

Returns:

the message callback.

getMessageContext

public Object getMessageContext()

Getter for the context to be passed in to the message callback.

Returns:

the message context.

getMessageLockTimeoutSecs

public int getMessageLockTimeoutSecs()

Getter for the timeout, in seconds, for the lock that the client has on a received message.

Returns:

the timeout, in seconds, for a received message lock.

getPathToCertificate

public String getPathToCertificate()

Getter for the path to the certificate.

Returns:

the path to certificate.