IotHubConnectionString (Iot Hub Java Service SDK 1.2.0 API)

java.lang.Object
- com.microsoft.azure.sdk.iot.service.IotHubConnectionStringBuilder
- - com.microsoft.azure.sdk.iot.service.IotHubConnectionString

```
public class IotHubConnectionString
extends IotHubConnectionStringBuilder
```
Expose all connections string properties and methods for user, device and connection string serialization.

Field Summary

Fields
Modifier and Type	Field and Description
`protected AuthenticationMethod`	`authenticationMethod`
`protected static String`	`HOST_NAME_PROPERTY_NAME`
`protected static String`	`HOST_NAME_SEPARATOR`
`protected String`	`hostName`
`protected String`	`iotHubName`
`protected static String`	`SHARED_ACCESS_KEY_NAME_PROPERTY_NAME`
`protected static String`	`SHARED_ACCESS_KEY_PROPERTY_NAME`
`protected static String`	`SHARED_ACCESS_SIGNATURE_PROPERTY_NAME`
`protected String`	`sharedAccessKey`
`protected String`	`sharedAccessKeyName`
`protected String`	`sharedAccessSignature`
`protected static String`	`VALUE_PAIR_DELIMITER`
`protected static String`	`VALUE_PAIR_SEPARATOR`

Constructor Summary

Constructors
Modifier Constructor and Description

protected IotHubConnectionString()

Constructors
Modifier	Constructor and Description
`protected`	`IotHubConnectionString()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AuthenticationMethod`	`getAuthenticationMethod()` Getter for authenticationMethod
`String`	`getHostName()` Getter for hostName
`String`	`getIotHubName()` Getter for iotHubName
`String`	`getSharedAccessKey()` Getter for sharedAccessKey
`String`	`getSharedAccessKeyName()` Getter for sharedAccessKeyName
`String`	`getSharedAccessSignature()` Getter for sharedAccessSignature
`URL`	`getUrlApplyConfigurationContent(String deviceId)` Create the url needed to apply some configuration content to a device
`URL`	`getUrlConfiguration(String configurationId)` Create url for requesting configuration data
`URL`	`getUrlConfigurationsList(Integer maxCount)` Create url for requesting configuration data
`URL`	`getUrlCreateExportImportJob()` Create url for processing a bulk import/export job
`URL`	`getUrlDevice(String deviceId)` Create url for requesting device data
`URL`	`getUrlDeviceList(Integer maxCount)` Create url for requesting device list
`URL`	`getUrlDeviceStatistics()` Create url for requesting device statistics
`URL`	`getUrlImportExportJob(String jobId)`
`URL`	`getUrlJobs(String jobId)` Create url for requesting jobs
`URL`	`getUrlJobsCancel(String jobId)` Create url for cancelling jobs
`URL`	`getUrlMethod(String deviceId)` Create url for requesting device method
`URL`	`getUrlModule(String deviceId, String moduleId)` Create url for requesting module data
`URL`	`getUrlModuleMethod(String deviceId, String moduleId)` Create url for requesting device method for module
`URL`	`getUrlModulesOnDevice(String deviceId)` Create url for requesting all modules data on a device
`URL`	`getUrlModuleTwin(String deviceId, String moduleId)` Create url for requesting module twin
`URL`	`getUrlQuery(String jobType, String jobStatus)` Create url for querying
`URL`	`getUrlTwin(String deviceId)` Create url for requesting device twin
`URL`	`getUrlTwinQuery()` Create url for querying twin
`String`	`getUserString()` Serialize user string
`protected void`	`setSharedAccessKey(String sharedAccessKey)` Setter for sharedAccessKey
`protected void`	`setSharedAccessKeyName(String sharedAccessKeyName)` Setter for sharedAccessKeyName
`protected void`	`setSharedAccessSignature(String sharedAccessSignature)` Setter for sharedAccessSignature
`String`	`toString()` Serialize connection string

Methods inherited from class com.microsoft.azure.sdk.iot.service.IotHubConnectionStringBuilder
createConnectionString, createConnectionString, parse, parseIotHubName, setAuthenticationMethod, setHostName, validate, validateFormat, validateFormatIfSpecified

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - VALUE_PAIR_DELIMITER
```
protected static final String VALUE_PAIR_DELIMITER
```
    See Also:
    
    Constant Field Values
  - VALUE_PAIR_SEPARATOR
```
protected static final String VALUE_PAIR_SEPARATOR
```
    See Also:
    
    Constant Field Values
  - HOST_NAME_SEPARATOR
```
protected static final String HOST_NAME_SEPARATOR
```
    See Also:
    
    Constant Field Values
  - HOST_NAME_PROPERTY_NAME
```
protected static final String HOST_NAME_PROPERTY_NAME
```
    See Also:
    
    Constant Field Values
  - SHARED_ACCESS_KEY_NAME_PROPERTY_NAME
```
protected static final String SHARED_ACCESS_KEY_NAME_PROPERTY_NAME
```
    See Also:
    
    Constant Field Values
  - SHARED_ACCESS_KEY_PROPERTY_NAME
```
protected static final String SHARED_ACCESS_KEY_PROPERTY_NAME
```
    See Also:
    
    Constant Field Values
  - SHARED_ACCESS_SIGNATURE_PROPERTY_NAME
```
protected static final String SHARED_ACCESS_SIGNATURE_PROPERTY_NAME
```
    See Also:
    
    Constant Field Values
  - hostName
```
protected String hostName
```
  - iotHubName
```
protected String iotHubName
```
  - authenticationMethod
```
protected AuthenticationMethod authenticationMethod
```
  - sharedAccessKeyName
```
protected String sharedAccessKeyName
```
  - sharedAccessKey
```
protected String sharedAccessKey
```
  - sharedAccessSignature
```
protected String sharedAccessSignature
```
- Constructor Detail
  - IotHubConnectionString
```
protected IotHubConnectionString()
```
- Method Detail
  - getUserString
```
public String getUserString()
```
    Serialize user string
    
    Returns:
    
    The user string in the following format: "SharedAccessKeyName@SAS.root.IotHubName"
  - getUrlMethod
```
public URL getUrlMethod(String deviceId)
                 throws MalformedURLException,
                        IllegalArgumentException
```
    Create url for requesting device method
    
    Parameters:
    
    deviceId - The name of the device
    
    Returns:
    
    The Url in the following format: "https:hostname/twins/deviceId/methods/"
    
    Throws:
    
    MalformedURLException - This exception is thrown if the URL creation failed due to malformed string
    
    IllegalArgumentException - This exception is thrown if device id is null or empty
  - getUrlModuleMethod
```
public URL getUrlModuleMethod(String deviceId,
                              String moduleId)
                       throws MalformedURLException,
                              IllegalArgumentException
```
    Create url for requesting device method for module
    
    Parameters:
    
    deviceId - The name of the device
    
    moduleId - The name of the module
    
    Returns:
    
    The Url in the following format: "https:hostname/twins/deviceId/methods/"
    
    Throws:
    
    MalformedURLException - This exception is thrown if the URL creation failed due to malformed string
    
    IllegalArgumentException - This exception is thrown if device id is null or empty
  - getUrlJobs
```
public URL getUrlJobs(String jobId)
               throws MalformedURLException,
                      IllegalArgumentException
```
    Create url for requesting jobs
    
    Parameters:
    
    jobId - is the name of the job
    
    Returns:
    
    the URL in the follow format: "https:[hostname]/jobs/v2/[jobId]?api-version=2016-11-14"
    
    Throws:
    
    MalformedURLException - This exception is thrown if the URL creation failed due to malformed string
    
    IllegalArgumentException - This exception is thrown if job id is null or empty
  - getUrlTwinQuery
```
public URL getUrlTwinQuery()
                    throws MalformedURLException
```
    Create url for querying twin
    
    Returns:
    
    the URL in the follow format: "https:[hostname]/devices/query?api-version=2016-11-14"
    
    Throws:
    
    MalformedURLException - This exception is thrown if the URL creation failed due to malformed string
  - getUrlQuery
```
public URL getUrlQuery(String jobType,
                       String jobStatus)
                throws MalformedURLException
```
    Create url for querying
    
    Parameters:
    
    jobStatus - jobStatus as String
    
    jobType - jobType as String
    
    Returns:
    
    the URL in the follow format: "https:[hostname]/jobs/v2/query?jobType=jobTypeValue&jobStatus=jobStatusValue&api-version=2016-11-14"
    
    Throws:
    
    MalformedURLException - This exception is thrown if the URL creation failed due to malformed string
  - getUrlJobsCancel
```
public URL getUrlJobsCancel(String jobId)
                     throws MalformedURLException,
                            IllegalArgumentException
```
    Create url for cancelling jobs
    
    Parameters:
    
    jobId - is the name of the job
    
    Returns:
    
    the URL in the follow format: "https:[hostname]/jobs/v2/[jobId]/cancel?api-version=2016-11-14"
    
    Throws:
    
    MalformedURLException - This exception is thrown if the URL creation failed due to malformed string
    
    IllegalArgumentException - This exception is thrown if job id is null or empty
  - getUrlTwin
```
public URL getUrlTwin(String deviceId)
               throws MalformedURLException,
                      IllegalArgumentException
```
    Create url for requesting device twin
    
    Parameters:
    
    deviceId - The name of the device
    
    Returns:
    
    The Url in the following format: "https:hostname/twins/deviceId?api-version=201X-XX-XX"
    
    Throws:
    
    MalformedURLException - This exception is thrown if the URL creation failed due to malformed string
    
    IllegalArgumentException - This exception is thrown if device id is null or empty
  - getUrlModuleTwin
```
public URL getUrlModuleTwin(String deviceId,
                            String moduleId)
                     throws MalformedURLException,
                            IllegalArgumentException
```
    Create url for requesting module twin
    
    Parameters:
    
    deviceId - The name of the device
    
    moduleId - The name of the device
    
    Returns:
    
    The Url in the following format: "https:hostname/twins/deviceId/modules/moduleId?api-version=201X-XX-XX"
    
    Throws:
    
    MalformedURLException - This exception is thrown if the URL creation failed due to malformed string
    
    IllegalArgumentException - This exception is thrown if device id is null or empty
  - getUrlDevice
```
public URL getUrlDevice(String deviceId)
                 throws MalformedURLException,
                        IllegalArgumentException
```
    Create url for requesting device data
    
    Parameters:
    
    deviceId - The name of the device
    
    Returns:
    
    The device Url in the following format: "https:hostname/devices/deviceId?api-version=201X-XX-XX"
    
    Throws:
    
    MalformedURLException - This exception is thrown if the URL creation failed due to malformed string
    
    IllegalArgumentException - This exception is thrown if device id is null or empty
  - getUrlModule
```
public URL getUrlModule(String deviceId,
                        String moduleId)
                 throws MalformedURLException,
                        IllegalArgumentException
```
    Create url for requesting module data
    
    Parameters:
    
    deviceId - The name of the device
    
    moduleId - The name of the device
    
    Returns:
    
    The device Url in the following format: "https:hostname/devices/deviceId/modules/moduleId?api-version=201X-XX-XX"
    
    Throws:
    
    MalformedURLException - This exception is thrown if the URL creation failed due to malformed string
    
    IllegalArgumentException - This exception is thrown if device id is null or empty
  - getUrlApplyConfigurationContent
```
public URL getUrlApplyConfigurationContent(String deviceId)
                                    throws MalformedURLException,
                                           IllegalArgumentException
```
    Create the url needed to apply some configuration content to a device
    
    Parameters:
    
    deviceId - The device to apply the configuration content to
    
    Returns:
    
    The device Url in the following format: "https:[hostname]/devices/[deviceId]/applyConfigurationContent?api-version=201X-XX-XX"
    
    Throws:
    
    MalformedURLException - if the deviceId contains unexpected characters, and a URL cannot be constructed using it
    
    IllegalArgumentException - if deviceId is null or empty
  - getUrlConfiguration
```
public URL getUrlConfiguration(String configurationId)
                        throws MalformedURLException,
                               IllegalArgumentException
```
    Create url for requesting configuration data
    
    Parameters:
    
    configurationId - The name of the configuration
    
    Returns:
    
    The device Url in the following format: "https:hostname/configurations/configurationId?api-version=201X-XX-XX"
    
    Throws:
    
    MalformedURLException - This exception is thrown if the URL creation failed due to malformed string
    
    IllegalArgumentException - This exception is thrown if device id is null or empty
  - getUrlConfigurationsList
```
public URL getUrlConfigurationsList(Integer maxCount)
                             throws MalformedURLException,
                                    IllegalArgumentException
```
    Create url for requesting configuration data
    
    Parameters:
    
    maxCount - The maximum number of configuration data to return
    
    Returns:
    
    The Url in the following format: "https:hostname/configurations/?top=maxcount&api-version=201X-XX-XX"
    
    Throws:
    
    MalformedURLException - This exception is thrown if the URL creation failed due to malformed string
    
    IllegalArgumentException - This exception is thrown if device id is null or empty
  - getUrlModulesOnDevice
```
public URL getUrlModulesOnDevice(String deviceId)
                          throws MalformedURLException,
                                 IllegalArgumentException
```
    Create url for requesting all modules data on a device
    
    Parameters:
    
    deviceId - The name of the device
    
    Returns:
    
    The device Url in the following format: "https:hostname/devices/deviceId?api-version=201X-XX-XX"
    
    Throws:
    
    MalformedURLException - This exception is thrown if the URL creation failed due to malformed string
    
    IllegalArgumentException - This exception is thrown if device id is null or empty
  - getUrlDeviceList
```
public URL getUrlDeviceList(Integer maxCount)
                     throws MalformedURLException,
                            IllegalArgumentException
```
    Create url for requesting device list
    
    Parameters:
    
    maxCount - The number of requested devices
    
    Returns:
    
    URL string to get the device list from IotHub
    
    Throws:
    
    MalformedURLException - This exception is thrown if the URL creation failed due to malformed string
    
    IllegalArgumentException - This exception is thrown if maxCount is null or empty
  - getUrlDeviceStatistics
```
public URL getUrlDeviceStatistics()
                           throws MalformedURLException
```
    Create url for requesting device statistics
    
    Returns:
    
    The device statistics Url in the following format: "https:hostname/statistics/devices?api-version=201X-XX-XX"
    
    Throws:
    
    MalformedURLException - This exception is thrown if the URL creation failed due to malformed string
  - getUrlCreateExportImportJob
```
public URL getUrlCreateExportImportJob()
                                throws MalformedURLException
```
    Create url for processing a bulk import/export job
    
    Returns:
    
    The import/export job URL in the following format: "https:hostname/jobs/create?api-version=201X-XX-XX"
    
    Throws:
    
    MalformedURLException - This exception is thrown if the URL creation failed due to malformed string
  - getUrlImportExportJob
```
public URL getUrlImportExportJob(String jobId)
                          throws MalformedURLException
```
    Parameters:
    
    jobId - Create url for retrieving a bulk import/export job
    
    Returns:
    
    The import/export job URL in the following format: "https:hostname/jobs/jobId?api-version=201X-XX-XX"
    
    Throws:
    
    MalformedURLException - This exception is thrown if the URL creation failed due to malformed string
  - toString
```
public String toString()
```
    Serialize connection string
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    Iot Hub connection string
  - getIotHubName
```
public String getIotHubName()
```
    Getter for iotHubName
    
    Returns:
    
    The iot hub name string
  - getAuthenticationMethod
```
public AuthenticationMethod getAuthenticationMethod()
```
    Getter for authenticationMethod
    
    Returns:
    
    The authenticationMethod object
  - getSharedAccessKeyName
```
public String getSharedAccessKeyName()
```
    Getter for sharedAccessKeyName
    
    Returns:
    
    The sharedAccessKeyName string
  - getSharedAccessKey
```
public String getSharedAccessKey()
```
    Getter for sharedAccessKey
    
    Returns:
    
    The sharedAccessKey string
  - getSharedAccessSignature
```
public String getSharedAccessSignature()
```
    Getter for sharedAccessSignature
    
    Returns:
    
    The sharedAccessSignature string
  - getHostName
```
public String getHostName()
```
    Getter for hostName
    
    Returns:
    
    The hostName string
  - setSharedAccessKeyName
```
protected void setSharedAccessKeyName(String sharedAccessKeyName)
```
    Setter for sharedAccessKeyName
    
    Parameters:
    
    sharedAccessKeyName - The value of the signature to set
  - setSharedAccessKey
```
protected void setSharedAccessKey(String sharedAccessKey)
```
    Setter for sharedAccessKey
    
    Parameters:
    
    sharedAccessKey - The value of the signature to set
  - setSharedAccessSignature
```
protected void setSharedAccessSignature(String sharedAccessSignature)
```
    Setter for sharedAccessSignature
    
    Parameters:
    
    sharedAccessSignature - The value of the signature to set

Class IotHubConnectionString

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.microsoft.azure.sdk.iot.service.IotHubConnectionStringBuilder

Methods inherited from class java.lang.Object

Field Detail

VALUE_PAIR_DELIMITER

VALUE_PAIR_SEPARATOR

HOST_NAME_SEPARATOR

HOST_NAME_PROPERTY_NAME

SHARED_ACCESS_KEY_NAME_PROPERTY_NAME

SHARED_ACCESS_KEY_PROPERTY_NAME

SHARED_ACCESS_SIGNATURE_PROPERTY_NAME

hostName

iotHubName

authenticationMethod

sharedAccessKeyName

sharedAccessKey

sharedAccessSignature

Constructor Detail

IotHubConnectionString

Method Detail

getUserString

getUrlMethod

getUrlModuleMethod

getUrlJobs

getUrlTwinQuery

getUrlQuery

getUrlJobsCancel

getUrlTwin

getUrlModuleTwin

getUrlDevice

getUrlModule

getUrlApplyConfigurationContent

getUrlConfiguration

getUrlConfigurationsList

getUrlModulesOnDevice

getUrlDeviceList

getUrlDeviceStatistics

getUrlCreateExportImportJob

getUrlImportExportJob

toString

getIotHubName

getAuthenticationMethod

getSharedAccessKeyName

getSharedAccessKey

getSharedAccessSignature

getHostName

setSharedAccessKeyName

setSharedAccessKey

setSharedAccessSignature