com.gemalto.idp.mobile.otp.vic

Interface VicTokenManager

All Superinterfaces:

TokenManager

public interface VicTokenManager
extends TokenManager

VicTokenManager 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
<T extends VicToken> T	createToken(java.lang.String name, ProvisioningConfiguration configuration)
<T extends VicToken> T	createToken(java.lang.String name, ProvisioningConfiguration configuration, DeviceFingerprintTokenPolicy fps)
<T extends VicToken> T	getToken(java.lang.String name) Gets an existing token.
<T extends VicToken> T	getToken(java.lang.String name, byte[] fingerPrintCustomData) Gets an existing token.

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

getTokenNames, removeToken, removeToken

Method Detail

getToken

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

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.

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)

getToken

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

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.

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.

createToken

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

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:

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 there is an error during network operation.

createToken

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

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

Returns:

the token, null if not found.

Throws:

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 there is an error during network operation.