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

Class IotHubSasToken

java.lang.Object

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

public final class IotHubSasToken
extends java.lang.Object

Grants device access to an IoT Hub for the specified amount of time.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IotHubSasToken()
	IotHubSasToken(java.lang.String hostname, java.lang.String deviceId, java.lang.String deviceKey, java.lang.String sharedAccessToken, java.lang.String moduleId, long expiryTime) Constructor.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	buildSharedAccessToken(java.lang.String audience, java.lang.String signature, long expiry) Creates a shared access token from the provided audience, signature and expiry time
java.lang.String	getSasToken()
static boolean	isExpired(java.lang.String sasToken) Returns if the provided sasToken has expired yet or not
java.lang.String	toString() Returns the string representation of the SAS token.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

IotHubSasToken

public IotHubSasToken(java.lang.String hostname,
                      java.lang.String deviceId,
                      java.lang.String deviceKey,
                      java.lang.String sharedAccessToken,
                      java.lang.String moduleId,
                      long expiryTime)

Constructor. Generates a SAS token that grants access to an IoT Hub for the specified amount of time.

Parameters:

hostname - the hostname of the hub the token is for

deviceId - The id of the device the token is for

deviceKey - The device key for connecting the device to the hub with. May be null if sharedAccessToken is not.

sharedAccessToken - The sas token for connecting the device to the hub with. May be null if deviceKey is not.

moduleId - the module id. May be null if the sas token is not for a module

expiryTime - the time, as a UNIX timestamp, after which the token will become invalid

IotHubSasToken

protected IotHubSasToken()

Method Detail

buildSharedAccessToken

public static java.lang.String buildSharedAccessToken(java.lang.String audience,
                                                      java.lang.String signature,
                                                      long expiry)

Creates a shared access token from the provided audience, signature and expiry time

Parameters:

audience - the audience of the token

signature - the signature of the token

expiry - when the token will expire, in seconds since the epoch

Returns:

the shared access token string

toString

public java.lang.String toString()

Returns the string representation of the SAS token.

Overrides:

toString in class java.lang.Object

Returns:

the string representation of the SAS token.

getSasToken

public java.lang.String getSasToken()

isExpired

public static boolean isExpired(java.lang.String sasToken)

Returns if the provided sasToken has expired yet or not

Parameters:

sasToken - the token to check for expiration

Returns:

a boolean true if the SasToken is still valid, or false if it is expired.