com.microsoft.azure.sdk.iot.service.IotHubConnectionString Maven / Gradle / Ivy
/*
* Copyright (c) Microsoft. All rights reserved.
* Licensed under the MIT license. See LICENSE file in the project root for full license information.
*/
package com.microsoft.azure.sdk.iot.service;
import java.net.MalformedURLException;
import java.net.URL;
/**
* Expose all connections string properties and methods
* for user, device and connection string serialization.
*/
public class IotHubConnectionString extends IotHubConnectionStringBuilder
{
protected static final String VALUE_PAIR_DELIMITER = ";";
protected static final String VALUE_PAIR_SEPARATOR = "=";
protected static final String HOST_NAME_SEPARATOR = ".";
protected static final String HOST_NAME_PROPERTY_NAME = "HostName";
protected static final String SHARED_ACCESS_KEY_NAME_PROPERTY_NAME = "SharedAccessKeyName";
protected static final String SHARED_ACCESS_KEY_PROPERTY_NAME = "SharedAccessKey";
protected static final String SHARED_ACCESS_SIGNATURE_PROPERTY_NAME = "SharedAccessSignature";
// Included in the device connection string
protected String hostName;
protected String iotHubName;
protected AuthenticationMethod authenticationMethod;
protected String sharedAccessKeyName;
protected String sharedAccessKey;
protected String sharedAccessSignature;
// Connection
private static final String URL_SEPARATOR_0 = "/";
private static final String URL_SEPARATOR_1 = "?";
private static final String URL_SEPARATOR_2 = "&";
private static final String URL_HTTPS = "https:" + URL_SEPARATOR_0 + URL_SEPARATOR_0;
private static final String URL_PATH_DEVICES = "devices";
private static final String URL_PATH_MODULES = "modules";
private static final String URL_PATH_CONFIG = "configurations";
private static final String URL_API_VERSION = "api-version=2019-03-30";
private static final String URL_MAX_COUNT = "top=";
private static final String URL_PATH_DEVICESTATISTICS = "statistics";
private static final String USER_SEPARATOR = "@";
private static final String USER_SAS = "SAS.";
private static final String USER_ROOT = "root.";
// twin
private static final String URL_PATH_TWIN = "twins";
private static final String URL_PATH_PROPERTIES = "properties";
private static final String URL_PATH_METHODS = "methods";
private static final String URL_PATH_TWIN_DEVICES = "devices";
// jobs
private static final String URL_PATH_JOBS = "jobs";
private static final String URL_PATH_VERSION = "v2";
private static final String URL_PATH_QUERY = "query";
private static final String URL_PATH_JOB_TYPE = "jobType";
private static final String URL_PATH_JOB_STATUS = "jobStatus";
private static final String URL_PATH_CANCEL = "cancel";
// configurations
private static final String URL_PATH_APPLY_CONTENT_CONFIGURATION = "applyConfigurationContent";
protected IotHubConnectionString() {}
/**
* Serialize user string
*
* @return The user string in the following format: "[email protected]"
*/
public String getUserString()
{
// Codes_SRS_SERVICE_SDK_JAVA_IOTHUBCONNECTIONSTRING_12_001: [The function shall serialize the object
// properties to a string using the following format: [email protected]]
StringBuilder stringBuilder = new StringBuilder();
stringBuilder.append(this.sharedAccessKeyName);
stringBuilder.append(USER_SEPARATOR);
stringBuilder.append(USER_SAS);
stringBuilder.append(USER_ROOT);
stringBuilder.append(this.iotHubName);
return stringBuilder.toString();
}
/**
* Create url for requesting device method
*
* @param deviceId The name of the device
* @return 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
* @throws IllegalArgumentException This exception is thrown if device id is null or empty
*/
public URL getUrlMethod(String deviceId) throws MalformedURLException, IllegalArgumentException
{
// Codes_SRS_SERVICE_SDK_JAVA_IOTHUBCONNECTIONSTRING_21_016: [** The function shall throw IllegalArgumentException if the input string is empty or null **]**
if (Tools.isNullOrEmpty(deviceId))
{
throw new IllegalArgumentException("device name cannot be empty or null");
}
//Codes_SRS_SERVICE_SDK_JAVA_IOTHUBCONNECTIONSTRING_21_017: [** The function shall create a URL object from the given deviceId using the following format: https:hostname/twins/deviceId/methods/ **]**
StringBuilder stringBuilder = new StringBuilder();
stringBuilder.append(URL_HTTPS);
stringBuilder.append(hostName);
stringBuilder.append(URL_SEPARATOR_0);
stringBuilder.append(URL_PATH_TWIN);
stringBuilder.append(URL_SEPARATOR_0);
stringBuilder.append(deviceId);
stringBuilder.append(URL_SEPARATOR_0);
stringBuilder.append(URL_PATH_METHODS);
stringBuilder.append(URL_SEPARATOR_1);
stringBuilder.append(URL_API_VERSION);
return new URL(stringBuilder.toString());
}
/**
* Create url for requesting device method for module
*
* @param deviceId The name of the device
* @param moduleId The name of the module
* @return 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
* @throws IllegalArgumentException This exception is thrown if device id is null or empty
*/
public URL getUrlModuleMethod(String deviceId, String moduleId) throws MalformedURLException, IllegalArgumentException
{
// Codes_SRS_SERVICE_SDK_JAVA_IOTHUBCONNECTIONSTRING_28_: [** The function shall throw IllegalArgumentException if the deviceId string is empty or null **]**
if (Tools.isNullOrEmpty(deviceId))
{
throw new IllegalArgumentException("device name cannot be empty or null");
}
// Codes_SRS_SERVICE_SDK_JAVA_IOTHUBCONNECTIONSTRING_28_: [** The function shall throw IllegalArgumentException if the moduleId string is empty or null **]**
if (Tools.isNullOrEmpty(moduleId))
{
throw new IllegalArgumentException("module name cannot be empty or null");
}
//Codes_SRS_SERVICE_SDK_JAVA_IOTHUBCONNECTIONSTRING_21_017: [** The function shall create a URL object from the
//given deviceId using the following format: https:hostname/twins/deviceId/modules/moduleId/methods/ **]**
StringBuilder stringBuilder = new StringBuilder();
stringBuilder.append(URL_HTTPS);
stringBuilder.append(hostName);
stringBuilder.append(URL_SEPARATOR_0);
stringBuilder.append(URL_PATH_TWIN);
stringBuilder.append(URL_SEPARATOR_0);
stringBuilder.append(deviceId);
stringBuilder.append(URL_SEPARATOR_0);
stringBuilder.append(URL_PATH_MODULES);
stringBuilder.append(URL_SEPARATOR_0);
stringBuilder.append(moduleId);
stringBuilder.append(URL_SEPARATOR_0);
stringBuilder.append(URL_PATH_METHODS);
stringBuilder.append(URL_SEPARATOR_1);
stringBuilder.append(URL_API_VERSION);
return new URL(stringBuilder.toString());
}
/**
* Create url for requesting jobs
*
* @param jobId is the name of the job
* @return 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
* @throws IllegalArgumentException This exception is thrown if job id is null or empty
*/
public URL getUrlJobs(String jobId) throws MalformedURLException, IllegalArgumentException
{
// Codes_SRS_SERVICE_SDK_JAVA_IOTHUBCONNECTIONSTRING_21_018: [** The function shall throw IllegalArgumentException if the input string is empty or null **]**
if (Tools.isNullOrEmpty(jobId))
{
throw new IllegalArgumentException("job name cannot be empty or null");
}
// Codes_SRS_SERVICE_SDK_JAVA_IOTHUBCONNECTIONSTRING_21_019: [** The function shall create a URL object from the given jobId using the following format: `https:hostname/jobs/v2/jobId?api-version=2016-11-14` **]**
StringBuilder stringBuilder = new StringBuilder();
stringBuilder.append(URL_HTTPS);
stringBuilder.append(hostName);
stringBuilder.append(URL_SEPARATOR_0);
stringBuilder.append(URL_PATH_JOBS);
stringBuilder.append(URL_SEPARATOR_0);
stringBuilder.append(URL_PATH_VERSION);
stringBuilder.append(URL_SEPARATOR_0);
stringBuilder.append(jobId);
stringBuilder.append(URL_SEPARATOR_1);
stringBuilder.append(URL_API_VERSION);
return new URL(stringBuilder.toString());
}
/**
* Create url for querying twin
*
* @return 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
*/
public URL getUrlTwinQuery() throws MalformedURLException
{
//Codes_SRS_SERVICE_SDK_JAVA_IOTHUBCONNECTIONSTRING_25_023: [ The function shall create a URL object from the given jobId using the following format: https:[hostname]/devices/query?api-version=2016-11-14 ]
StringBuilder stringBuilder = new StringBuilder();
stringBuilder.append(URL_HTTPS);
stringBuilder.append(hostName);
stringBuilder.append(URL_SEPARATOR_0);
stringBuilder.append(URL_PATH_TWIN_DEVICES);
stringBuilder.append(URL_SEPARATOR_0);
stringBuilder.append(URL_PATH_QUERY);
stringBuilder.append(URL_SEPARATOR_1);
stringBuilder.append(URL_API_VERSION);
return new URL(stringBuilder.toString());
}
/**
* Create url for querying
* @param jobStatus jobStatus as String
* @param jobType jobType as String
* @return 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
*/
public URL getUrlQuery(String jobType, String jobStatus) throws MalformedURLException
{
// Codes_SRS_SERVICE_SDK_JAVA_IOTHUBCONNECTIONSTRING_21_022: [** The function shall create a URL object from the given jobId using the following format: `https:hostname/jobs/v2/query?jobType=<>&jobStatus=<>&api-version=2016-11-14` **]**
StringBuilder stringBuilder = new StringBuilder();
stringBuilder.append(URL_HTTPS);
stringBuilder.append(hostName);
stringBuilder.append(URL_SEPARATOR_0);
stringBuilder.append(URL_PATH_JOBS);
stringBuilder.append(URL_SEPARATOR_0);
stringBuilder.append(URL_PATH_VERSION);
stringBuilder.append(URL_SEPARATOR_0);
stringBuilder.append(URL_PATH_QUERY);
stringBuilder.append(URL_SEPARATOR_1);
// Codes_SRS_SERVICE_SDK_JAVA_IOTHUBCONNECTIONSTRING_21_024: [** If the jobType is null or empty, the function shall not include the jobType in the URL **]**
if(!Tools.isNullOrEmpty(jobType))
{
stringBuilder.append(URL_PATH_JOB_TYPE);
stringBuilder.append(VALUE_PAIR_SEPARATOR);
stringBuilder.append(jobType);
stringBuilder.append(URL_SEPARATOR_2);
}
// Codes_SRS_SERVICE_SDK_JAVA_IOTHUBCONNECTIONSTRING_21_025: [** If the jobStatus is null or empty, the function shall not include the jobStatus in the URL **]**
if(!Tools.isNullOrEmpty(jobStatus))
{
stringBuilder.append(URL_PATH_JOB_STATUS);
stringBuilder.append(VALUE_PAIR_SEPARATOR);
stringBuilder.append(jobStatus);
stringBuilder.append(URL_SEPARATOR_2);
}
stringBuilder.append(URL_API_VERSION);
return new URL(stringBuilder.toString());
}
/**
* Create url for cancelling jobs
*
* @param jobId is the name of the job
* @return 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
* @throws IllegalArgumentException This exception is thrown if job id is null or empty
*/
public URL getUrlJobsCancel(String jobId) throws MalformedURLException, IllegalArgumentException
{
// Codes_SRS_SERVICE_SDK_JAVA_IOTHUBCONNECTIONSTRING_21_020: [** The function shall throw IllegalArgumentException if the input string is empty or null **]**
if (Tools.isNullOrEmpty(jobId))
{
throw new IllegalArgumentException("job name cannot be empty or null");
}
// Codes_SRS_SERVICE_SDK_JAVA_IOTHUBCONNECTIONSTRING_21_021: [** The function shall create a URL object from the given jobId using the following format: `https:hostname/jobs/v2/jobId/cancel?api-version=2016-11-14` **]**
StringBuilder stringBuilder = new StringBuilder();
stringBuilder.append(URL_HTTPS);
stringBuilder.append(hostName);
stringBuilder.append(URL_SEPARATOR_0);
stringBuilder.append(URL_PATH_JOBS);
stringBuilder.append(URL_SEPARATOR_0);
stringBuilder.append(URL_PATH_VERSION);
stringBuilder.append(URL_SEPARATOR_0);
stringBuilder.append(jobId);
stringBuilder.append(URL_SEPARATOR_0);
stringBuilder.append(URL_PATH_CANCEL);
stringBuilder.append(URL_SEPARATOR_1);
stringBuilder.append(URL_API_VERSION);
return new URL(stringBuilder.toString());
}
/**
* Create url for requesting device twin
*
* @param deviceId The name of the device
* @return 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
* @throws IllegalArgumentException This exception is thrown if device id is null or empty
*/
public URL getUrlTwin(String deviceId) throws MalformedURLException, IllegalArgumentException
{
// Codes_SRS_SERVICE_SDK_JAVA_IOTHUBCONNECTIONSTRING_25_010: [** The function shall throw IllegalArgumentException if the input string is empty or null **]**
if (Tools.isNullOrEmpty(deviceId))
{
throw new IllegalArgumentException("device name cannot be empty or null");
}
//Codes_SRS_SERVICE_SDK_JAVA_IOTHUBCONNECTIONSTRING_25_011: [** The function shall create a URL object from the given deviceId using the following format: https:hostname/twins/deviceId?api-version=201X-XX-XX **]**
StringBuilder stringBuilder = new StringBuilder();
stringBuilder.append(URL_HTTPS);
stringBuilder.append(hostName);
stringBuilder.append(URL_SEPARATOR_0);
stringBuilder.append(URL_PATH_TWIN);
stringBuilder.append(URL_SEPARATOR_0);
stringBuilder.append(deviceId);
stringBuilder.append(URL_SEPARATOR_1);
stringBuilder.append(URL_API_VERSION);
return new URL(stringBuilder.toString());
}
/**
* Create url for requesting module twin
*
* @param deviceId The name of the device
* @param moduleId The name of the device
* @return 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
* @throws IllegalArgumentException This exception is thrown if device id is null or empty
*/
public URL getUrlModuleTwin(String deviceId, String moduleId) throws MalformedURLException, IllegalArgumentException
{
// Codes_SRS_SERVICE_SDK_JAVA_IOTHUBCONNECTIONSTRING_28_010: [** The function shall throw IllegalArgumentException if the input device id is empty or null **]**
if (Tools.isNullOrEmpty(deviceId))
{
throw new IllegalArgumentException("device name cannot be empty or null");
}
// Codes_SRS_SERVICE_SDK_JAVA_IOTHUBCONNECTIONSTRING_28_011: [** The function shall throw IllegalArgumentException if the input module id is empty or null **]**
if (Tools.isNullOrEmpty(moduleId))
{
throw new IllegalArgumentException("module id cannot be empty or null");
}
//Codes_SRS_SERVICE_SDK_JAVA_IOTHUBCONNECTIONSTRING_28_012: [** The function shall create a URL object from the given deviceId and moduleId
// using the following format: https:hostname/twins/deviceId/modules/moduleId?api-version=201X-XX-XX **]**
StringBuilder stringBuilder = new StringBuilder();
stringBuilder.append(URL_HTTPS);
stringBuilder.append(hostName);
stringBuilder.append(URL_SEPARATOR_0);
stringBuilder.append(URL_PATH_TWIN);
stringBuilder.append(URL_SEPARATOR_0);
stringBuilder.append(deviceId);
stringBuilder.append(URL_SEPARATOR_0);
stringBuilder.append(URL_PATH_MODULES);
stringBuilder.append(URL_SEPARATOR_0);
stringBuilder.append(moduleId);
stringBuilder.append(URL_SEPARATOR_1);
stringBuilder.append(URL_API_VERSION);
return new URL(stringBuilder.toString());
}
/**
* Create url for requesting device data
*
* @param deviceId The name of the device
* @return 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
* @throws IllegalArgumentException This exception is thrown if device id is null or empty
*/
public URL getUrlDevice(String deviceId) throws MalformedURLException, IllegalArgumentException
{
// Codes_SRS_SERVICE_SDK_JAVA_IOTHUBCONNECTIONSTRING_12_002: [The function shall throw IllegalArgumentException
// if the input string is empty or null]
if (Tools.isNullOrEmpty(deviceId))
{
throw new IllegalArgumentException("device name cannot be empty or null");
}
// Codes_SRS_SERVICE_SDK_JAVA_IOTHUBCONNECTIONSTRING_12_003: [The function shall create a URL object
// from the given deviceId using the following format: https:hostname/devices/deviceId?api-version=201X-XX-XX]
StringBuilder stringBuilder = new StringBuilder();
stringBuilder.append(URL_HTTPS);
stringBuilder.append(hostName);
stringBuilder.append(URL_SEPARATOR_0);
stringBuilder.append(URL_PATH_DEVICES);
stringBuilder.append(URL_SEPARATOR_0);
stringBuilder.append(deviceId);
stringBuilder.append(URL_SEPARATOR_1);
stringBuilder.append(URL_API_VERSION);
return new URL(stringBuilder.toString());
}
/**
* Create url for requesting module data
*
* @param deviceId The name of the device
* @param moduleId The name of the device
* @return 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
* @throws IllegalArgumentException This exception is thrown if device id is null or empty
*/
public URL getUrlModule(String deviceId, String moduleId) throws MalformedURLException, IllegalArgumentException
{
// Codes_SRS_SERVICE_SDK_JAVA_IOTHUBCONNECTIONSTRING_28_001: [The function shall throw IllegalArgumentException
// if the deviceId string is empty or null]
if (Tools.isNullOrEmpty(deviceId))
{
throw new IllegalArgumentException("device name cannot be empty or null");
}
// Codes_SRS_SERVICE_SDK_JAVA_IOTHUBCONNECTIONSTRING_28_002: [The function shall throw IllegalArgumentException
// if the moduleId string is empty or null]
if (Tools.isNullOrEmpty(moduleId))
{
throw new IllegalArgumentException("module name cannot be empty or null");
}
// Codes_SRS_SERVICE_SDK_JAVA_IOTHUBCONNECTIONSTRING_28_003: [The function shall create a URL object
// from the given deviceId and moduleId using the following format: https:hostname/devices/deviceId?api-version=201X-XX-XX]
StringBuilder stringBuilder = new StringBuilder();
stringBuilder.append(URL_HTTPS);
stringBuilder.append(hostName);
stringBuilder.append(URL_SEPARATOR_0);
stringBuilder.append(URL_PATH_DEVICES);
stringBuilder.append(URL_SEPARATOR_0);
stringBuilder.append(deviceId);
stringBuilder.append(URL_SEPARATOR_0);
stringBuilder.append(URL_PATH_MODULES);
stringBuilder.append(URL_SEPARATOR_0);
stringBuilder.append(moduleId);
stringBuilder.append(URL_SEPARATOR_1);
stringBuilder.append(URL_API_VERSION);
return new URL(stringBuilder.toString());
}
/**
* Create the url needed to apply some configuration content to a device
* @param deviceId The device to apply the configuration content to
* @return 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
* @throws IllegalArgumentException if deviceId is null or empty
*/
public URL getUrlApplyConfigurationContent(String deviceId) throws MalformedURLException, IllegalArgumentException
{
if (Tools.isNullOrEmpty(deviceId))
{
// Codes_SRS_SERVICE_SDK_JAVA_IOTHUBCONNECTIONSTRING_34_026: [The function shall throw IllegalArgumentException
// if the deviceId string is empty or null]
throw new IllegalArgumentException("deviceId cannot be null");
}
StringBuilder stringBuilder = new StringBuilder();
stringBuilder.append(URL_HTTPS);
stringBuilder.append(hostName);
stringBuilder.append(URL_SEPARATOR_0);
stringBuilder.append(URL_PATH_DEVICES);
stringBuilder.append(URL_SEPARATOR_0);
stringBuilder.append(deviceId);
stringBuilder.append(URL_SEPARATOR_0);
stringBuilder.append(URL_PATH_APPLY_CONTENT_CONFIGURATION);
stringBuilder.append(URL_SEPARATOR_1);
stringBuilder.append(URL_API_VERSION);
// Codes_SRS_SERVICE_SDK_JAVA_IOTHUBCONNECTIONSTRING_34_026: [The function shall return a URL in the format
// "https:[hostname]/devices/[deviceId]/applyConfigurationContent?api-version=201X-XX-XX"]
return new URL(stringBuilder.toString());
}
/**
* Create url for requesting configuration data
*
* @param configurationId The name of the configuration
* @return 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
* @throws IllegalArgumentException This exception is thrown if device id is null or empty
*/
public URL getUrlConfiguration(String configurationId) throws MalformedURLException, IllegalArgumentException
{
// Codes_SRS_SERVICE_SDK_JAVA_IOTHUBCONNECTIONSTRING_28_004: [The function shall throw IllegalArgumentException
// if the input string is empty or null]
if (Tools.isNullOrEmpty(configurationId))
{
throw new IllegalArgumentException("configuration id cannot be empty or null");
}
// Codes_SRS_SERVICE_SDK_JAVA_IOTHUBCONNECTIONSTRING_28_005: [The function shall create a URL object
// from the given configurationId using the following format: https:hostname/configurations/configurationId?api-version=201X-XX-XX]
StringBuilder stringBuilder = new StringBuilder();
stringBuilder.append(URL_HTTPS);
stringBuilder.append(hostName);
stringBuilder.append(URL_SEPARATOR_0);
stringBuilder.append(URL_PATH_CONFIG);
stringBuilder.append(URL_SEPARATOR_0);
stringBuilder.append(configurationId);
stringBuilder.append(URL_SEPARATOR_1);
stringBuilder.append(URL_API_VERSION);
return new URL(stringBuilder.toString());
}
/**
* Create url for requesting configuration data
*
* @param maxCount The maximum number of configuration data to return
* @return The Url in the following format: "https:hostname/configurations/?top=maxcount{@literal &}api-version=201X-XX-XX"
* @throws MalformedURLException This exception is thrown if the URL creation failed due to malformed string
* @throws IllegalArgumentException This exception is thrown if device id is null or empty
*/
public URL getUrlConfigurationsList(Integer maxCount) throws MalformedURLException, IllegalArgumentException
{
// Codes_SRS_SERVICE_SDK_JAVA_IOTHUBCONNECTIONSTRING_28_006: [The constructor shall throw NullPointerException
// if the input integer is null]
if ((maxCount == null) || (maxCount < 1))
{
throw new IllegalArgumentException("maxCount cannot be null or less then 1");
}
// Codes_SRS_SERVICE_SDK_JAVA_IOTHUBCONNECTIONSTRING_28_007: [The function shall create a URL object
// from the given configurationId using the following format: https:hostname/configurations/configurationId?api-version=201X-XX-XX]
StringBuilder stringBuilder = new StringBuilder();
stringBuilder.append(URL_HTTPS);
stringBuilder.append(hostName);
stringBuilder.append(URL_SEPARATOR_0);
stringBuilder.append(URL_PATH_CONFIG);
stringBuilder.append(URL_SEPARATOR_1);
stringBuilder.append(URL_MAX_COUNT);
stringBuilder.append(maxCount.toString());
stringBuilder.append(URL_SEPARATOR_2);
stringBuilder.append(URL_API_VERSION);
return new URL(stringBuilder.toString());
}
/**
* Create url for requesting all modules data on a device
*
* @param deviceId The name of the device
* @return 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
* @throws IllegalArgumentException This exception is thrown if device id is null or empty
*/
public URL getUrlModulesOnDevice(String deviceId) throws MalformedURLException, IllegalArgumentException
{
// Codes_SRS_SERVICE_SDK_JAVA_IOTHUBCONNECTIONSTRING_28_008: [The function shall throw IllegalArgumentException
// if the input string is empty or null]
if (Tools.isNullOrEmpty(deviceId))
{
throw new IllegalArgumentException("device name cannot be empty or null");
}
// Codes_SRS_SERVICE_SDK_JAVA_IOTHUBCONNECTIONSTRING_28_009: [The function shall create a URL object
// from the given deviceId using the following format: https:hostname/devices/deviceId/modules?api-version=201X-XX-XX]
StringBuilder stringBuilder = new StringBuilder();
stringBuilder.append(URL_HTTPS);
stringBuilder.append(hostName);
stringBuilder.append(URL_SEPARATOR_0);
stringBuilder.append(URL_PATH_DEVICES);
stringBuilder.append(URL_SEPARATOR_0);
stringBuilder.append(deviceId);
stringBuilder.append(URL_SEPARATOR_0);
stringBuilder.append(URL_PATH_MODULES);
stringBuilder.append(URL_SEPARATOR_1);
stringBuilder.append(URL_API_VERSION);
return new URL(stringBuilder.toString());
}
/**
* Create url for requesting device list
*
* @param maxCount The number of requested devices
* @return URL string to get the device list from IotHub
* @throws MalformedURLException This exception is thrown if the URL creation failed due to malformed string
* @throws IllegalArgumentException This exception is thrown if maxCount is null or empty
*/
public URL getUrlDeviceList(Integer maxCount) throws MalformedURLException, IllegalArgumentException
{
// Codes_SRS_SERVICE_SDK_JAVA_IOTHUBCONNECTIONSTRING_12_004: [The constructor shall throw NullPointerException
// if the input integer is null]
if ((maxCount == null) || (maxCount < 1))
{
throw new IllegalArgumentException("maxCount cannot be null or less then 1");
}
// Codes_SRS_SERVICE_SDK_JAVA_IOTHUBCONNECTIONSTRING_12_005: [The function shall create a URL object from
// the given integer using the following format: https:hostname/devices/?maxCount=XX&api-version=201X-XX-XX]
StringBuilder stringBuilder = new StringBuilder();
stringBuilder.append(URL_HTTPS);
stringBuilder.append(hostName);
stringBuilder.append(URL_SEPARATOR_0);
stringBuilder.append(URL_PATH_DEVICES);
stringBuilder.append(URL_SEPARATOR_0);
stringBuilder.append(URL_SEPARATOR_1);
stringBuilder.append(URL_MAX_COUNT);
stringBuilder.append(maxCount.toString());
stringBuilder.append(URL_SEPARATOR_2);
stringBuilder.append(URL_API_VERSION);
return new URL(stringBuilder.toString());
}
/**
* Create url for requesting device statistics
*
* @return 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
*/
public URL getUrlDeviceStatistics() throws MalformedURLException
{
// Codes_SRS_SERVICE_SDK_JAVA_IOTHUBCONNECTIONSTRING_12_006: [The function shall create a URL object from
// the object properties using the following format: https:hostname/statistics/devices?api-version=201X-XX-XX]
StringBuilder stringBuilder = new StringBuilder();
stringBuilder.append(URL_HTTPS);
stringBuilder.append(hostName);
stringBuilder.append(URL_SEPARATOR_0);
stringBuilder.append(URL_PATH_DEVICESTATISTICS);
stringBuilder.append(URL_SEPARATOR_0);
stringBuilder.append(URL_PATH_DEVICES);
stringBuilder.append(URL_SEPARATOR_1);
stringBuilder.append(URL_API_VERSION);
return new URL(stringBuilder.toString());
}
/**
* Create url for processing a bulk import/export job
*
* @return 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
*/
public URL getUrlCreateExportImportJob() throws MalformedURLException
{
// CODES_SRS_SERVICE_SDK_JAVA_IOTHUBCONNECTIONSTRING_15_008: [The function shall create a URL object
// from the object properties using the following format: https:hostname/jobs/create?api-version=201X-XX-XX.]
StringBuilder stringBuilder = new StringBuilder();
stringBuilder.append(URL_HTTPS);
stringBuilder.append(hostName);
stringBuilder.append(URL_SEPARATOR_0);
stringBuilder.append(URL_PATH_JOBS);
stringBuilder.append(URL_SEPARATOR_0);
stringBuilder.append("create");
stringBuilder.append(URL_SEPARATOR_1);
stringBuilder.append(URL_API_VERSION);
return new URL(stringBuilder.toString());
}
/**
*
* @param jobId Create url for retrieving a bulk import/export job
* @return 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
*/
public URL getUrlImportExportJob(String jobId) throws MalformedURLException
{
// CODES_SRS_SERVICE_SDK_JAVA_IOTHUBCONNECTIONSTRING_15_009: [The function shall create a URL object from
// the object properties using the following format: https:hostname/jobs/jobId?api-version=201X-XX-XX.]
StringBuilder stringBuilder = new StringBuilder();
stringBuilder.append(URL_HTTPS);
stringBuilder.append(hostName);
stringBuilder.append(URL_SEPARATOR_0);
stringBuilder.append(URL_PATH_JOBS);
stringBuilder.append(URL_SEPARATOR_0);
stringBuilder.append(jobId);
stringBuilder.append(URL_SEPARATOR_1);
stringBuilder.append(URL_API_VERSION);
return new URL(stringBuilder.toString());
}
/**
* Serialize connection string
*
* @return Iot Hub connection string
*/
@Override
public String toString()
{
// Codes_SRS_SERVICE_SDK_JAVA_IOTHUBCONNECTIONSTRING_12_007: [The function shall serialize the object to a
// string using the following format: HostName=HOSTNAME.b.c.d;SharedAccessKeyName=ACCESSKEYNAME;SharedAccessKey=1234567890abcdefghijklmnopqrstvwxyz=;SharedAccessSignature=]
StringBuilder stringBuilder = new StringBuilder();
stringBuilder.append(HOST_NAME_PROPERTY_NAME);
stringBuilder.append(VALUE_PAIR_SEPARATOR);
stringBuilder.append(this.hostName);
stringBuilder.append(VALUE_PAIR_DELIMITER);
stringBuilder.append(SHARED_ACCESS_KEY_NAME_PROPERTY_NAME);
stringBuilder.append(VALUE_PAIR_SEPARATOR);
stringBuilder.append(this.sharedAccessKeyName);
stringBuilder.append(VALUE_PAIR_DELIMITER);
stringBuilder.append(SHARED_ACCESS_KEY_PROPERTY_NAME);
stringBuilder.append(VALUE_PAIR_SEPARATOR);
stringBuilder.append(this.sharedAccessKey);
stringBuilder.append(VALUE_PAIR_DELIMITER);
stringBuilder.append(SHARED_ACCESS_SIGNATURE_PROPERTY_NAME);
stringBuilder.append(VALUE_PAIR_SEPARATOR);
stringBuilder.append(this.sharedAccessSignature);
return stringBuilder.toString();
}
/**
* Getter for iotHubName
*
* @return The iot hub name string
*/
public String getIotHubName()
{
return this.iotHubName;
}
/**
* Getter for authenticationMethod
*
* @return The authenticationMethod object
*/
public AuthenticationMethod getAuthenticationMethod()
{
return this.authenticationMethod;
}
/**
* Getter for sharedAccessKeyName
*
* @return The sharedAccessKeyName string
*/
public String getSharedAccessKeyName()
{
return this.sharedAccessKeyName;
}
/**
* Getter for sharedAccessKey
*
* @return The sharedAccessKey string
*/
public String getSharedAccessKey()
{
return this.sharedAccessKey;
}
/**
* Getter for sharedAccessSignature
*
* @return The sharedAccessSignature string
*/
public String getSharedAccessSignature()
{
return this.sharedAccessSignature;
}
/**
* Getter for hostName
*
* @return The hostName string
*/
public String getHostName()
{
return this.hostName;
}
/**
* Setter for sharedAccessKeyName
*
* @param sharedAccessKeyName The value of the signature to set
*/
protected void setSharedAccessKeyName(String sharedAccessKeyName)
{
this.sharedAccessKeyName = sharedAccessKeyName;
}
/**
* Setter for sharedAccessKey
*
* @param sharedAccessKey The value of the signature to set
*/
protected void setSharedAccessKey(String sharedAccessKey)
{
this.sharedAccessKey = sharedAccessKey;
}
/**
* Setter for sharedAccessSignature
*
* @param sharedAccessSignature The value of the signature to set
*/
protected void setSharedAccessSignature(String sharedAccessSignature)
{
this.sharedAccessSignature = sharedAccessSignature;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy