com.gemalto.idp.mobile.otp.cap

Class CapFactory

java.lang.Object

com.gemalto.idp.mobile.otp.cap.CapFactory

public final class CapFactory
extends Object

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CapFactory()

Method Summary

Modifier and Type	Method and Description
CapDevice	createCapDevice(CapToken token) Creates a Hardware or Software CAP device for the given CAP token.
CapDevice	createSoftCapDevice(SoftCapToken token, SoftCapSettings settings) Creates a Software CAP device for the given token using the given settings.
SoftCapSettings	createSoftCapSettings() Create a mutable copy of the default CAP settings used for soft tokens.

Methods inherited from class java.lang.Object

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

Constructor Detail

CapFactory

protected CapFactory()

Method Detail

createCapDevice

public final CapDevice createCapDevice(CapToken token)
                                throws IdpException

Creates a Hardware or Software CAP device for the given CAP token.

Warning! Currently Mobile Protector SDK library only supports Software CAP device.

If the token is soft, i.e Token.isSoft() is true, the default CAP settings returned via createSoftCapSettings() are used, otherwise the device settings are used.

Parameters:

token - the CAP token

Returns:

the CAP device

Throws:

IllegalArgumentException - when the token type is unknown

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.

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

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

Since:

4.0

createSoftCapSettings

public final SoftCapSettings createSoftCapSettings()

Create a mutable copy of the default CAP settings used for soft tokens.

Returns:

new Mutable CAP settings based on the default cap settings

Since:

4.0

createSoftCapDevice

public final CapDevice createSoftCapDevice(SoftCapToken token,
                                           SoftCapSettings settings)
                                    throws IdpException

Creates a Software CAP device for the given token using the given settings. This method may only be used for soft tokens, i.e Token.isSoft() is true.

Parameters:

token - the CAP token

settings - the CAP settings

Returns:

the CAP device

Throws:

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