com.microsoft.azure.sdk.iot.service

Class IotHubConnectionStringBuilder

java.lang.Object

com.microsoft.azure.sdk.iot.service.IotHubConnectionStringBuilder

Direct Known Subclasses:

IotHubConnectionString

public class IotHubConnectionStringBuilder
extends Object

Provide static constructors to create IotHubConnectionString object

Constructor Summary

Constructors

Constructor and Description
IotHubConnectionStringBuilder()

Method Summary

Modifier and Type	Method and Description
static IotHubConnectionString	createConnectionString(String connectionString) Static constructor to create IotHubConnectionString deserialize the given string
static IotHubConnectionString	createConnectionString(String hostName, AuthenticationMethod authenticationMethod) Static constructor to create IotHubConnectionString from host name and authentication method
protected static void	parse(String connectionString, IotHubConnectionString iotHubConnectionString) Deserialize connection string
protected static String	parseIotHubName(IotHubConnectionString iotHubConnectionString) Parse the iot hub name part from the host name
protected static void	setAuthenticationMethod(AuthenticationMethod authenticationMethod, IotHubConnectionString iotHubConnectionString) Set authentication method to target IotHubConnectionString object
protected static void	setHostName(String hostName, IotHubConnectionString iotHubConnectionString) Set host name value to target IotHubConnectionString object
protected static void	validate(IotHubConnectionString iotHubConnectionString) Validate IotHubConnectionString format
protected static void	validateFormat(String value, String propertyName, String regex) Validate string property using given regex
protected static void	validateFormatIfSpecified(String value, String propertyName, String regex) Validate string property using given regex if value is not null or empty

Methods inherited from class java.lang.Object

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

Constructor Detail

IotHubConnectionStringBuilder

public IotHubConnectionStringBuilder()

Method Detail

createConnectionString

public static IotHubConnectionString createConnectionString(String connectionString)
                                                     throws IOException

Static constructor to create IotHubConnectionString deserialize the given string

Parameters:

connectionString - The serialized connection string

Returns:

The IotHubConnectionString object

Throws:

IOException - This exception is thrown if the object creation failed

createConnectionString

public static IotHubConnectionString createConnectionString(String hostName,
                                                            AuthenticationMethod authenticationMethod)
                                                     throws IOException

Static constructor to create IotHubConnectionString from host name and authentication method

Parameters:

hostName - The hostName string

authenticationMethod - The AuthenticationMethod object

Returns:

The IotHubConnectionString object

Throws:

IOException - This exception is thrown if the object creation failed

parse

protected static void parse(String connectionString,
                            IotHubConnectionString iotHubConnectionString)
                     throws IOException

Deserialize connection string

Parameters:

connectionString - The connection string to deserialize

iotHubConnectionString - The target object for deserialization

Throws:

IOException - This exception is thrown if the parsing failed

parseIotHubName

protected static String parseIotHubName(IotHubConnectionString iotHubConnectionString)

Parse the iot hub name part from the host name

Parameters:

iotHubConnectionString - The source iotHubConnectionString containing the hostName

Returns:

The substring of the host name until the first "." character

validate

protected static void validate(IotHubConnectionString iotHubConnectionString)
                        throws IllegalArgumentException

Validate IotHubConnectionString format

Parameters:

iotHubConnectionString - The object to validate

Throws:

IllegalArgumentException - This exception is thrown if the input object is null

validateFormat

protected static void validateFormat(String value,
                                     String propertyName,
                                     String regex)

Validate string property using given regex

Parameters:

value - The string value to validate

propertyName - The property name

regex - The regex used for validation

validateFormatIfSpecified

protected static void validateFormatIfSpecified(String value,
                                                String propertyName,
                                                String regex)

Validate string property using given regex if value is not null or empty

Parameters:

value - string value to validate

propertyName - property name

regex - regex used for validation

setHostName

protected static void setHostName(String hostName,
                                  IotHubConnectionString iotHubConnectionString)

Set host name value to target IotHubConnectionString object

Parameters:

hostName - host name string

iotHubConnectionString - target IotHubConnectionString object

setAuthenticationMethod

protected static void setAuthenticationMethod(AuthenticationMethod authenticationMethod,
                                              IotHubConnectionString iotHubConnectionString)

Set authentication method to target IotHubConnectionString object

Parameters:

authenticationMethod - value to set

iotHubConnectionString - target IotHubConnectionString object