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

Class IotHubSasTokenSoftwareAuthenticationProvider

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

public class IotHubSasTokenSoftwareAuthenticationProvider
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
IotHubSasTokenSoftwareAuthenticationProvider(java.lang.String hostname, java.lang.String gatewayHostname, java.lang.String deviceId, java.lang.String moduleId, java.lang.String deviceKey, java.lang.String sharedAccessToken) Constructor that takes a connection string containing a sas token or a device key and uses the default token valid seconds and timeBufferPercentage
IotHubSasTokenSoftwareAuthenticationProvider(java.lang.String hostname, java.lang.String gatewayHostname, java.lang.String deviceId, java.lang.String moduleId, java.lang.String deviceKey, java.lang.String sharedAccessToken, int tokenValidSecs, int timeBufferPercentage) Constructor that takes a connection string containing a sas token or a device key
IotHubSasTokenSoftwareAuthenticationProvider(java.lang.String hostname, java.lang.String gatewayHostname, java.lang.String deviceId, java.lang.String moduleId, java.lang.String deviceKey, java.lang.String sharedAccessToken, javax.net.ssl.SSLContext sslContext) Constructor that takes a connection string containing a sas token or a device key and uses the default token valid seconds and timeBufferPercentage

Method Summary

Modifier and Type	Method and Description
boolean	canRefreshToken()
char[]	getSasToken() Getter for SasToken.
boolean	isAuthenticationProviderRenewalNecessary() Returns true if the saved sas token has expired and cannot be auto-renewed through the device key
void	setTokenValidSecs(long tokenValidSecs)

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

getMillisecondsBeforeProactiveRenewal, getTokenValidSecs, isSasTokenExpired, 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

IotHubSasTokenSoftwareAuthenticationProvider

public IotHubSasTokenSoftwareAuthenticationProvider(java.lang.String hostname,
                                                    java.lang.String gatewayHostname,
                                                    java.lang.String deviceId,
                                                    java.lang.String moduleId,
                                                    java.lang.String deviceKey,
                                                    java.lang.String sharedAccessToken,
                                                    int tokenValidSecs,
                                                    int timeBufferPercentage)

Constructor that takes a connection string containing a sas token or a device key

Parameters:

hostname - the IotHub host name

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

deviceId - the IotHub device id

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

deviceKey - the device key for the device. Must be null if the provided sharedAccessToken is not

sharedAccessToken - the sas token string for accessing the device. Must be null if the provided deviceKey is not.

tokenValidSecs - the number of seconds that the token will be valid for

timeBufferPercentage - the percent of the sas token's life that will be exhausted before renewal is attempted

IotHubSasTokenSoftwareAuthenticationProvider

public IotHubSasTokenSoftwareAuthenticationProvider(java.lang.String hostname,
                                                    java.lang.String gatewayHostname,
                                                    java.lang.String deviceId,
                                                    java.lang.String moduleId,
                                                    java.lang.String deviceKey,
                                                    java.lang.String sharedAccessToken)

Constructor that takes a connection string containing a sas token or a device key and uses the default token valid seconds and timeBufferPercentage

Parameters:

hostname - the IotHub host name

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

deviceId - the IotHub device id

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

deviceKey - the device key for the device. Must be null if the provided sharedAccessToken is not

sharedAccessToken - the sas token string for accessing the device. Must be null if the provided deviceKey is not.

IotHubSasTokenSoftwareAuthenticationProvider

public IotHubSasTokenSoftwareAuthenticationProvider(java.lang.String hostname,
                                                    java.lang.String gatewayHostname,
                                                    java.lang.String deviceId,
                                                    java.lang.String moduleId,
                                                    java.lang.String deviceKey,
                                                    java.lang.String sharedAccessToken,
                                                    javax.net.ssl.SSLContext sslContext)

Constructor that takes a connection string containing a sas token or a device key and uses the default token valid seconds and timeBufferPercentage

Parameters:

hostname - the IotHub host name

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

deviceId - the IotHub device id

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

deviceKey - the device key for the device. Must be null if the provided sharedAccessToken is not

sharedAccessToken - the sas token string for accessing the device. Must be null if the provided deviceKey is not.

sslContext - the sslContext to use for SSL negotiation

Method Detail

isAuthenticationProviderRenewalNecessary

public boolean isAuthenticationProviderRenewalNecessary()

Returns true if the saved sas token has expired and cannot be auto-renewed through the device key

Overrides:

isAuthenticationProviderRenewalNecessary in class IotHubSasTokenAuthenticationProvider

Returns:

if the sas token needs manual renewal

setTokenValidSecs

public void setTokenValidSecs(long tokenValidSecs)

Overrides:

setTokenValidSecs in class IotHubSasTokenAuthenticationProvider

canRefreshToken

public boolean canRefreshToken()

Specified by:

canRefreshToken in class IotHubSasTokenAuthenticationProvider

getSasToken

public char[] getSasToken()

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