AuthenticationMethod Class

  • java.lang.Object
    • com.microsoft.azure.sdk.iot.service.AuthenticationMethod

public abstract class AuthenticationMethod

Class used to abstract the different authentication methods used to use IoT Hub SDK.

Field Summary

Modifier and Type Field and Description
protected java.lang.String key

Shared access policy key (if applies)

protected java.lang.String policyName

Authentication policy name

protected java.lang.String token

Shared access policy token (if applies)

Constructor Summary

Constructor Description
AuthenticationMethod()

Method Summary

Modifier and Type Method and Description
protected abstract IotHubConnectionString populate(IotHubConnectionString iotHubConnectionStringBuilder)

Abstract helper function to populate IotHubConnectionString class with proper authentication properties

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

key

protected String key

Shared access policy key (if applies)

policyName

protected String policyName

Authentication policy name

token

protected String token

Shared access policy token (if applies)

Constructor Details

AuthenticationMethod

public AuthenticationMethod()

Method Details

populate

protected abstract IotHubConnectionString populate(IotHubConnectionString iotHubConnectionStringBuilder)

Abstract helper function to populate IotHubConnectionString class with proper authentication properties

Parameters:

iotHubConnectionStringBuilder - The IotHubConnectionString that is to be populated with the authentication properties.

Returns:

An instance of IotHubConnectionString populated with the the authentication properties.

Applies to