org.forgerock.android.auth

Class OathMechanism

java.lang.Object

org.forgerock.android.auth.Mechanism

org.forgerock.android.auth.OathMechanism

All Implemented Interfaces:

java.lang.Comparable<Mechanism>

Direct Known Subclasses:

HOTPMechanism, TOTPMechanism

public abstract class OathMechanism
extends Mechanism

Represents an instance of a OATH authentication mechanism.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OathMechanism.OathBuilder<T extends OathMechanism.OathBuilder> Builder class responsible for producing a Token.
static class	OathMechanism.TokenType

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	algorithm Algorithm of HMAC-based OTP
protected int	digits Digits as in Int for length of OTP credentials

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

OATH, PUSH

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OathMechanism(java.lang.String mechanismUID, java.lang.String issuer, java.lang.String accountName, java.lang.String type, OathMechanism.TokenType oathType, java.lang.String algorithm, java.lang.String secret, int digits, java.util.Calendar timeCreated)

Method Summary

Modifier and Type	Method and Description
static OathMechanism	deserialize(java.lang.String jsonString) Deserializes the specified Json into an object of the OathMechanism object.
java.lang.String	getAlgorithm() Returns the algorithm used by this OathMechanism.
int	getDigits() Returns the number of digits that are in OTPs generated by this Token.
abstract OathTokenCode	getOathTokenCode() Generates a new set of codes for this OathMechanism Token.
OathMechanism.TokenType	getOathType() Returns the token type (HOTPMechanism, TOTPMechanism).
abstract java.lang.String	toJson() Creates a JSON string representation of T object.

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

algorithm

protected java.lang.String algorithm

Algorithm of HMAC-based OTP

digits

protected int digits

Digits as in Int for length of OTP credentials

Constructor Detail

OathMechanism

protected OathMechanism(java.lang.String mechanismUID,
                        java.lang.String issuer,
                        java.lang.String accountName,
                        java.lang.String type,
                        OathMechanism.TokenType oathType,
                        java.lang.String algorithm,
                        java.lang.String secret,
                        int digits,
                        java.util.Calendar timeCreated)

Method Detail

getDigits

public int getDigits()

Returns the number of digits that are in OTPs generated by this Token.

Returns:

the OTP length as int

getAlgorithm

public java.lang.String getAlgorithm()

Returns the algorithm used by this OathMechanism.

Returns:

algorithm value as String

getOathType

public OathMechanism.TokenType getOathType()

Returns the token type (HOTPMechanism, TOTPMechanism).

Returns:

The token type

getOathTokenCode

public abstract OathTokenCode getOathTokenCode()
                                        throws OathMechanismException

Generates a new set of codes for this OathMechanism Token.

Returns:

OathTokenCode object that contains the currently active token code

Throws:

OathMechanismException - If an error occur on generating the OTP codes

toJson

public abstract java.lang.String toJson()

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

Specified by:

toJson in class Mechanism

Returns:

a JSON string object

deserialize

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

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

Parameters:

jsonString - the json string representing the object to be deserialized

Returns:

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