com.microsoft.azure.sdk.iot.device.hsm

Class IotHubSasTokenHsmAuthenticationProvider

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.IotHubSasTokenWithRefreshAuthenticationProvider

com.microsoft.azure.sdk.iot.device.hsm.IotHubSasTokenHsmAuthenticationProvider

public class IotHubSasTokenHsmAuthenticationProvider
extends IotHubSasTokenWithRefreshAuthenticationProvider

Authentication method that uses HSM to get a SAS token.

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

Method Summary

Modifier and Type	Method and Description
boolean	canRefreshToken() Returns true as the Hsm can always refresh the token
static IotHubSasTokenHsmAuthenticationProvider	create(SignatureProvider signatureProvider, java.lang.String deviceId, java.lang.String moduleId, java.lang.String hostname, java.lang.String gatewayHostname, java.lang.String generationId, int suggestedTimeToLiveSeconds, int timeBufferPercentage) Constructor for a IotHubSasTokenHsmAuthenticationProvider instance
static IotHubSasTokenHsmAuthenticationProvider	create(SignatureProvider signatureProvider, java.lang.String deviceId, java.lang.String moduleId, java.lang.String hostname, java.lang.String gatewayHostname, java.lang.String generationId, int suggestedTimeToLiveSeconds, int timeBufferPercentage, javax.net.ssl.SSLContext sslContext) Constructor for a IotHubSasTokenHsmAuthenticationProvider instance
void	refreshSasToken() Renew the saved sas token using the HSM unit

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

buildAudience, getSasToken, isAuthenticationProviderRenewalNecessary

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

Method Detail

create

public static IotHubSasTokenHsmAuthenticationProvider create(SignatureProvider signatureProvider,
                                                             java.lang.String deviceId,
                                                             java.lang.String moduleId,
                                                             java.lang.String hostname,
                                                             java.lang.String gatewayHostname,
                                                             java.lang.String generationId,
                                                             int suggestedTimeToLiveSeconds,
                                                             int timeBufferPercentage)
                                                      throws java.io.IOException,
                                                             TransportException

Constructor for a IotHubSasTokenHsmAuthenticationProvider instance

Parameters:

signatureProvider - the signature provider to be used when generating sas tokens

deviceId - the id of the device the module belongs to

moduleId - the id of the module to be authenticated for

hostname - the hostname of the iothub to be authenticated for. May be null if gatewayHostname is not

gatewayHostname - the gatewayHostname of the edge hub to be authenticated for. May be null if hostname is not

generationId - the generation id

suggestedTimeToLiveSeconds - the time for the generated sas tokens to live for

timeBufferPercentage - the percent of the life a sas token will live before attempting to be renewed. (100 means don't renew until end of life)

Returns:

the created IotHubSasTokenHsmAuthenticationProvider instance

Throws:

java.io.IOException - If the Hsm unit cannot be reached

TransportException - If the Hsm unit cannot be reached

create

public static IotHubSasTokenHsmAuthenticationProvider create(SignatureProvider signatureProvider,
                                                             java.lang.String deviceId,
                                                             java.lang.String moduleId,
                                                             java.lang.String hostname,
                                                             java.lang.String gatewayHostname,
                                                             java.lang.String generationId,
                                                             int suggestedTimeToLiveSeconds,
                                                             int timeBufferPercentage,
                                                             javax.net.ssl.SSLContext sslContext)
                                                      throws java.io.IOException,
                                                             TransportException

Constructor for a IotHubSasTokenHsmAuthenticationProvider instance

Parameters:

signatureProvider - the signature provider to be used when generating sas tokens

deviceId - the id of the device the module belongs to

moduleId - the id of the module to be authenticated for

hostname - the hostname of the iothub to be authenticated for. May be null if gatewayHostname is not

gatewayHostname - the gatewayHostname of the edge hub to be authenticated for. May be null if hostname is not

generationId - the generation id

suggestedTimeToLiveSeconds - the time for the generated sas tokens to live for

timeBufferPercentage - the percent of the life a sas token will live before attempting to be renewed. (100 means don't renew until end of life)

sslContext - the SSLContext to open connections with

Returns:

the created IotHubSasTokenHsmAuthenticationProvider instance

Throws:

java.io.IOException - If the Hsm unit cannot be reached

TransportException - If the Hsm unit cannot be reached

refreshSasToken

public void refreshSasToken()
                     throws java.io.IOException,
                            TransportException

Renew the saved sas token using the HSM unit

Specified by:

refreshSasToken in class IotHubSasTokenWithRefreshAuthenticationProvider

Throws:

java.io.IOException - If the Hsm unit cannot be reached

TransportException - If the Hsm unit cannot be reached

canRefreshToken

public boolean canRefreshToken()

Returns true as the Hsm can always refresh the token

Specified by:

canRefreshToken in class IotHubSasTokenAuthenticationProvider

Returns:

true