ProvisioningConnectionString Class

Package:

com.microsoft.azure.sdk.iot.provisioning.service.auth

Maven Artifact:

com.microsoft.azure.sdk.iot.provisioning:provisioning-service-client:1.7.0

• java.lang.Object
• • com.microsoft.azure.sdk.iot.provisioning.service.auth.ProvisioningConnectionStringBuilder
  • • com.microsoft.azure.sdk.iot.provisioning.service.auth.ProvisioningConnectionString

public class ProvisioningConnectionString
extends ProvisioningConnectionStringBuilder

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 AuthenticationMethod	authenticationMethod
protected java.lang.String	deviceProvisioningServiceName
protected java.lang.String	hostName
protected java.lang.String	sharedAccessKey
protected java.lang.String	sharedAccessKeyName
protected java.lang.String	sharedAccessSignature

Method Summary

Modifier and Type	Method and Description
AuthenticationMethod	getAuthenticationMethod() Getter for authenticationMethod
java.lang.String	getDeviceProvisioningServiceName() Getter for deviceProvisioningServiceName
java.lang.String	getHostName() Getter for hostName
java.lang.String	getSharedAccessKey() Getter for sharedAccessKey
java.lang.String	getSharedAccessKeyName() Getter for sharedAccessKeyName
java.lang.String	getSharedAccessSignature() Getter for sharedAccessSignature
java.lang.String	getUserString() Serialize user string
java.lang.String	toString() Serialize connection string

Methods inherited from ProvisioningConnectionStringBuilder

createConnectionString createConnectionString

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

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

deviceProvisioningServiceName

protected String deviceProvisioningServiceName

hostName

protected String hostName

sharedAccessKey

protected String sharedAccessKey

sharedAccessKeyName

protected String sharedAccessKeyName

sharedAccessSignature

protected String sharedAccessSignature

Method Details

getAuthenticationMethod

public AuthenticationMethod getAuthenticationMethod()

Getter for authenticationMethod

Returns:

The authenticationMethod object

getDeviceProvisioningServiceName

public String getDeviceProvisioningServiceName()

Getter for deviceProvisioningServiceName

Returns:

The Device Provisioning Service name string

getHostName

public String getHostName()

Getter for hostName

Returns:

The hostName string

getSharedAccessKey

public String getSharedAccessKey()

Getter for sharedAccessKey

Returns:

The sharedAccessKey string

getSharedAccessKeyName

public String getSharedAccessKeyName()

Getter for sharedAccessKeyName

Returns:

The sharedAccessKeyName string

getSharedAccessSignature

public String getSharedAccessSignature()

Getter for sharedAccessSignature

Returns:

The sharedAccessSignature string

getUserString

public String getUserString()

Serialize user string

Returns:

The user string in the following format: "SharedAccessKeyName@SAS.root.deviceProvisioningServiceName"

toString

public String toString()

Serialize connection string

Overrides:

ProvisioningConnectionString.toString()

Returns:

Provisioning connection string

Azure SDK for Java

Latest