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

Class AuthenticationMethod

java.lang.Object

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

public abstract class AuthenticationMethod
extends Object

Class used to abstract the different authentication methods used to use Provisioning SDK.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	key Shared access policy key (if applies)
protected String	policyName Authentication policy name
protected String	token Shared access policy token (if applies)

Constructor Summary

Constructors

Constructor and Description
AuthenticationMethod()

Method Summary

Modifier and Type	Method and Description
protected abstract ProvisioningConnectionString	populateWithAuthenticationProperties(ProvisioningConnectionString provisioningConnectionString) Abstract helper function to populate IotHubConnectionString class with proper authentication properties

Methods inherited from class java.lang.Object

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

Field Detail

policyName

protected String policyName

Authentication policy name

key

protected String key

Shared access policy key (if applies)

token

protected String token

Shared access policy token (if applies)

Constructor Detail

AuthenticationMethod

public AuthenticationMethod()

Method Detail

populateWithAuthenticationProperties

protected abstract ProvisioningConnectionString populateWithAuthenticationProperties(ProvisioningConnectionString provisioningConnectionString)

Abstract helper function to populate IotHubConnectionString class with proper authentication properties

Parameters:

provisioningConnectionString - The ProvisioningConnectionString that is to be populated with the authentication properties.

Returns:

An instance of ProvisioningConnectionString populated with the the authentication properties.