com.microsoft.azure.sdk.iot.service

Class ServiceAuthenticationWithSharedAccessPolicyToken

java.lang.Object

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

com.microsoft.azure.sdk.iot.service.ServiceAuthenticationWithSharedAccessPolicyToken

public class ServiceAuthenticationWithSharedAccessPolicyToken
extends AuthenticationMethod

Extend AuthenticationMethod class, provide getters for protected properties and implement populate function to set ServiceAuthenticationWithSharedAccessPolicyToken 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
ServiceAuthenticationWithSharedAccessPolicyToken(String policyName, String token) Constructor to create instance from policy name and policy key

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceAuthenticationWithSharedAccessPolicyToken

public ServiceAuthenticationWithSharedAccessPolicyToken(String policyName,
                                                        String token)

Constructor to create instance from policy name and policy key

Parameters:

policyName - The policy name string

token - The token string

Method Detail

populate

public IotHubConnectionString populate(IotHubConnectionString iotHubConnectionString)

Populate given IotHubConnectionString with proper policy token 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 final void setPolicyName(String policyName)

Setter for policy name

Parameters:

policyName - The string value to set

getToken

public String getToken()

Getter for policy token

Returns:

The policy token string

setToken

protected final void setToken(String token)

Setter for policy token

Parameters:

token - The string value to set