com.microsoft.azure.sdk.iot.service

Class ServiceAuthenticationWithSharedAccessPolicyKey

java.lang.Object

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

com.microsoft.azure.sdk.iot.service.ServiceAuthenticationWithSharedAccessPolicyKey

public class ServiceAuthenticationWithSharedAccessPolicyKey
extends AuthenticationMethod

Extend AuthenticationMethod class, provide getters for protected properties and implement populate function to set ServiceAuthenticationWithSharedAccessPolicyKey type policy on given IotHubConnectionString object.

Field Summary

Fields inherited from class com.microsoft.azure.sdk.iot.service.AuthenticationMethod

key, policyName, token

Constructor Summary

Constructors

Constructor and Description
ServiceAuthenticationWithSharedAccessPolicyKey(String policyName, String key) Constructor to create instance from policy name and policy key

Method Summary

Modifier and Type	Method and Description
String	getKey() Getter for policy key
String	getPolicyName() Getter for policy name
protected IotHubConnectionString	populate(IotHubConnectionString iotHubConnectionString) Populate given IotHubConnectionString with proper policy key authentication data
protected void	setKey(String key) Setter for policy key
protected void	setPolicyName(String policyName) Setter for policy name

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceAuthenticationWithSharedAccessPolicyKey

public ServiceAuthenticationWithSharedAccessPolicyKey(String policyName,
                                                      String key)

Constructor to create instance from policy name and policy key

Parameters:

policyName - The policy name string

key - The policy key string

Method Detail

populate

protected IotHubConnectionString populate(IotHubConnectionString iotHubConnectionString)

Populate given IotHubConnectionString with proper policy key authentication data

Specified by:

populate in class AuthenticationMethod

Parameters:

iotHubConnectionString - The iotHubConnectionString object to populate

Returns:

The populated IotHubConnectionString object

getPolicyName

public String getPolicyName()

Getter for policy name

Returns:

The policy name string

setPolicyName

protected void setPolicyName(String policyName)

Setter for policy name

Parameters:

policyName - The string value to set

getKey

public String getKey()

Getter for policy key

Returns:

The policy key string

setKey

protected void setKey(String key)

Setter for policy key

Parameters:

key - The string value to set