Package com.warrenstrange.googleauth

Class GoogleAuthenticatorKey.Builder

java.lang.Object

com.warrenstrange.googleauth.GoogleAuthenticatorKey.Builder

Enclosing class:

GoogleAuthenticatorKey

public static class GoogleAuthenticatorKey.Builder
extends Object

This class is a builder to create instances of the GoogleAuthenticatorKey class.

Constructor Summary

Constructors

Constructor	Description
Builder(String key)	Creates an instance of the builder.

Method Summary

Modifier and Type	Method	Description
GoogleAuthenticatorKey	build()	Creates an instance of the GoogleAuthenticatorKey class.
GoogleAuthenticatorKey.Builder	setConfig(GoogleAuthenticatorConfig config)	Sets the config of the TOTP algorithm for this key.
GoogleAuthenticatorKey.Builder	setKey(String key)	Sets the secret key.
GoogleAuthenticatorKey.Builder	setScratchCodes(List<Integer> scratchCodes)	Sets the scratch codes.
GoogleAuthenticatorKey.Builder	setVerificationCode(int verificationCode)	Sets the verification code.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder(String key)

Creates an instance of the builder.

Parameters:

key - the secret key in Base32 encoding.

See Also:

GoogleAuthenticatorKey(GoogleAuthenticatorConfig, String, int, List)

Method Details

build

public GoogleAuthenticatorKey build()

Creates an instance of the GoogleAuthenticatorKey class.

Returns:

an instance of the GoogleAuthenticatorKey class initialized with the properties set in this builder.

See Also:

GoogleAuthenticatorKey(GoogleAuthenticatorConfig, String, int, List)

setConfig

public GoogleAuthenticatorKey.Builder setConfig(GoogleAuthenticatorConfig config)

Sets the config of the TOTP algorithm for this key.

Parameters:

config - the config of the TOTP algorithm for this key.

Returns:

the builder.

See Also:

GoogleAuthenticatorKey(GoogleAuthenticatorConfig, String, int, List)

setKey

public GoogleAuthenticatorKey.Builder setKey(String key)

Sets the secret key.

Parameters:

key - the secret key.

Returns:

the builder.

See Also:

GoogleAuthenticatorKey(GoogleAuthenticatorConfig, String, int, List)

setVerificationCode

public GoogleAuthenticatorKey.Builder setVerificationCode(int verificationCode)

Sets the verification code.

Parameters:

verificationCode - the verification code.

Returns:

the builder.

See Also:

GoogleAuthenticatorKey(GoogleAuthenticatorConfig, String, int, List)

setScratchCodes

public GoogleAuthenticatorKey.Builder setScratchCodes(List<Integer> scratchCodes)

Sets the scratch codes.

Parameters:

scratchCodes - the scratch codes.

Returns:

the builder.

See Also:

GoogleAuthenticatorKey(GoogleAuthenticatorConfig, String, int, List)