com.gemalto.idp.mobile.otp.oath

Interface OathTokenManager

All Superinterfaces:

TokenManager

public interface OathTokenManager
extends TokenManager

OathTokenManager interface.

Since:

4.0

Nested Class Summary

Nested classes/interfaces inherited from interface com.gemalto.idp.mobile.otp.TokenManager

TokenManager.TokenCreationCallback

Method Summary

Modifier and Type	Method and Description
void	createLowPlatformCouplingToken(java.lang.String name, ProvisioningConfiguration configuration, TokenManager.TokenCreationCallback tokenCreationCallback) To Creates a LowPlatformCoupling Token which is not affected by the changes in DeviceFingerprint.
<T extends OathToken> T	createToken(java.lang.String name, ProvisioningConfiguration configuration)
<T extends OathToken> T	createToken(java.lang.String name, ProvisioningConfiguration configuration, DeviceFingerprintTokenPolicy fps)
void	createToken(java.lang.String name, ProvisioningConfiguration configuration, DeviceFingerprintTokenPolicy fps, TokenManager.TokenCreationCallback tokenCreationCallback)
<T extends OathToken> T	createToken(java.lang.String name, ProvisioningConfiguration configuration, OathToken.TokenCapability capability)
<T extends OathToken> T	createToken(java.lang.String name, ProvisioningConfiguration configuration, OathToken.TokenCapability capability, DeviceFingerprintTokenPolicy fps) Gets capabilities of an existing token.
void	createToken(java.lang.String name, ProvisioningConfiguration configuration, OathToken.TokenCapability capability, DeviceFingerprintTokenPolicy fps, TokenManager.TokenCreationCallback tokenCreationCallback)
<T extends OathToken> T	getToken(java.lang.String name) Gets an existing token.
<T extends OathToken> T	getToken(java.lang.String name, byte[] fingerPrintCustomData) Gets an existing token.
OathToken.TokenCapability	getTokenCapability(java.lang.String name) Gets capability of an existing token.
<T extends OathToken> T	getTokenWithUserTokenId(int uti) Gets an existing token.
<T extends OathToken> T	getTokenWithUserTokenId(int uti, byte[] fingerPrintCustomData) Gets an existing token.

Methods inherited from interface com.gemalto.idp.mobile.otp.TokenManager

getTokenNames, removeToken, removeToken

Method Detail

getToken

<T extends OathToken> T getToken(java.lang.String name)
                          throws IdpStorageException,
                                 PasswordManagerException,
                                 DeviceFingerprintException,
                                 IdpException

Gets an existing token.

Parameters:

name - the name of the token

Returns:

the token, null if not found

Throws:

RootPolicyException - when the OtpConfiguration.TokenRootPolicy requires this exception to be thrown when the physical device is rooted.

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

IdpStorageException - when database operation failed, or when the name is already used by an existing token.

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)

ActivationException - when the activation code supplied on IdpCore.configure(byte[], IdpConfiguration...) or IdpCore.configure(boolean, byte[], IdpConfiguration...) does not have the white box cryptography feature turned on.

getToken

<T extends OathToken> T getToken(java.lang.String name,
                                 byte[] fingerPrintCustomData)
                          throws IdpStorageException,
                                 PasswordManagerException,
                                 DeviceFingerprintException,
                                 IdpException

Gets an existing token.

Parameters:

name - the name of the token

fingerPrintCustomData - the fingerprint custom data, can be null

Returns:

the token, null if not found

Throws:

RootPolicyException - when the OtpConfiguration.TokenRootPolicy requires this exception to be thrown when the physical device is rooted.

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

IdpStorageException - when database operation failed, or when the name is already used by an existing token.

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

DeviceFingerprintException - when the fingerprint generated at runtime does not match the expected fingerprint.

ActivationException - when the activation code supplied on IdpCore.configure(byte[], IdpConfiguration...) or IdpCore.configure(boolean, byte[], IdpConfiguration...) does not have the white box cryptography feature turned on.

getTokenWithUserTokenId

<T extends OathToken> T getTokenWithUserTokenId(int uti)
                                         throws IdpStorageException,
                                                PasswordManagerException,
                                                DeviceFingerprintException,
                                                IdpException

Gets an existing token.

Parameters:

uti - the user token id

Returns:

the token, null if not found

Throws:

RootPolicyException - when the OtpConfiguration.TokenRootPolicy requires this exception to be thrown when the physical device is rooted.

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

IdpStorageException - when database operation failed, or when the name is already used by an existing token.

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)

ActivationException - when the activation code supplied on IdpCore.configure(byte[], IdpConfiguration...) or IdpCore.configure(boolean, byte[], IdpConfiguration...) does not have the white box cryptography feature turned on.

getTokenWithUserTokenId

<T extends OathToken> T getTokenWithUserTokenId(int uti,
                                                byte[] fingerPrintCustomData)
                                         throws IdpStorageException,
                                                PasswordManagerException,
                                                DeviceFingerprintException,
                                                IdpException

Gets an existing token.

Parameters:

uti - the user token id

fingerPrintCustomData - the fingerprint custom data, can be null

Returns:

the token, null if not found

Throws:

RootPolicyException - when the OtpConfiguration.TokenRootPolicy requires this exception to be thrown when the physical device is rooted.

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

IdpStorageException - when database operation failed, or when the name is already used by an existing token.

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

DeviceFingerprintException - when the fingerprint generated at runtime does not match the expected fingerprint.

ActivationException - when the activation code supplied on IdpCore.configure(byte[], IdpConfiguration...) or IdpCore.configure(boolean, byte[], IdpConfiguration...) does not have the white box cryptography feature turned on.

createToken

<T extends OathToken> T createToken(java.lang.String name,
                                    ProvisioningConfiguration configuration)
                             throws IdpStorageException,
                                    PasswordManagerException,
                                    DeviceFingerprintException,
                                    IdpNetworkException,
                                    IdpException

Parameters:

name - the name of the token Before creating the token, integrator has to make sure there is no existing token with the same token name.

configuration - see ProvisioningConfiguration

Returns:

the token, null if not found

Throws:

RootPolicyException - when the OtpConfiguration.TokenRootPolicy requires this exception to be thrown when the physical device is rooted.

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

IdpStorageException - when database operation failed, or when the name is already used by an existing token.

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

DeviceFingerprintException - when the fingerprint generated at runtime does not match the expected fingerprint.

IdpNetworkException - when network operation fails.

IdpRuntimeException - when this function is using unsupported provisioning protocol.

createToken

<T extends OathToken> T createToken(java.lang.String name,
                                    ProvisioningConfiguration configuration,
                                    OathToken.TokenCapability capability)
                             throws IdpStorageException,
                                    PasswordManagerException,
                                    DeviceFingerprintException,
                                    IdpNetworkException,
                                    IdpException

Parameters:

name - the name of the token Before creating the token, integrator has to make sure there is no existing token with the same token name.

configuration - see ProvisioningConfiguration

capability - see OathToken.TokenCapability

Returns:

the token, null if not found

Throws:

RootPolicyException - when the OtpConfiguration.TokenRootPolicy requires this exception to be thrown when the physical device is rooted.

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

IdpStorageException - when database operation failed, or when the name is already used by an existing token.

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

DeviceFingerprintException - when the fingerprint generated at runtime does not match the expected fingerprint.

IdpNetworkException - when network operation fails.

IdpRuntimeException - when this function is using unsupported provisioning protocol.

createToken

<T extends OathToken> T createToken(java.lang.String name,
                                    ProvisioningConfiguration configuration,
                                    DeviceFingerprintTokenPolicy fps)
                             throws IdpStorageException,
                                    PasswordManagerException,
                                    DeviceFingerprintException,
                                    IdpNetworkException,
                                    IdpException

Parameters:

name - the name of the token Before creating the token, integrator has to make sure there is no existing token with the same token name.

configuration - see ProvisioningConfiguration

fps - see DeviceFingerprintSource

Returns:

the token, null if not found

Throws:

RootPolicyException - when the OtpConfiguration.TokenRootPolicy requires this exception to be thrown when the physical device is rooted.

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

IdpStorageException - when database operation failed, or when the name is already used by an existing token.

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

DeviceFingerprintException - when the fingerprint generated at runtime does not match the expected fingerprint.

IdpNetworkException - when network operation fails.

IdpRuntimeException - when this function is using unsupported provisioning protocol.

createToken

<T extends OathToken> T createToken(java.lang.String name,
                                    ProvisioningConfiguration configuration,
                                    OathToken.TokenCapability capability,
                                    DeviceFingerprintTokenPolicy fps)
                             throws IdpStorageException,
                                    PasswordManagerException,
                                    DeviceFingerprintException,
                                    IdpNetworkException,
                                    IdpException

Gets capabilities of an existing token.

Parameters:

name - the name of the token Before creating the token, integrator has to make sure there is no existing token with the same token name.

configuration - see ProvisioningConfiguration

capability - see OathToken.TokenCapability

fps - see DeviceFingerprintSource

Returns:

the token, null if not found

Throws:

RootPolicyException - when the OtpConfiguration.TokenRootPolicy requires this exception to be thrown when the physical device is rooted.

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

IdpStorageException - when database operation failed, or when the name is already used by an existing token.

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

DeviceFingerprintException - when the fingerprint generated at runtime does not match the expected fingerprint.

IdpNetworkException - when network operation fails.

IdpRuntimeException - when this function is using unsupported provisioning protocol.

getTokenCapability

OathToken.TokenCapability getTokenCapability(java.lang.String name)
                                      throws IdpException

Gets capability of an existing token.

Parameters:

name - the name of the token

Returns:

TokenCapability the capability of the token

Throws:

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

IdpStorageException - when database operation failed.

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

createToken

void createToken(java.lang.String name,
                 ProvisioningConfiguration configuration,
                 DeviceFingerprintTokenPolicy fps,
                 TokenManager.TokenCreationCallback tokenCreationCallback)

Parameters:

name - the name of the token. Before creating the token, integrator has to make sure there is no existing token with the same token name.

configuration - the provisioning configuration, see ProvisioningConfiguration

fps - the device fingerprint source, see DeviceFingerprintSource

tokenCreationCallback - the callback to be invoked when error occurs or when token creation is completed. It cannot be null.

Throws:

ActivationException - when the activation code supplied on IdpCore.configure(byte[], IdpConfiguration...) or IdpCore.configure(boolean, byte[], IdpConfiguration...) does not have the white box cryptography feature turned on.

Since:

5.0

createToken

void createToken(java.lang.String name,
                 ProvisioningConfiguration configuration,
                 OathToken.TokenCapability capability,
                 DeviceFingerprintTokenPolicy fps,
                 TokenManager.TokenCreationCallback tokenCreationCallback)

Parameters:

name - the name of the token. Before creating the token, integrator has to make sure there is no existing token with the same token name.

configuration - the provisioning configuration, see ProvisioningConfiguration

capability - the token capability, see OathToken.TokenCapability

fps - the device fingerprint source, see DeviceFingerprintSource

tokenCreationCallback - the callback to be invoked when error occurs or when token creation is completed. It cannot be null.

Throws:

ActivationException - when the activation code supplied on IdpCore.configure(byte[], IdpConfiguration...) or IdpCore.configure(boolean, byte[], IdpConfiguration...) does not have the white box cryptography feature turned on.

Since:

5.0

createLowPlatformCouplingToken

void createLowPlatformCouplingToken(java.lang.String name,
                                    ProvisioningConfiguration configuration,
                                    TokenManager.TokenCreationCallback tokenCreationCallback)

To Creates a LowPlatformCoupling Token which is not affected by the changes in DeviceFingerprint. A LowPlatformCoupling Token only permits PIN mode. Token.upgradeToMultiAuthMode(PinAuthInput) call is not allowed.

Parameters:

name - the name of the token. Before creating the token, integrator has to make sure there is no existing token with the same token name.

configuration - the provisioning configuration, see ProvisioningConfiguration

tokenCreationCallback -

Since:

5.2.0