com.hidglobal.ia.service.transaction

Interface Container

public interface Container

Service container instance

Since:

2.0

Method Summary

Modifier and Type	Method and Description
Key	addKey(KeySpec keySpec, ProtectionPolicy protectionPolicy, char[] password) Adds a key to the container.
boolean	deleteKey(KeyId id, Parameter[] params) Deletes the key identified by its ID.
Key[]	findKeys(Parameter[] filter) Retrieves a key handle from the secure key store based on input parameter filter.
Date	getCreationDate() Gets the creation date for this container.
Date	getExpiryDate() Gets the expire date this container.
int	getId() Get the identifier of that container.
String	getName() Gets the Friendly Name associated with that container.
char[]	getProperty(String param) Returns container property.
ProtectionPolicy	getProtectionPolicy() Gets the protection policy associated with container.
Date	getRenewalDate() Gets the renewal date for this container.
String	getServerURL() Gets the server URL associated with that container.
String	getUserId() Gets the identifier of the user for this container.
boolean	isFIPSModeEnabled() Checks the container if FIPS strict mode is enforced.
boolean	isRenewable(char[] sessionPassword) Check if the container can be renewed
void	renew(ContainerRenewal config, char[] sessionPassword, EventListener eventListener)
char[][]	retrieveTransactionsIds(char[] sessionPassword, Parameter[] params) Retrieve a list of pending transaction IDs from the container.
void	setConnectionConfiguration(ConnectionConfiguration connectionConfiguration) Sets connection configuration.
void	setName(String name) Sets the Friendly Name associated with that container.
void	setProperty(String param, char[] value) Overrides a container property.

Method Detail

getId

int getId()

Get the identifier of that container.

Returns:

The identifier.

getServerURL

String getServerURL()

Gets the server URL associated with that container.

Returns:

The String URL.

getName

String getName()

Gets the Friendly Name associated with that container.

Returns:

The String name.

getUserId

String getUserId()

Gets the identifier of the user for this container.

Returns:

the identifier

getCreationDate

Date getCreationDate()

Gets the creation date for this container.

Returns:

the creation date

getExpiryDate

Date getExpiryDate()

Gets the expire date this container.

Returns:

the expire date

getRenewalDate

Date getRenewalDate()

Gets the renewal date for this container.

Returns:

the renewal date

isRenewable

boolean isRenewable(char[] sessionPassword)

Check if the container can be renewed

Parameters:

sessionPassword - transaction protection key password (can be null if not required by the policy)

Returns:

true if renewable.

renew

void renew(ContainerRenewal config,
           char[] sessionPassword,
           EventListener eventListener)
    throws PasswordExpiredException,
           UnsupportedDeviceException,
           InternalException,
           AuthenticationException,
           InvalidPasswordException,
           RemoteException,
           UnsafeDeviceException,
           ServerProtocolException,
           FingerprintAuthenticationRequiredException,
           FingerprintNotEnrolledException,
           LostCredentialsException,
           PasswordRequiredException,
           CredentialsExpiredException,
           ServerUnsupportedOperationException,
           GooglePlayServicesObsoleteException,
           PasswordCancelledException,
           ServerOperationFailedException

Parameters:

config - ContainerRenewal structure containing configuration

sessionPassword - transaction protection key password (can be null if not required by the policy)

eventListener - EventListener instance for progress messages and password prompt events.

Throws:

PasswordExpiredException - if expired password is given (changePassword required).

UnsupportedDeviceException - if device is not supported by policy.

InternalException - if an unexpected error occurred.

AuthenticationException - if password is incorrect.

InvalidPasswordException - if password validation fails.

RemoteException - if server responds with any other error.

UnsafeDeviceException - if the mobile is not protected by a password.

ServerProtocolException - if the server response provoked an unexpected error.

FingerprintAuthenticationRequiredException - if fingerprint authentication is required by policy.

FingerprintNotEnrolledException - if fingerprint enrollment is required.

LostCredentialsException - if provisioning key data has been corrupted or lost.

PasswordRequiredException - if required password was not provided and cached password is not available.

CredentialsExpiredException - if the transaction protection key is expired and renewal is not possible.

ServerUnsupportedOperationException - if the server does not support the operation requested.

GooglePlayServicesObsoleteException - if Google Play Services is out of date or not installed.

PasswordCancelledException - if the password prompt dialog has been cancelled by the user.

ServerOperationFailedException - if the server encounters a failure for the operation requested.

findKeys

Key[] findKeys(Parameter[] filter)
        throws LostCredentialsException,
               InternalException,
               UnsupportedDeviceException

Retrieves a key handle from the secure key store based on input parameter filter.

Parameters:

filter - Array of Parameter objects with key property name and value. The property name may be any of the following: HID_KEY_PROPERTY_USAGE HID_KEY_PROPERTY_LABEL HID_KEY_PROPERTY_CREATE HID_KEY_PROPERTY_EXPIRY

Returns:

Key array of matching key items

Throws:

LostCredentialsException - if provisioning key data has been corrupted or lost.

InternalException - if an unexpected error occurred.

UnsupportedDeviceException - if device is not supported by policy.

deleteKey

boolean deleteKey(KeyId id,
                  Parameter[] params)
           throws NotImplementedException

Deletes the key identified by its ID.

Parameters:

id - key identifier.

params - Array of Parameter objects for any additional parameters.

Returns:

true if deleteKey was successfully called.

Throws:

NotImplementedException - if the operation is not implemented and reserved for future use.

getProperty

char[] getProperty(String param)
            throws InternalException,
                   UnsupportedDeviceException,
                   InvalidPasswordException,
                   AuthenticationException,
                   LostCredentialsException,
                   FingerprintAuthenticationRequiredException,
                   FingerprintNotEnrolledException

Returns container property.

Parameters:

param - property name Supported property names: PROPERTY_CHANNEL PROPERTY_DOMAIN PROPERTY_APPCUSTOMIZATION PROPERTY_SERIALNUMBER PROPERTY_EXTERNALID PROPERTY_TXURI

Returns:

The property value

Throws:

InternalException - if an unexpected error occurred.

UnsupportedDeviceException - if device is not supported by policy.

InvalidPasswordException - if password validation fails.

AuthenticationException - if password is incorrect.

LostCredentialsException - if provisioning key data has been corrupted or lost.

FingerprintAuthenticationRequiredException - if fingerprint authentication is required by policy.

FingerprintNotEnrolledException - if fingerprint enrollment is required.

setProperty

void setProperty(String param,
                 char[] value)
          throws InternalException,
                 UnsupportedDeviceException,
                 LostCredentialsException,
                 AuthenticationException,
                 InvalidPasswordException,
                 FingerprintAuthenticationRequiredException,
                 FingerprintNotEnrolledException,
                 PasswordRequiredException

Overrides a container property.

Parameters:

param - property name. Supported property names: PROPERTY_TXURI

value - new value for property.

Throws:

InternalException - if an unexpected error occurred.

UnsupportedDeviceException - if device is not supported by policy.

LostCredentialsException - if provisioning key data has been corrupted or lost.

AuthenticationException - if password is incorrect.

InvalidPasswordException - if password validation fails.

FingerprintAuthenticationRequiredException - if fingerprint authentication is required by policy.

FingerprintNotEnrolledException - if fingerprint enrollment is required.

PasswordRequiredException - if required password was not provided and cached password is not available.

getProtectionPolicy

ProtectionPolicy getProtectionPolicy()
                              throws UnsupportedDeviceException,
                                     InternalException,
                                     LostCredentialsException

Gets the protection policy associated with container.

Returns:

the ProtectionPolicy used to protect the key

Throws:

UnsupportedDeviceException - if device is not supported by policy.

InternalException - if an unexpected error occurred.

LostCredentialsException - if provisioning key data has been corrupted or lost.

retrieveTransactionsIds

char[][] retrieveTransactionsIds(char[] sessionPassword,
                                 Parameter[] params)
                          throws RemoteException,
                                 InternalException,
                                 FingerprintAuthenticationRequiredException

Retrieve a list of pending transaction IDs from the container.

Parameters:

sessionPassword - transaction protection key password (can be null if not required by the policy)

params - Array of Parameters

Returns:

the ProtectionPolicy used to protect the key, nil if an error occurs.

Throws:

RemoteException - if server responds with any other error.

InternalException - if an unexpected error occurred.

FingerprintAuthenticationRequiredException - if fingerprint authentication is required by policy.

setConnectionConfiguration

void setConnectionConfiguration(ConnectionConfiguration connectionConfiguration)

Sets connection configuration.

Parameters:

connectionConfiguration - connection configuration

setName

void setName(String name)
      throws UnsupportedDeviceException,
             LostCredentialsException,
             AuthenticationException,
             InvalidPasswordException,
             InternalException,
             FingerprintAuthenticationRequiredException

Sets the Friendly Name associated with that container.

Parameters:

name - container friendly name.

Throws:

UnsupportedDeviceException - if device is not supported by policy.

LostCredentialsException - if provisioning key data has been corrupted or lost.

AuthenticationException - if password is incorrect.

InvalidPasswordException - if password validation fails.

InternalException - if an unexpected error occurred.

FingerprintAuthenticationRequiredException - if fingerprint authentication is required by policy.

isFIPSModeEnabled

boolean isFIPSModeEnabled()
                   throws InternalException

Checks the container if FIPS strict mode is enforced.

Returns:

Returns true if the FIPS strict mode is enabled.

Throws:

InternalException - if an unexpected error occurred.

addKey

Key addKey(KeySpec keySpec,
           ProtectionPolicy protectionPolicy,
           char[] password)
    throws InternalException,
           UnsupportedDeviceException,
           LostCredentialsException,
           AuthenticationException,
           InvalidPasswordException,
           FingerprintAuthenticationRequiredException,
           FingerprintNotEnrolledException,
           PasswordRequiredException

Adds a key to the container.

Parameters:

keySpec - The specification for the key.

protectionPolicy - The protection policy for that key.

password - The password protecting that key. It can be set to NULL if the protection policy does not require a password to be set.

Returns:

Key object

Throws:

InternalException - if an unexpected error occurred.

UnsupportedDeviceException - if device is not supported by policy.

LostCredentialsException - if provisioning key data has been corrupted or lost.

AuthenticationException - if password is incorrect.

InvalidPasswordException - if password validation fails.

FingerprintAuthenticationRequiredException - if fingerprint authentication is required by policy.

FingerprintNotEnrolledException - if fingerprint enrollment is required.

PasswordRequiredException - if required password was not provided and cached password is not available.