com.microsoft.azure.sdk.iot.device

Class IotHubConnectionString

java.lang.Object

com.microsoft.azure.sdk.iot.device.IotHubConnectionString

public class IotHubConnectionString
extends java.lang.Object

Parser for the Iothub connection string.

Constructor Summary

Constructors

Constructor and Description
IotHubConnectionString(java.lang.String connectionString) CONSTRUCTOR.
IotHubConnectionString(java.lang.String hostName, java.lang.String deviceId, java.lang.String sharedAccessKey, java.lang.String sharedAccessToken) Constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDeviceId() Getter for the deviceId.
java.lang.String	getGatewayHostName()
java.lang.String	getHostName() Getter for the hostName.
java.lang.String	getHubName() Getter for the hubName.
java.lang.String	getModuleId()
java.lang.String	getSharedAccessKey() Getter for the sharedAccessKey.
java.lang.String	getSharedAccessToken() Getter for the sharedAccessToken.
boolean	isUsingX509() Getter for UsingX509
void	setSharedAccessToken(java.lang.String sharedAccessToken) Setter for the shared access token

Methods inherited from class java.lang.Object

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

Constructor Detail

IotHubConnectionString

public IotHubConnectionString(java.lang.String connectionString)
                       throws java.lang.IllegalArgumentException

CONSTRUCTOR.

Parameters:

connectionString - is the iothub connection string to parse.

Throws:

java.lang.IllegalArgumentException - if the provided connectionString is null, empty, or not valid or if the hostName in the connection string is not a valid URI.

IotHubConnectionString

public IotHubConnectionString(java.lang.String hostName,
                              java.lang.String deviceId,
                              java.lang.String sharedAccessKey,
                              java.lang.String sharedAccessToken)
                       throws java.lang.IllegalArgumentException

Constructor.

Parameters:

hostName - the IoT Hub hostname.

deviceId - the device ID.

sharedAccessKey - the device key.

sharedAccessToken - the shared access token.

Throws:

java.lang.IllegalArgumentException - if the IoT Hub hostname does not contain a valid IoT Hub name as its prefix or if the IoT Hub hostname does not conform to RFC 3986.

Method Detail

getHostName

public java.lang.String getHostName()

Getter for the hostName.

Returns:

string with the hostName in the connectionString

getGatewayHostName

public java.lang.String getGatewayHostName()

getHubName

public java.lang.String getHubName()

Getter for the hubName.

Returns:

string with the hubName in the connectionString

getDeviceId

public java.lang.String getDeviceId()

Getter for the deviceId.

Returns:

string with the deviceId in the connectionString

getSharedAccessKey

public java.lang.String getSharedAccessKey()

Getter for the sharedAccessKey.

Returns:

string with the sharedAccessKey in the connectionString. It can be null.

getSharedAccessToken

public java.lang.String getSharedAccessToken()

Getter for the sharedAccessToken.

Returns:

string with the sharedAccessToken in the connectionString. It can be null.

getModuleId

public java.lang.String getModuleId()

isUsingX509

public boolean isUsingX509()

Getter for UsingX509

Returns:

The value of UsingX509

setSharedAccessToken

public void setSharedAccessToken(java.lang.String sharedAccessToken)
                          throws java.lang.IllegalArgumentException

Setter for the shared access token

Parameters:

sharedAccessToken - the new token value to set

Throws:

java.lang.IllegalArgumentException - if the provided value is null or empty