com.gemalto.idp.mobile.otp.oath

Class OathFactory

java.lang.Object

com.gemalto.idp.mobile.otp.oath.OathFactory

public final class OathFactory
extends Object

A factory for creating objects that produce or affect OATH (or its relatives) OTPs.

Since:

4.0

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OathFactory()

Method Summary

Modifier and Type	Method and Description
GemaltoOathDevice	createGemaltoOathDevice(OathToken token) Creates a Hardware or Software Gemalto OATH device for the given OATH token.
DcvOathDevice	createSoftDcvOathDevice(OathToken token) Creates a Hardware or Software DCV OATH device for the given OATH token.
DcvOathDevice	createSoftDcvOathDevice(OathToken token, SoftDcvOathSettings settings) Creates a customized soft DCV OATH device using the specified settings.
SoftDcvOathSettings	createSoftDcvOathSettings() Creates a DCV OATH settings.
GemaltoOathDevice	createSoftGemaltoOathDevice(SoftOathToken token, SoftGemaltoOathSettings settings) Creates a customized soft Gemalto OATH device.
SoftGemaltoOathSettings	createSoftGemaltoOathSettings() Creates a mutable Gemalto OATH settings.
OathDevice	createSoftOathDevice(OathToken token) Creates a Hardware or Software OATH device for the given OATH token.
OathDevice	createSoftOathDevice(SoftOathToken token, SoftOathSettings settings) Creates a customized soft OATH device using the specified settings.
SoftOathSettings	createSoftOathSettings() Creates a OATH settings.

Methods inherited from class java.lang.Object

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

Constructor Detail

OathFactory

protected OathFactory()

Method Detail

createGemaltoOathDevice

public final GemaltoOathDevice createGemaltoOathDevice(OathToken token)
                                                throws IdpException

Creates a Hardware or Software Gemalto OATH device for the given OATH token. Warning! Currently Mobile Protector SDK library only supports Software Gemalto OATH device.

If the token is soft, i.e Token.isSoft() is true, the default Gemalto OATH settings are used, otherwise the device settings are used.

Parameters:

token - the token

Returns:

a Gemalto OATH device object

Throws:

IllegalArgumentException - when the token type is unknown.

IllegalStateException - when the token's key is not a 20 byte key.

IllegalStateException - when the token supports more than one key ( OathToken.TokenCapability ) and its key has not been selected. Applies to tokens that implement SelectableKey.selectKey(int) , e.g. DualSeedSoftOathToken .

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.0

createSoftGemaltoOathDevice

public final GemaltoOathDevice createSoftGemaltoOathDevice(SoftOathToken token,
                                                           SoftGemaltoOathSettings settings)
                                                    throws IdpException

Creates a customized soft Gemalto OATH device.

Parameters:

token - the token

settings - the Gemalto OATH settings

Returns:

a Gemalto OATH device.

Throws:

IllegalStateException - when the OATH key is not 20 bytes

IllegalStateException - when the token supports more than one key ( OathToken.TokenCapability ) and its key has not been selected. Applies to tokens that implement SelectableKey.selectKey(int) , e.g. DualSeedOathToken .

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.0

createSoftGemaltoOathSettings

public final SoftGemaltoOathSettings createSoftGemaltoOathSettings()

Creates a mutable Gemalto OATH settings.

Returns:

new mutable settings based on the default settings

Since:

4.0

createSoftOathDevice

public final OathDevice createSoftOathDevice(OathToken token)
                                      throws IdpException

Creates a Hardware or Software OATH device for the given OATH token. Warning! Currently Mobile Protector SDK library only supports Software OATH device.

If the token is soft, i.e Token.isSoft() is true, the default Gemalto OATH settings are used, otherwise the device settings are used.

Parameters:

token - the token

Returns:

the OATH device

Throws:

IllegalArgumentException - when the token is not a soft token.

IllegalStateException - when the OATH key is not 20, 32 or 64 bytes

IllegalStateException - when the token supports more than one key ( OathToken.TokenCapability ) and its key has not been selected. Applies to tokens that implement SelectableKey.selectKey(int) , e.g. DualSeedSoftOathToken .

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.0

createSoftOathDevice

public final OathDevice createSoftOathDevice(SoftOathToken token,
                                             SoftOathSettings settings)
                                      throws IdpException

Creates a customized soft OATH device using the specified settings.

Parameters:

token - the token

settings - the OATH settings

Returns:

the OATH device

Throws:

IllegalStateException - when the OATH key is not 20, 32 or 64 bytes

IllegalStateException - when the token supports more than one key ( OathToken.TokenCapability ) and its key has not been selected. Applies to tokens that implement SelectableKey.selectKey(int) , e.g. DualSeedSoftOathToken .

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.0

createSoftOathSettings

public final SoftOathSettings createSoftOathSettings()

Creates a OATH settings.

Returns:

new OATH settings based on the default OATH settings

Since:

4.0

createSoftDcvOathDevice

public final DcvOathDevice createSoftDcvOathDevice(OathToken token)
                                            throws IdpException

Creates a Hardware or Software DCV OATH device for the given OATH token. Warning! Currently Mobile Protector SDK library only supports Software OATH device.

If the token is soft, i.e Token.isSoft() is true, the default Gemalto OATH settings are used, otherwise the device settings are used.

Parameters:

token - the token

Returns:

the DCV OATH device

Throws:

IllegalArgumentException - when the token is not a soft token.

IllegalStateException - when the OATH key is not 20, 32 or 64 bytes

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

createSoftDcvOathDevice

public final DcvOathDevice createSoftDcvOathDevice(OathToken token,
                                                   SoftDcvOathSettings settings)
                                            throws IdpException

Creates a customized soft DCV OATH device using the specified settings.

Parameters:

token - the token

settings - the DCV OATH settings

Returns:

the DCV OATH device

Throws:

IllegalStateException - when the OATH key is not 20, 32 or 64 bytes

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

createSoftDcvOathSettings

public final SoftDcvOathSettings createSoftDcvOathSettings()

Creates a DCV OATH settings.

Returns:

new OATH settings based on the default DCV OATH settings

Since:

4.1