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

Class IotHubSasTokenAuthenticationProvider

java.lang.Object

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

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

Direct Known Subclasses:

IotHubSasTokenHardwareAuthenticationProvider, IotHubSasTokenProvidedAuthenticationProvider, IotHubSasTokenSoftwareAuthenticationProvider, IotHubSasTokenWithRefreshAuthenticationProvider

public abstract class IotHubSasTokenAuthenticationProvider
extends IotHubAuthenticationProvider

Field Summary

Fields

Modifier and Type	Field and Description
protected IotHubSasToken	sasToken
protected long	tokenValidSecs The number of seconds after which the generated SAS token for a message will become invalid.

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

deviceId, gatewayHostname, hostname, moduleId

Constructor Summary

Constructors

Constructor and Description
IotHubSasTokenAuthenticationProvider(java.lang.String hostname, java.lang.String gatewayHostname, java.lang.String deviceId, java.lang.String moduleId)
IotHubSasTokenAuthenticationProvider(java.lang.String hostname, java.lang.String gatewayHostname, java.lang.String deviceId, java.lang.String moduleId, long tokenValidSecs, int timeBufferPercentage)

Method Summary

Modifier and Type	Method and Description
abstract boolean	canRefreshToken()
int	getMillisecondsBeforeProactiveRenewal()
abstract char[]	getSasToken()
long	getTokenValidSecs()
boolean	isAuthenticationProviderRenewalNecessary() Returns true if the this authentication provider is no longer valid.
boolean	isSasTokenExpired()
void	setTokenValidSecs(long tokenValidSecs)
boolean	shouldRefreshToken(boolean proactivelyRenew) Returns true if the saved token should be refreshed

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

Field Detail

tokenValidSecs

protected long tokenValidSecs

The number of seconds after which the generated SAS token for a message will become invalid. We also use the expiry time, which is computed as currentTime() + DEVICE_KEY_VALID_LENGTH, as a salt when generating our SAS token.

sasToken

protected IotHubSasToken sasToken

Constructor Detail

IotHubSasTokenAuthenticationProvider

public IotHubSasTokenAuthenticationProvider(java.lang.String hostname,
                                            java.lang.String gatewayHostname,
                                            java.lang.String deviceId,
                                            java.lang.String moduleId)

IotHubSasTokenAuthenticationProvider

public IotHubSasTokenAuthenticationProvider(java.lang.String hostname,
                                            java.lang.String gatewayHostname,
                                            java.lang.String deviceId,
                                            java.lang.String moduleId,
                                            long tokenValidSecs,
                                            int timeBufferPercentage)

Method Detail

canRefreshToken

public abstract boolean canRefreshToken()

getSasToken

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

Throws:

java.io.IOException

TransportException

setTokenValidSecs

public void setTokenValidSecs(long tokenValidSecs)

isAuthenticationProviderRenewalNecessary

public boolean isAuthenticationProviderRenewalNecessary()

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.

Returns:

true if the this authentication provider is no longer valid. False otherwise

isSasTokenExpired

public boolean isSasTokenExpired()

shouldRefreshToken

public boolean shouldRefreshToken(boolean proactivelyRenew)

Returns true if the saved token should be refreshed

Parameters:

proactivelyRenew - if true, this function will return true even if the saved token has not expired, but only if the token has lived beyond its time buffer percentage

Returns:

true if the caller should refresh the saved sas token

getMillisecondsBeforeProactiveRenewal

public int getMillisecondsBeforeProactiveRenewal()

getTokenValidSecs

public long getTokenValidSecs()