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

Class IotHubSasTokenProvidedAuthenticationProvider

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

public class IotHubSasTokenProvidedAuthenticationProvider
extends IotHubSasTokenAuthenticationProvider

IotHubSasTokenAuthenticationProvider implementation where the tokens are provided by an instance of SasTokenProvider. This is used in cases like when the user creates a device client with DeviceClient(String, String, SasTokenProvider, IotHubClientProtocol, ClientOptions)

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
IotHubSasTokenProvidedAuthenticationProvider(java.lang.String hostName, java.lang.String deviceId, java.lang.String moduleId, SasTokenProvider sasTokenProvider, javax.net.ssl.SSLContext sslContext)

Method Summary

Modifier and Type	Method and Description
boolean	canRefreshToken()
int	getMillisecondsBeforeProactiveRenewal()
char[]	getSasToken()
boolean	isAuthenticationProviderRenewalNecessary() Returns true if the this authentication provider is no longer valid.
boolean	isSasTokenExpired()
void	setTokenValidSecs(long tokenValidSecs)

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

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

IotHubSasTokenProvidedAuthenticationProvider

public IotHubSasTokenProvidedAuthenticationProvider(java.lang.String hostName,
                                                    java.lang.String deviceId,
                                                    java.lang.String moduleId,
                                                    SasTokenProvider sasTokenProvider,
                                                    javax.net.ssl.SSLContext sslContext)

Method Detail

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:

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

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()

Specified by:

getSasToken in class IotHubSasTokenAuthenticationProvider

getMillisecondsBeforeProactiveRenewal

public int getMillisecondsBeforeProactiveRenewal()

Overrides:

getMillisecondsBeforeProactiveRenewal in class IotHubSasTokenAuthenticationProvider

isSasTokenExpired

public boolean isSasTokenExpired()

Overrides:

isSasTokenExpired in class IotHubSasTokenAuthenticationProvider