com.microsoft.azure.sdk.iot.device.net

Class IotHubUri

java.lang.Object

com.microsoft.azure.sdk.iot.device.net.IotHubUri

public final class IotHubUri
extends Object

A URI for a device to connect to an IoT Hub.

Field Summary

Fields

Modifier and Type	Field and Description
static String	API_VERSION The API version will be passed as a param in the URI.
protected String	hostname The IoT Hub resource URI is the hostname and path component that is common to all IoT Hub communication methods between the given device and IoT Hub.
static Charset	IOTHUB_URL_ENCODING_CHARSET The charset used when URL-encoding the IoT Hub name and device ID.
protected String	path
static String	PATH_FORMAT The device ID and specific IoT Hub method path will be interpolated into the path.
protected String	uri

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IotHubUri()
	IotHubUri(String iotHubHostname, String deviceId, String iotHubMethodPath) Constructor.
	IotHubUri(String iotHubHostname, String deviceId, String iotHubMethodPath, Map<String,String> queryParams) Constructor.

Method Summary

Modifier and Type	Method and Description
protected static void	appendQueryParam(StringBuilder uriBuilder, String name, String value) URL-encodes the query param name and value using charset UTF-8 and appends them to the URI.
String	getHostname() Returns the string representation of the IoT Hub hostname.
String	getPath() Returns the string representation of the IoT Hub path.
static String	getResourceUri(String iotHubHostname, String deviceId) Returns the string representation of the IoT Hub resource URI.
String	toString() Returns the string representation of the IoT Hub URI.
protected static String	urlEncodePath(String path) URL-encodes each subdirectory in the path.

Methods inherited from class java.lang.Object

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

Field Detail

PATH_FORMAT

public static final String PATH_FORMAT

The device ID and specific IoT Hub method path will be interpolated into the path.

See Also:

Constant Field Values

API_VERSION

public static final String API_VERSION

The API version will be passed as a param in the URI.

See Also:

Constant Field Values

IOTHUB_URL_ENCODING_CHARSET

public static final Charset IOTHUB_URL_ENCODING_CHARSET

The charset used when URL-encoding the IoT Hub name and device ID.

hostname

protected String hostname

The IoT Hub resource URI is the hostname and path component that is common to all IoT Hub communication methods between the given device and IoT Hub.

path

protected String path

uri

protected String uri

Constructor Detail

IotHubUri

public IotHubUri(String iotHubHostname,
                 String deviceId,
                 String iotHubMethodPath,
                 Map<String,String> queryParams)

Constructor. Creates a URI to an IoT Hub method. The URI does not include a protocol. The function will safely escape the given arguments.

Parameters:

iotHubHostname - the IoT Hub hostname.

deviceId - the device ID.

iotHubMethodPath - the path from the IoT Hub resource to the method.

queryParams - the URL query parameters. Can be null.

IotHubUri

public IotHubUri(String iotHubHostname,
                 String deviceId,
                 String iotHubMethodPath)

Constructor. Equivalent to new IotHubUri(iotHubHostname, deviceId, iotHubMethodPath, null).

Parameters:

iotHubHostname - the IoT Hub hostname.

deviceId - the device ID.

iotHubMethodPath - the path from the IoT Hub resource to the method.

IotHubUri

protected IotHubUri()

Method Detail

toString

public String toString()

Returns the string representation of the IoT Hub URI.

Overrides:

toString in class Object

Returns:

the string representation of the IoT Hub URI.

getHostname

public String getHostname()

Returns the string representation of the IoT Hub hostname.

Returns:

the string representation of the IoT Hub hostname.

getPath

public String getPath()

Returns the string representation of the IoT Hub path.

Returns:

the string representation of the IoT Hub path.

getResourceUri

public static String getResourceUri(String iotHubHostname,
                                    String deviceId)

Returns the string representation of the IoT Hub resource URI. The IoT Hub resource URI is the hostname and path component that is common to all IoT Hub communication methods between the given device and IoT Hub. Safely escapes the IoT Hub resource URI.

Parameters:

iotHubHostname - the IoT Hub hostname.

deviceId - the device ID.

Returns:

the string representation of the IoT Hub resource URI.

urlEncodePath

protected static String urlEncodePath(String path)

URL-encodes each subdirectory in the path.

Parameters:

path - the path to be safely escaped.

Returns:

a path with each subdirectory URL-encoded.

appendQueryParam

protected static void appendQueryParam(StringBuilder uriBuilder,
                                       String name,
                                       String value)

URL-encodes the query param name and value using charset UTF-8 and appends them to the URI.

Parameters:

uriBuilder - the URI.

name - the query param name.

value - the query param value.