Package com.bastiaanjansen.otp

Class TOTPGenerator.Builder

java.lang.Object

com.bastiaanjansen.otp.OTPGenerator.Builder<TOTPGenerator.Builder,TOTPGenerator>

com.bastiaanjansen.otp.TOTPGenerator.Builder

Enclosing class:

TOTPGenerator

public static class TOTPGenerator.Builder
extends OTPGenerator.Builder<TOTPGenerator.Builder,TOTPGenerator>

Author:

Bastiaan Jansen

See Also:

TOTPGenerator

Field Summary

Fields

Modifier and Type	Field	Description
static java.time.Duration	DEFAULT_PERIOD	Default time interval for a time-based one-time password

Fields inherited from class com.bastiaanjansen.otp.OTPGenerator.Builder

algorithm, DEFAULT_HMAC_ALGORITHM, DEFAULT_PASSWORD_LENGTH, passwordLength, secret

Constructor Summary

Constructors

Constructor	Description
Builder(byte[] secret)	Constructs a TOTPGenerator builder

Method Summary

Modifier and Type	Method	Description
TOTPGenerator	build()	Build the generator with specified options
static TOTPGenerator	fromOTPAuthURI(URI uri)	Build a TOTPGenerator from an OTPAuth URI
TOTPGenerator.Builder	getBuilder()
java.time.Duration	getPeriod()
static TOTPGenerator	withDefaultValues(byte[] secret)	Create a TOTPGenerator with default values
TOTPGenerator.Builder	withPeriod(java.time.Duration period)	Change period

Methods inherited from class com.bastiaanjansen.otp.OTPGenerator.Builder

getAlgorithm, getPasswordLength, getSecret, withAlgorithm, withPasswordLength

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_PERIOD

public static final java.time.Duration DEFAULT_PERIOD

Default time interval for a time-based one-time password

Constructor Details

Builder

public Builder(byte[] secret)

Constructs a TOTPGenerator builder

Parameters:

secret - used to generate hash

Method Details

withPeriod

public TOTPGenerator.Builder withPeriod(java.time.Duration period)

Change period

Parameters:

period - time interval between new codes

Returns:

builder

getPeriod

public java.time.Duration getPeriod()

build

public TOTPGenerator build()

Build the generator with specified options

Specified by:

build in class OTPGenerator.Builder<TOTPGenerator.Builder,TOTPGenerator>

Returns:

TOTPGenerator

getBuilder

public TOTPGenerator.Builder getBuilder()

Specified by:

getBuilder in class OTPGenerator.Builder<TOTPGenerator.Builder,TOTPGenerator>

fromOTPAuthURI

public static TOTPGenerator fromOTPAuthURI(URI uri) throws URISyntaxException

Build a TOTPGenerator from an OTPAuth URI

Parameters:

uri - OTPAuth URI

Returns:

TOTPGenerator

Throws:

URISyntaxException - when URI cannot be parsed

withDefaultValues

public static TOTPGenerator withDefaultValues(byte[] secret)

Create a TOTPGenerator with default values

Parameters:

secret - used to generate hash

Returns:

a TOTPGenerator with default values