Package org.forgerock.android.auth

Class HOTPMechanism

java.lang.Object

org.forgerock.android.auth.Mechanism

org.forgerock.android.auth.OathMechanism

org.forgerock.android.auth.HOTPMechanism

All Implemented Interfaces:

java.lang.Comparable<Mechanism>

public class HOTPMechanism
extends OathMechanism

Represents HMAC-based OTP authentication mechanism and is responsible for its related operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HOTPMechanism.HOTPBuilder	Builder class responsible for producing a TOTPMechanism Token.

Nested classes/interfaces inherited from class org.forgerock.android.auth.OathMechanism

OathMechanism.OathBuilder<T extends OathMechanism.OathBuilder>, OathMechanism.TokenType

Field Summary

Fields

Modifier and Type	Field	Description
protected long	counter	Counter as in Int for number of OTP credentials generated

Fields inherited from class org.forgerock.android.auth.OathMechanism

algorithm, digits

Fields inherited from class org.forgerock.android.auth.Mechanism

OATH, PUSH

Method Summary

Modifier and Type	Method	Description
static HOTPMechanism.HOTPBuilder	builder()	Returns a builder for creating a HOTPMechanism Mechanism.
static HOTPMechanism	deserialize(java.lang.String jsonString)	Deserializes the specified Json into an object of the HOTPMechanism object.
OathTokenCode	getOathTokenCode()	Generates a new set of codes for this OathMechanism Token.
java.lang.String	toJson()	Creates a JSON string representation of ModelObject object.

Methods inherited from class org.forgerock.android.auth.OathMechanism

getAlgorithm, getDigits, getOathType

Methods inherited from class org.forgerock.android.auth.Mechanism

compareTo, equals, getAccountName, getId, getIssuer, getMechanismUID, getTimeAdded, getType, hashCode, matches

Methods inherited from class java.lang.Object

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

Field Detail

counter

protected long counter

Counter as in Int for number of OTP credentials generated

Method Detail

getOathTokenCode

public OathTokenCode getOathTokenCode()
                               throws OathMechanismException

Description copied from class: OathMechanism

Generates a new set of codes for this OathMechanism Token.

Specified by:

getOathTokenCode in class OathMechanism

Returns:

OathTokenCode object that contains the currently active token code

Throws:

OathMechanismException - If an error occur on generating the OTP codes

toJson

public java.lang.String toJson()

Creates a JSON string representation of ModelObject object. Sensitive information are not exposed.

Specified by:

toJson in class OathMechanism

Returns:

a JSON string object

deserialize

public static HOTPMechanism deserialize(java.lang.String jsonString)

Deserializes the specified Json into an object of the HOTPMechanism object.

Parameters:

jsonString - the json string representing the object to be deserialized

Returns:

an HOTPMechanism object from the string. Returns null if jsonString is null, if jsonString is empty or not able to parse it.

builder

public static HOTPMechanism.HOTPBuilder builder()

Returns a builder for creating a HOTPMechanism Mechanism.

Returns:

The OathMechanism builder.