com.gemalto.idp.mobile.otp.oath

Interface DcvOathDevice

public interface DcvOathDevice

An DCV OATH device complying with the Standard Gemalto DCV options.

Since:

4.1

Method Summary

Modifier and Type	Method and Description
SecureString	getDcv(AuthInput authInput) Gets a time based DCV value as defined by the Standard Gemalto DCV options.
int	getLastDcvLifespan() Return lifespan of the last DCV computed by this device.

Method Detail

getDcv

SecureString getDcv(AuthInput authInput)
             throws IdpException

Gets a time based DCV value as defined by the Standard Gemalto DCV options.

Parameters:

authInput - the AuthInput

Returns:

the DCV

Throws:

IdpRuntimeException - when there is a cryptography operation failure.

IdpException - this is generic exception, you can directly catch this exception or catch each specific exception below.

IdpStorageException - when there is a database operation failure.

DeviceFingerprintException - when the token's fingerprint checksum does not match.

PasswordManagerException - when the TOKEN domain is not logged in (using one of the password managers).

Since:

4.1

getLastDcvLifespan

int getLastDcvLifespan()

Return lifespan of the last DCV computed by this device.

The following example illustrates the usage:

   // Create DCV OATH settings (see OathFactory)
   SoftDcvOathSettings dcvOathSettings = ...

   // Create a DCV OATH device (see OathFactory)
   OathDcvDevice device = ...

   // Compute a time-based DCV with device
   device.getDcv(pin);

   // Each time getLastDcvLifespan is called, it returns the
   // remaining lifespan in seconds of the last time-based DCV. Lifespan is
   // computed with respect of device's settings (in this example it returns
   // the lifespan according to Gemalto device fixed settings, i.e. 30-seconds timestep).
   int lifespan = device.getLastDcvLifespan();
 

Returns:

• In case last DCV computed with this device is time-based
  • If positive, the last DCV is still valid according to the current time and device's timestep settings. The returned value indicates the remaining seconds before the DCV becomes obsolete.
  • If negative, the last DCV computed is obsolete. The absolute value indicates the time elapsed since the DCV has become obsolete.
• In case last DCV computed with this device is event-based, or no DCV has been computed yet, the function returns Integer.MAX_VALUE.

Since:

4.1