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 Object

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

Field Summary

Fields

Modifier and Type	Field and Description
protected long	expiryTime The time, as a UNIX timestamp, before which the token is valid.
protected String	sasToken
protected String	scope The URI for a connection from a device to an IoT Hub.
protected String	signature Components of the SAS token.
static String	TOKEN_FORMAT The SAS token format.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IotHubSasToken()
	IotHubSasToken(DeviceClientConfig config, long expiryTime) Constructor.

Method Summary

Modifier and Type	Method and Description
protected String	buildSasToken()
protected boolean	isSasFormat()
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

Field Detail

TOKEN_FORMAT

public static final String TOKEN_FORMAT

The SAS token format. The parameters to be interpolated are, in order: the signature, the expiry time, the key name (device ID), and the resource URI.

See Also:

Constant Field Values

sasToken

protected String sasToken

signature

protected String signature

Components of the SAS token.

expiryTime

protected long expiryTime

The time, as a UNIX timestamp, before which the token is valid.

scope

protected String scope

The URI for a connection from a device to an IoT Hub. Does not include a protocol.

Constructor Detail

IotHubSasToken

public IotHubSasToken(DeviceClientConfig config,
                      long expiryTime)

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

Parameters:

config - the device client config.

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

IotHubSasToken

protected IotHubSasToken()

Method Detail

toString

public String toString()

Returns the string representation of the SAS token.

Overrides:

toString in class Object

Returns:

the string representation of the SAS token.

isSasFormat

protected boolean isSasFormat()

buildSasToken

protected String buildSasToken()