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

Class IotHubSasTokenWithRefreshAuthenticationProvider

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

Direct Known Subclasses:

IotHubSasTokenHsmAuthenticationProvider

public abstract class IotHubSasTokenWithRefreshAuthenticationProvider
extends IotHubSasTokenAuthenticationProvider

Authentication method that uses a shared access signature token and allows for token refresh.

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

Modifier	Constructor and Description
protected	IotHubSasTokenWithRefreshAuthenticationProvider(java.lang.String hostname, java.lang.String gatewayHostName, java.lang.String deviceId, java.lang.String moduleId, java.lang.String sharedAccessToken, int suggestedTimeToLiveSeconds, int timeBufferPercentage) Constructor for IotHubSasTokenWithRefreshAuthenticationProvider
protected	IotHubSasTokenWithRefreshAuthenticationProvider(java.lang.String hostname, java.lang.String gatewayHostName, java.lang.String deviceId, java.lang.String moduleId, java.lang.String sharedAccessToken, int suggestedTimeToLiveSeconds, int timeBufferPercentage, javax.net.ssl.SSLContext sslContext) Constructor for IotHubSasTokenWithRefreshAuthenticationProvider

Method Summary

Modifier and Type	Method and Description
protected static java.lang.String	buildAudience(java.lang.String hostname, java.lang.String deviceId, java.lang.String moduleId) Constructs the audience string to be used in a sas token
char[]	getSasToken() Check if sas token should be renewed at all, and then renew it if necessary
boolean	isAuthenticationProviderRenewalNecessary() Returns false as instances of this class will always be able to renew their own sas token
abstract void	refreshSasToken() Renew the saved sas token

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

canRefreshToken, 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

IotHubSasTokenWithRefreshAuthenticationProvider

protected IotHubSasTokenWithRefreshAuthenticationProvider(java.lang.String hostname,
                                                          java.lang.String gatewayHostName,
                                                          java.lang.String deviceId,
                                                          java.lang.String moduleId,
                                                          java.lang.String sharedAccessToken,
                                                          int suggestedTimeToLiveSeconds,
                                                          int timeBufferPercentage)

Constructor for IotHubSasTokenWithRefreshAuthenticationProvider

Parameters:

hostname - the hostname

gatewayHostName - the gateway hostname

deviceId - the device id

moduleId - the module id

sharedAccessToken - the shared access token

suggestedTimeToLiveSeconds - the time to live for generated tokens

timeBufferPercentage - the percent of a sas token's life to live before renewing

IotHubSasTokenWithRefreshAuthenticationProvider

protected IotHubSasTokenWithRefreshAuthenticationProvider(java.lang.String hostname,
                                                          java.lang.String gatewayHostName,
                                                          java.lang.String deviceId,
                                                          java.lang.String moduleId,
                                                          java.lang.String sharedAccessToken,
                                                          int suggestedTimeToLiveSeconds,
                                                          int timeBufferPercentage,
                                                          javax.net.ssl.SSLContext sslContext)

Constructor for IotHubSasTokenWithRefreshAuthenticationProvider

Parameters:

hostname - the hostname

gatewayHostName - the gateway hostname

deviceId - the device id

moduleId - the module id

sharedAccessToken - the shared access token

suggestedTimeToLiveSeconds - the time to live for generated tokens

timeBufferPercentage - the percent of a sas token's life to live before renewing

sslContext - the SSLContext the connection will use

Method Detail

buildAudience

protected static java.lang.String buildAudience(java.lang.String hostname,
                                                java.lang.String deviceId,
                                                java.lang.String moduleId)
                                         throws java.io.UnsupportedEncodingException

Constructs the audience string to be used in a sas token

Parameters:

hostname - the hostname

deviceId - the device id

moduleId - the module id

Returns:

the audience

Throws:

java.io.UnsupportedEncodingException - if UTF-8 encoding is not supported

isAuthenticationProviderRenewalNecessary

public boolean isAuthenticationProviderRenewalNecessary()

Returns false as instances of this class will always be able to renew their own sas token

Overrides:

isAuthenticationProviderRenewalNecessary in class IotHubSasTokenAuthenticationProvider

Returns:

false

refreshSasToken

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

Renew the saved sas token

Throws:

java.io.IOException - If an IOException is encountered while refreshing the sas token

TransportException - If a TransportException is encountered while refreshing the sas token

getSasToken

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

Check if sas token should be renewed at all, and then renew it if necessary

Specified by:

getSasToken in class IotHubSasTokenAuthenticationProvider

Returns:

the renewed token, or the old token if it did not need to be renewed

Throws:

java.io.IOException - If an IOException is encountered while refreshing the sas token

TransportException - If a TransportException is encountered while refreshing the sas token