com.hidglobal.ia.service.otp.parameters.TOTPParameters Class Reference

Defines the TOTP algorithm parameters. More...

Inheritance diagram for com.hidglobal.ia.service.otp.parameters.TOTPParameters:

Public Member Functions
long	getClock ()
int	getCodeDigits ()
String	getMACAlgo ()
long	getStartTime ()
long	getTimeStep ()
int	getTruncationOffset ()
boolean	isChecksumUsed ()
void	setClock (long clock)
void	setCodeDigits (int codeDigits)
void	setMACAlgo (String algorithm)
void	setStartTime (long startTime)
void	setTimeStep (long timeStep)
void	setTruncationOffset (int truncationOffset)
void	setUseChecksum (boolean useChecksum)
Public Member Functions inherited from com.hidglobal.ia.service.otp.parameters.AlgorithmParameters
Set< String >	getModes ()
int	getStandardVersion ()
void	setModes (Set< String > authModes)
void	setStandardVersion (int standardVersion)

Detailed Description

Defines the TOTP algorithm parameters.

Member Function Documentation

getClock()

long com.hidglobal.ia.service.otp.parameters.TOTPParameters.getClock ( )

inline

Return the clock used for the calculation (seconds)

Returns

Returns number of seconds as "Unix time" (i.e., the number of seconds elapsed since midnight UTC of January 1, 1970).

getCodeDigits()

int com.hidglobal.ia.service.otp.parameters.TOTPParameters.getCodeDigits ( )

inline

Returns

the number of truncated digits.

getMACAlgo()

String com.hidglobal.ia.service.otp.parameters.TOTPParameters.getMACAlgo ( )

inline

Returns

the MAC algorithm value.

getStartTime()

long com.hidglobal.ia.service.otp.parameters.TOTPParameters.getStartTime ( )

inline

Return the start time used for clock synchronization.

Returns

Returns Start Time as number of seconds.

getTimeStep()

long com.hidglobal.ia.service.otp.parameters.TOTPParameters.getTimeStep ( )

inline

Return the timestep used for calculation.

Returns

Returns TimeStep as number of seconds.

getTruncationOffset()

int com.hidglobal.ia.service.otp.parameters.TOTPParameters.getTruncationOffset ( )

inline

Returns

the truncation offset.

isChecksumUsed()

boolean com.hidglobal.ia.service.otp.parameters.TOTPParameters.isChecksumUsed ( )

inline

Returns

if the checksum is added to OTP

setClock()

void com.hidglobal.ia.service.otp.parameters.TOTPParameters.setClock ( long  clock )

inline

Sets the clock value.

Parameters

clock

the clock value

setCodeDigits()

void com.hidglobal.ia.service.otp.parameters.TOTPParameters.setCodeDigits ( int  codeDigits )

inline

Sets the number of truncated digits.

Parameters

codeDigits

the number of truncated digits

setMACAlgo()

void com.hidglobal.ia.service.otp.parameters.TOTPParameters.setMACAlgo ( String  algorithm )

inline

Sets the MAC algorithm value.

Parameters

algorithm

the MAC algorithm value

setStartTime()

void com.hidglobal.ia.service.otp.parameters.TOTPParameters.setStartTime ( long  startTime )

inline

Sets the start time used for clock synchronization.

Parameters

startTime

Start Time as number of seconds.

setTimeStep()

void com.hidglobal.ia.service.otp.parameters.TOTPParameters.setTimeStep ( long  timeStep )

inline

Sets the time step

Parameters

timeStep

the time step

setTruncationOffset()

void com.hidglobal.ia.service.otp.parameters.TOTPParameters.setTruncationOffset ( int  truncationOffset )

inline

Sets the truncation offset

Parameters

truncationOffset

the truncation offset

setUseChecksum()

void com.hidglobal.ia.service.otp.parameters.TOTPParameters.setUseChecksum ( boolean  useChecksum )

inline

Sets the use of the checksum

Parameters

useChecksum

true if checksum must be used