你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
IotHubConnectionString Class
- java.
lang. Object - com.
microsoft. azure. sdk. iot. service. IotHubConnectionStringBuilder - com.
microsoft. azure. sdk. iot. service. IotHubConnectionString
- com.
- com.
public class IotHubConnectionString
extends IotHubConnectionStringBuilder
Expose all connections string properties and methods for user, device and connection string serialization.
Field Summary
Modifier and Type | Field and Description |
---|---|
protected static final java.lang.String | HOST_NAME_PROPERTY_NAME |
protected static final java.lang.String | HOST_NAME_SEPARATOR |
protected static final java.lang.String | SHARED_ACCESS_KEY_NAME_PROPERTY_NAME |
protected static final java.lang.String | SHARED_ACCESS_KEY_PROPERTY_NAME |
protected static final java.lang.String | SHARED_ACCESS_SIGNATURE_PROPERTY_NAME |
protected static final java.lang.String | VALUE_PAIR_DELIMITER |
protected static final java.lang.String | VALUE_PAIR_SEPARATOR |
protected
Authentication |
authenticationMethod |
protected java.lang.String | hostName |
protected java.lang.String | iotHubName |
protected java.lang.String | sharedAccessKey |
protected java.lang.String | sharedAccessKeyName |
protected java.lang.String | sharedAccessSignature |
Constructor Summary
Modifier | Constructor | Description | |
---|---|---|---|
protected | IotHubConnectionString() |
Method Summary
Modifier and Type | Method and Description |
---|---|
Authentication |
getAuthenticationMethod()
Getter for authentication |
java.lang.String |
getHostName()
Getter for host |
java.lang.String |
getIotHubName()
Getter for iot |
java.lang.String |
getSharedAccessKey()
Getter for shared |
java.lang.String |
getSharedAccessKeyName()
Getter for shared |
java.lang.String |
getSharedAccessSignature()
Getter for shared |
java.net.URL |
getUrlApplyConfigurationContent(String deviceId)
Create the url needed to apply some configuration content to a device |
static java.net.URL |
getUrlApplyConfigurationContent(String hostName, String deviceId)
Create the url needed to apply some configuration content to a device |
java.net.URL |
getUrlConfiguration(String configurationId)
Create url for requesting configuration data |
static java.net.URL |
getUrlConfiguration(String hostName, String configurationId)
Create url for requesting configuration data |
java.net.URL |
getUrlConfigurationsList(Integer maxCount)
Create url for requesting configuration data |
static java.net.URL |
getUrlConfigurationsList(String hostName, Integer maxCount)
Create url for requesting configuration data |
java.net.URL |
getUrlCreateExportImportJob()
Create url for processing a bulk import/export job |
static java.net.URL |
getUrlCreateExportImportJob(String hostName)
Create url for processing a bulk import/export job |
java.net.URL |
getUrlDevice(String deviceId)
Create url for requesting device data |
static java.net.URL |
getUrlDevice(String hostName, String deviceId)
Create url for requesting device data |
java.net.URL |
getUrlDeviceList(Integer maxCount)
Create url for requesting device list |
static java.net.URL |
getUrlDeviceList(String hostName, Integer maxCount)
Create url for requesting device list |
java.net.URL |
getUrlDeviceStatistics()
Create url for requesting device statistics |
static java.net.URL |
getUrlDeviceStatistics(String hostName)
Create url for requesting device statistics |
java.net.URL | getUrlImportExportJob(String jobId) |
static java.net.URL | getUrlImportExportJob(String hostName, String jobId) |
java.net.URL |
getUrlJobs(String jobId)
Create url for requesting jobs |
static java.net.URL |
getUrlJobs(String hostName, String jobId)
Create url for requesting jobs |
java.net.URL |
getUrlJobsCancel(String jobId)
Create url for cancelling jobs |
static java.net.URL |
getUrlJobsCancel(String hostName, String jobId)
Create url for cancelling jobs |
java.net.URL |
getUrlMethod(String deviceId)
Create url for requesting device method |
static java.net.URL |
getUrlMethod(String hostName, String deviceId)
Create url for requesting device method |
java.net.URL |
getUrlModule(String deviceId, String moduleId)
Create url for requesting module data |
static java.net.URL |
getUrlModule(String hostName, String deviceId, String moduleId)
Create url for requesting module data |
java.net.URL |
getUrlModuleMethod(String deviceId, String moduleId)
Create url for requesting device method for module |
static java.net.URL |
getUrlModuleMethod(String hostName, String deviceId, String moduleId)
Create url for requesting device method for module |
java.net.URL |
getUrlModuleTwin(String deviceId, String moduleId)
Create url for requesting module twin |
static java.net.URL |
getUrlModuleTwin(String hostName, String deviceId, String moduleId)
Create url for requesting module twin |
java.net.URL |
getUrlModulesOnDevice(String deviceId)
Create url for requesting all modules data on a device |
static java.net.URL |
getUrlModulesOnDevice(String hostName, String deviceId)
Create url for requesting all modules data on a device |
java.net.URL |
getUrlQuery(String jobType, String jobStatus)
Create url for querying |
static java.net.URL |
getUrlQuery(String hostName, String jobType, String jobStatus)
Create url for querying |
java.net.URL |
getUrlTwin(String deviceId)
Create url for requesting device twin |
static java.net.URL |
getUrlTwin(String hostName, String deviceId)
Create url for requesting device twin |
java.net.URL |
getUrlTwinQuery()
Create url for querying twin |
static java.net.URL |
getUrlTwinQuery(String hostName)
Create url for querying twin |
java.lang.String |
getUserString()
Serialize user string |
protected void |
setSharedAccessKey(String sharedAccessKey)
Setter for shared |
protected void |
setSharedAccessKeyName(String sharedAccessKeyName)
Setter for shared |
protected void |
setSharedAccessSignature(String sharedAccessSignature)
Setter for shared |
java.lang.String |
toString()
Serialize connection string |
Methods inherited from IotHubConnectionStringBuilder
Methods inherited from java.lang.Object
Field Details
HOST_NAME_PROPERTY_NAME
protected static final String HOST_NAME_PROPERTY_NAME
HOST_NAME_SEPARATOR
protected static final String HOST_NAME_SEPARATOR
SHARED_ACCESS_KEY_NAME_PROPERTY_NAME
protected static final String SHARED_ACCESS_KEY_NAME_PROPERTY_NAME
SHARED_ACCESS_KEY_PROPERTY_NAME
protected static final String SHARED_ACCESS_KEY_PROPERTY_NAME
SHARED_ACCESS_SIGNATURE_PROPERTY_NAME
protected static final String SHARED_ACCESS_SIGNATURE_PROPERTY_NAME
VALUE_PAIR_DELIMITER
protected static final String VALUE_PAIR_DELIMITER
VALUE_PAIR_SEPARATOR
protected static final String VALUE_PAIR_SEPARATOR
authenticationMethod
protected AuthenticationMethod authenticationMethod
hostName
protected String hostName
iotHubName
protected String iotHubName
sharedAccessKey
protected String sharedAccessKey
sharedAccessKeyName
protected String sharedAccessKeyName
sharedAccessSignature
protected String sharedAccessSignature
Constructor Details
IotHubConnectionString
protected IotHubConnectionString()
Method Details
getAuthenticationMethod
public AuthenticationMethod getAuthenticationMethod()
Getter for authenticationMethod
Returns:
getHostName
public String getHostName()
Getter for hostName
Returns:
getIotHubName
public String getIotHubName()
Getter for iotHubName
Returns:
getSharedAccessKey
public String getSharedAccessKey()
Getter for sharedAccessKey
Returns:
getSharedAccessKeyName
public String getSharedAccessKeyName()
Getter for sharedAccessKeyName
Returns:
getSharedAccessSignature
public String getSharedAccessSignature()
Getter for sharedAccessSignature
Returns:
getUrlApplyConfigurationContent
public URL getUrlApplyConfigurationContent(String deviceId)
Create the url needed to apply some configuration content to a device
Parameters:
Returns:
Throws:
getUrlApplyConfigurationContent
public static URL getUrlApplyConfigurationContent(String hostName, String deviceId)
Create the url needed to apply some configuration content to a device
Parameters:
Returns:
Throws:
getUrlConfiguration
public URL getUrlConfiguration(String configurationId)
Create url for requesting configuration data
Parameters:
Returns:
Throws:
getUrlConfiguration
public static URL getUrlConfiguration(String hostName, String configurationId)
Create url for requesting configuration data
Parameters:
Returns:
Throws:
getUrlConfigurationsList
public URL getUrlConfigurationsList(Integer maxCount)
Create url for requesting configuration data
Parameters:
Returns:
Throws:
getUrlConfigurationsList
public static URL getUrlConfigurationsList(String hostName, Integer maxCount)
Create url for requesting configuration data
Parameters:
Returns:
Throws:
getUrlCreateExportImportJob
public URL getUrlCreateExportImportJob()
Create url for processing a bulk import/export job
Returns:
Throws:
getUrlCreateExportImportJob
public static URL getUrlCreateExportImportJob(String hostName)
Create url for processing a bulk import/export job
Parameters:
Returns:
Throws:
getUrlDevice
public URL getUrlDevice(String deviceId)
Create url for requesting device data
Parameters:
Returns:
Throws:
getUrlDevice
public static URL getUrlDevice(String hostName, String deviceId)
Create url for requesting device data
Parameters:
Returns:
Throws:
getUrlDeviceList
public URL getUrlDeviceList(Integer maxCount)
Create url for requesting device list
Parameters:
Returns:
Throws:
getUrlDeviceList
public static URL getUrlDeviceList(String hostName, Integer maxCount)
Create url for requesting device list
Parameters:
Returns:
Throws:
getUrlDeviceStatistics
public URL getUrlDeviceStatistics()
Create url for requesting device statistics
Returns:
Throws:
getUrlDeviceStatistics
public static URL getUrlDeviceStatistics(String hostName)
Create url for requesting device statistics
Parameters:
Returns:
Throws:
getUrlImportExportJob
public URL getUrlImportExportJob(String jobId)
Parameters:
Returns:
Throws:
getUrlImportExportJob
public static URL getUrlImportExportJob(String hostName, String jobId)
Parameters:
Returns:
Throws:
getUrlJobs
public URL getUrlJobs(String jobId)
Create url for requesting jobs
Parameters:
Returns:
Throws:
getUrlJobs
public static URL getUrlJobs(String hostName, String jobId)
Create url for requesting jobs
Parameters:
Returns:
Throws:
getUrlJobsCancel
public URL getUrlJobsCancel(String jobId)
Create url for cancelling jobs
Parameters:
Returns:
Throws:
getUrlJobsCancel
public static URL getUrlJobsCancel(String hostName, String jobId)
Create url for cancelling jobs
Parameters:
Returns:
Throws:
getUrlMethod
public URL getUrlMethod(String deviceId)
Create url for requesting device method
Parameters:
Returns:
Throws:
getUrlMethod
public static URL getUrlMethod(String hostName, String deviceId)
Create url for requesting device method
Parameters:
Returns:
Throws:
getUrlModule
public URL getUrlModule(String deviceId, String moduleId)
Create url for requesting module data
Parameters:
Returns:
Throws:
getUrlModule
public static URL getUrlModule(String hostName, String deviceId, String moduleId)
Create url for requesting module data
Parameters:
Returns:
Throws:
getUrlModuleMethod
public URL getUrlModuleMethod(String deviceId, String moduleId)
Create url for requesting device method for module
Parameters:
Returns:
Throws:
getUrlModuleMethod
public static URL getUrlModuleMethod(String hostName, String deviceId, String moduleId)
Create url for requesting device method for module
Parameters:
Returns:
Throws:
getUrlModuleTwin
public URL getUrlModuleTwin(String deviceId, String moduleId)
Create url for requesting module twin
Parameters:
Returns:
Throws:
getUrlModuleTwin
public static URL getUrlModuleTwin(String hostName, String deviceId, String moduleId)
Create url for requesting module twin
Parameters:
Returns:
Throws:
getUrlModulesOnDevice
public URL getUrlModulesOnDevice(String deviceId)
Create url for requesting all modules data on a device
Parameters:
Returns:
Throws:
getUrlModulesOnDevice
public static URL getUrlModulesOnDevice(String hostName, String deviceId)
Create url for requesting all modules data on a device
Parameters:
Returns:
Throws:
getUrlQuery
public URL getUrlQuery(String jobType, String jobStatus)
Create url for querying
Parameters:
Returns:
Throws:
getUrlQuery
public static URL getUrlQuery(String hostName, String jobType, String jobStatus)
Create url for querying
Parameters:
Returns:
Throws:
getUrlTwin
public URL getUrlTwin(String deviceId)
Create url for requesting device twin
Parameters:
Returns:
Throws:
getUrlTwin
public static URL getUrlTwin(String hostName, String deviceId)
Create url for requesting device twin
Parameters:
Returns:
Throws:
getUrlTwinQuery
public URL getUrlTwinQuery()
Create url for querying twin
Returns:
Throws:
getUrlTwinQuery
public static URL getUrlTwinQuery(String hostName)
Create url for querying twin
Parameters:
Returns:
Throws:
getUserString
public String getUserString()
Serialize user string
Returns:
setSharedAccessKey
protected void setSharedAccessKey(String sharedAccessKey)
Setter for sharedAccessKey
Parameters:
setSharedAccessKeyName
protected void setSharedAccessKeyName(String sharedAccessKeyName)
Setter for sharedAccessKeyName
Parameters:
setSharedAccessSignature
protected void setSharedAccessSignature(String sharedAccessSignature)
Setter for sharedAccessSignature
Parameters:
toString
public String toString()
Serialize connection string
Overrides:
IotHubConnectionString.toString()Returns: