com.microsoft.azure.sdk.iot.device

Class ClientConfiguration

java.lang.Object

com.microsoft.azure.sdk.iot.device.ClientConfiguration

public final class ClientConfiguration
extends java.lang.Object

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClientConfiguration.AuthType

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_AMQP_OPEN_AUTHENTICATION_SESSION_TIMEOUT_IN_SECONDS
static int	DEFAULT_AMQP_OPEN_DEVICE_SESSIONS_TIMEOUT_IN_SECONDS
static int	DEFAULT_KEEP_ALIVE_INTERVAL_IN_SECONDS
static int	DEFAULT_SEND_INTERVAL_IN_MILLISECONDS
static int	DEFAULT_SEND_INTERVAL_IN_SECONDS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ClientConfiguration()

Method Summary

Modifier and Type	Method and Description
IotHubAuthenticationProvider	getAuthenticationProvider()
ClientConfiguration.AuthType	getAuthenticationType() Getter for AuthenticationType
java.lang.String	getDeviceClientUniqueIdentifier()
java.lang.String	getDeviceId() Getter for the device ID.
MessageCallback	getDeviceTelemetryMessageCallback(java.lang.String inputName) Getter for the message callback.
java.lang.Object	getDeviceTelemetryMessageContext(java.lang.String inputName) Getter for the context to be passed in to the message callback.
MessageCallback	getDeviceTwinMessageCallback() Getter for the device twin message callback.
java.lang.Object	getDeviceTwinMessageContext() Getter for the context to be passed in to the device twin message callback.
MessageCallback	getDirectMethodsMessageCallback() Getter for the device twin message callback.
java.lang.Object	getDirectMethodsMessageContext() Getter for the context to be passed in to the device twin message callback.
java.lang.String	getGatewayHostname() Getter for the Gateway host name.
java.lang.String	getIotHubHostname() Getter for the IoT Hub hostname.
java.lang.String	getIotHubName() Getter for the IoT Hub name.
int	getMessageLockTimeoutSecs() Getter for the timeout, in seconds, for the lock that the client has on a received message.
java.lang.String	getModuleId()
IotHubSasTokenAuthenticationProvider	getSasTokenAuthentication() Getter for SasTokenAuthentication
boolean	isUsingIdentifiableThreadNames()
boolean	isUsingWebsocket() Getter for Websocket
void	setDeviceTwinMessageCallback(MessageCallback callback, java.lang.Object context) Setter for the device twin message callback.
void	setDirectMethodsMessageCallback(MessageCallback callback, java.lang.Object context) Setter for the device method message callback.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_KEEP_ALIVE_INTERVAL_IN_SECONDS

public static final int DEFAULT_KEEP_ALIVE_INTERVAL_IN_SECONDS

See Also:

Constant Field Values

DEFAULT_SEND_INTERVAL_IN_SECONDS

public static final int DEFAULT_SEND_INTERVAL_IN_SECONDS

See Also:

Constant Field Values

DEFAULT_AMQP_OPEN_AUTHENTICATION_SESSION_TIMEOUT_IN_SECONDS

public static final int DEFAULT_AMQP_OPEN_AUTHENTICATION_SESSION_TIMEOUT_IN_SECONDS

See Also:

Constant Field Values

DEFAULT_AMQP_OPEN_DEVICE_SESSIONS_TIMEOUT_IN_SECONDS

public static final int DEFAULT_AMQP_OPEN_DEVICE_SESSIONS_TIMEOUT_IN_SECONDS

See Also:

Constant Field Values

DEFAULT_SEND_INTERVAL_IN_MILLISECONDS

public static final int DEFAULT_SEND_INTERVAL_IN_MILLISECONDS

See Also:

Constant Field Values

Constructor Detail

ClientConfiguration

protected ClientConfiguration()

Method Detail

getSasTokenAuthentication

public IotHubSasTokenAuthenticationProvider getSasTokenAuthentication()

Getter for SasTokenAuthentication

Returns:

The value of SasTokenAuthentication, or null if this object isn't using sas token authentication

getAuthenticationProvider

public IotHubAuthenticationProvider getAuthenticationProvider()

isUsingWebsocket

public boolean isUsingWebsocket()

Getter for Websocket

Returns:

true if set, false otherwise

getIotHubHostname

public java.lang.String getIotHubHostname()

Getter for the IoT Hub hostname.

Returns:

the IoT Hub hostname.

getIotHubName

public java.lang.String getIotHubName()

Getter for the IoT Hub name.

Returns:

the IoT Hub name.

getGatewayHostname

public java.lang.String getGatewayHostname()

Getter for the Gateway host name.

Returns:

the name of the gateway host

getDeviceId

public java.lang.String getDeviceId()

Getter for the device ID.

Returns:

the device ID.

getModuleId

public java.lang.String getModuleId()

getDeviceClientUniqueIdentifier

public java.lang.String getDeviceClientUniqueIdentifier()

getDeviceTelemetryMessageCallback

public MessageCallback getDeviceTelemetryMessageCallback(java.lang.String inputName)

Getter for the message callback.

Parameters:

inputName - the inputName that the desired callback is tied to, or null for the default callback

Returns:

the message callback.

getDeviceTelemetryMessageContext

public java.lang.Object getDeviceTelemetryMessageContext(java.lang.String inputName)

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

Parameters:

inputName - the inputName that the desired callback context is tied to, or null for the default callback context

Returns:

the message context.

setDirectMethodsMessageCallback

public void setDirectMethodsMessageCallback(MessageCallback callback,
                                            java.lang.Object context)

Setter for the device method message callback.

Parameters:

callback - Callback for device method messages.

context - is the context for the callback.

getDirectMethodsMessageCallback

public MessageCallback getDirectMethodsMessageCallback()

Getter for the device twin message callback.

Returns:

the device method message callback.

getDirectMethodsMessageContext

public java.lang.Object getDirectMethodsMessageContext()

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

Returns:

the device method message context.

setDeviceTwinMessageCallback

public void setDeviceTwinMessageCallback(MessageCallback callback,
                                         java.lang.Object context)

Setter for the device twin message callback.

Parameters:

callback - callback to be invoked for device twin messages.

context - is the context for the callback.

getDeviceTwinMessageCallback

public MessageCallback getDeviceTwinMessageCallback()

Getter for the device twin message callback.

Returns:

the device twin message callback.

getDeviceTwinMessageContext

public java.lang.Object getDeviceTwinMessageContext()

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

Returns:

the device twin 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.

getAuthenticationType

public ClientConfiguration.AuthType getAuthenticationType()

Getter for AuthenticationType

Returns:

The value of AuthenticationType

isUsingIdentifiableThreadNames

public boolean isUsingIdentifiableThreadNames()