com.microstrategy.usher

Class UsherCodeEntity

java.lang.Object

com.microstrategy.usher.UsherCodeEntity

public abstract class UsherCodeEntity
extends java.lang.Object

The UsherCodeEntity abstract class wraps the core attributes pertaining to the MicroStrategy Badge code, a dynamic identification number that users can use to validate the identities of others using the MicroStrategy Badge app, or the time-based one-time password (TOTP).

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MINIMUM_USHER_CODE_LENGTH Default minimum MicroStrategy Badge code length.
static java.lang.String	TOTP_CODE_INVALID Default value if TOTP is invalid.
static java.lang.String	TOTP_CODE_NOT_SUPPORTED Default value if TOTP is not supported.
static java.lang.String	USHER_CODE_INVALID Default value if MicroStrategy Badge code is invalid.
static java.lang.String	USHER_QR_CODE_INVALID Default value if MicroStrategy Badge QR code is invalid.

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	qrCode() Returns a String of the QR code content.
abstract boolean	supportTotpCode() Returns a boolean that represents whether or not server configuration supports the time-based one-time password (TOTP).
abstract java.lang.String	totpCode() Returns a String of the time-based one-time password (TOTP).
abstract int	totpCodeDuration() Returns an int of the duration in seconds a time-based one-time password (TOTP) will last before expiring.
abstract int	totpCodeLeftTime() Returns an int of the duration in seconds a time-based one-time password (TOTP) will last before expiring.
abstract java.lang.String	usherCode() Returns a String of the MicroStrategy Badge code.
abstract int	usherCodeDuration() Returns an int of the duration in seconds an MicroStrategy Badge code will last before expiring.
abstract int	usherCodeLeftTime() Returns an int of the number of seconds left an MicroStrategy Badge code will last before expiring.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MINIMUM_USHER_CODE_LENGTH

public static final int DEFAULT_MINIMUM_USHER_CODE_LENGTH

Default minimum MicroStrategy Badge code length. Value is 4.

See Also:

Constant Field Values

TOTP_CODE_NOT_SUPPORTED

public static final java.lang.String TOTP_CODE_NOT_SUPPORTED

Default value if TOTP is not supported. Value is "".

See Also:

Constant Field Values

TOTP_CODE_INVALID

public static final java.lang.String TOTP_CODE_INVALID

Default value if TOTP is invalid. Value is "------".

See Also:

Constant Field Values

USHER_CODE_INVALID

public static final java.lang.String USHER_CODE_INVALID

Default value if MicroStrategy Badge code is invalid. Value is "----".

See Also:

Constant Field Values

USHER_QR_CODE_INVALID

public static final java.lang.String USHER_QR_CODE_INVALID

Default value if MicroStrategy Badge QR code is invalid. Value is "".

See Also:

Constant Field Values

Method Detail

supportTotpCode

public abstract boolean supportTotpCode()

Returns a boolean that represents whether or not server configuration supports the time-based one-time password (TOTP).

Returns:

true if the server configuration supports the time-based one-time password (TOTP); false otherwise.

usherCode

public abstract java.lang.String usherCode()

Returns a String of the MicroStrategy Badge code.

Returns:

the MicroStrategy Badge code.

totpCode

public abstract java.lang.String totpCode()

Returns a String of the time-based one-time password (TOTP).

Returns:

the time-based one-time password (TOTP).

qrCode

public abstract java.lang.String qrCode()

Returns a String of the QR code content.

Returns:

the QR code content.

totpCodeDuration

public abstract int totpCodeDuration()

Returns an int of the duration in seconds a time-based one-time password (TOTP) will last before expiring.

Returns:

the duration in seconds a time-based one-time password (TOTP) will last before expiring.

usherCodeDuration

public abstract int usherCodeDuration()

Returns an int of the duration in seconds an MicroStrategy Badge code will last before expiring.

Returns:

the duration in seconds an MicroStrategy Badge code will last before expiring.

totpCodeLeftTime

public abstract int totpCodeLeftTime()

Returns an int of the duration in seconds a time-based one-time password (TOTP) will last before expiring.

Returns:

the duration in seconds a time-based one-time password (TOTP) will last before expiring.

usherCodeLeftTime

public abstract int usherCodeLeftTime()

Returns an int of the number of seconds left an MicroStrategy Badge code will last before expiring.

Returns:

the number of seconds left an MicroStrategy Badge code will last before expiring.