com.microsoft.azure.sdk.iot.device.auth

Class IotHubSasTokenHardwareAuthenticationProvider

java.lang.Object

com.microsoft.azure.sdk.iot.device.auth.IotHubAuthenticationProvider

com.microsoft.azure.sdk.iot.device.auth.IotHubSasTokenAuthenticationProvider

com.microsoft.azure.sdk.iot.device.auth.IotHubSasTokenHardwareAuthenticationProvider

public class IotHubSasTokenHardwareAuthenticationProvider
extends IotHubSasTokenAuthenticationProvider

Field Summary

Fields inherited from class com.microsoft.azure.sdk.iot.device.auth.IotHubSasTokenAuthenticationProvider

sasToken, tokenValidSecs

Fields inherited from class com.microsoft.azure.sdk.iot.device.auth.IotHubAuthenticationProvider

deviceId, gatewayHostname, hostname, moduleId

Constructor Summary

Constructors

Constructor and Description
IotHubSasTokenHardwareAuthenticationProvider(java.lang.String hostname, java.lang.String gatewayHostname, java.lang.String deviceId, java.lang.String moduleId, com.microsoft.azure.sdk.iot.provisioning.security.SecurityProvider securityProvider) Creates a Sas Token based authentication object that uses the provided security provider to produce sas tokens.

Method Summary

Modifier and Type	Method and Description
boolean	canRefreshToken()
char[]	getSasToken() Getter for SasToken.
boolean	isAuthenticationProviderRenewalNecessary() Returns true if the this authentication provider is no longer valid.

Methods inherited from class com.microsoft.azure.sdk.iot.device.auth.IotHubSasTokenAuthenticationProvider

getMillisecondsBeforeProactiveRenewal, getTokenValidSecs, isSasTokenExpired, setTokenValidSecs, shouldRefreshToken

Methods inherited from class com.microsoft.azure.sdk.iot.device.auth.IotHubAuthenticationProvider

getDeviceId, getGatewayHostname, getHostname, getModuleId, getSSLContext

Methods inherited from class java.lang.Object

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

Constructor Detail

IotHubSasTokenHardwareAuthenticationProvider

public IotHubSasTokenHardwareAuthenticationProvider(java.lang.String hostname,
                                                    java.lang.String gatewayHostname,
                                                    java.lang.String deviceId,
                                                    java.lang.String moduleId,
                                                    com.microsoft.azure.sdk.iot.provisioning.security.SecurityProvider securityProvider)
                                             throws java.io.IOException

Creates a Sas Token based authentication object that uses the provided security provider to produce sas tokens.

Parameters:

hostname - The host name of the hub to authenticate against

gatewayHostname - The gateway hostname to use, or null if connecting to an IotHub

deviceId - The unique id of the device to authenticate

moduleId - the module id. May be null if not using a module

securityProvider - the security provider to use for authentication

Throws:

java.io.IOException - if the provided securityProvider throws while retrieving a sas token or ssl context instance

Method Detail

getSasToken

public char[] getSasToken()
                   throws java.io.IOException

Getter for SasToken. If the saved token has expired, this method shall renew it if possible

Specified by:

getSasToken in class IotHubSasTokenAuthenticationProvider

Returns:

The value of SasToken

Throws:

java.io.IOException - if generating the sas token from the TPM fails

canRefreshToken

public boolean canRefreshToken()

Specified by:

canRefreshToken in class IotHubSasTokenAuthenticationProvider

isAuthenticationProviderRenewalNecessary

public boolean isAuthenticationProviderRenewalNecessary()

Description copied from class: IotHubSasTokenAuthenticationProvider

Returns true if the this authentication provider is no longer valid. If true, users will need to create a new DeviceClient instance to get a new authentication provider. The most common case for this is if the user provides a SAS token, but no symmetric key, and that SAS token has expired. At that point, the user's client won't be able to authenticate anymore.

Overrides:

isAuthenticationProviderRenewalNecessary in class IotHubSasTokenAuthenticationProvider

Returns:

always returns false as the hardware authentication mechanism will never need to be updated with a new key or token