Package com.warrenstrange.googleauth

Class GoogleAuthenticatorKey

java.lang.Object

com.warrenstrange.googleauth.GoogleAuthenticatorKey

public final class GoogleAuthenticatorKey
extends Object

This class is a JavaBean used by the GoogleAuthenticator library to represent a secret key.

This class is immutable.

Instance of this class should only be constructed by the GoogleAuthenticator library.

Since:

1.0.0

Version:

1.1.4

Author:

Enrico M. Crisostomo

See Also:

GoogleAuthenticator

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GoogleAuthenticatorKey.Builder	This class is a builder to create instances of the GoogleAuthenticatorKey class.

Method Summary

Modifier and Type	Method	Description
GoogleAuthenticatorConfig	getConfig()	Get the config of this key.
String	getKey()	Returns the secret key in Base32 encoding.
List<Integer>	getScratchCodes()	Get the list of scratch codes.
int	getVerificationCode()	Returns the verification code at time = 0 (the UNIX epoch).

Methods inherited from class java.lang.Object

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

Method Details

getScratchCodes

public List<Integer> getScratchCodes()

Get the list of scratch codes.

Returns:

the list of scratch codes.

getConfig

public GoogleAuthenticatorConfig getConfig()

Get the config of this key.

Returns:

the config of this key.

getKey

public String getKey()

Returns the secret key in Base32 encoding.

Returns:

the secret key in Base32 encoding.

getVerificationCode

public int getVerificationCode()

Returns the verification code at time = 0 (the UNIX epoch).

Returns:

the verificationCode at time = 0 (the UNIX epoch).