com.hidglobal.ia.service.transaction

Interface Device

public interface Device

Method Summary

Modifier and Type	Method and Description
Container	createContainer(ContainerInitialization config, char[] sessionPassword, EventListener listener) Creates the container.
Container	createContainer(ContainerInitialization config, EventListener listener) Deprecated.
void	deleteContainer(int containerId, char[] sessionPassword) Deletes a container identified by its ID.
Container[]	findContainers(Parameter[] filter) Retrieves a container based on input parameter filter.
ProtectionPolicy	getDefaultInitializationPolicy() Deprecated. This method is no longer recommended. Use EventListener instead.
char[]	getDeviceInfo(String param) Retrieves device information.
String	getVersion() Returns the version of the transaction processor client API.
boolean	reset(Parameter[] params) Deprecated. This method is no longer acceptable to delete the containers. Use com.hidglobal.ia.service.manager.DeviceFactory.reset(Context) instead.
Transaction	retrieveTransaction(char[] transactionId, char[] sessionPassword, Parameter[] params) Deprecated. This method is no longer acceptable to retrieve transaction. Use TransactionInfo.getTransaction(char[], Parameter[]) instead.
TransactionInfo	retrieveTransactionInfo(char[] transactionId) Retrieves a transaction info associated to that transaction id.
Transaction[]	searchTransactionHistory(char[] sessionPassword, TransactionFilter filter) Searches for transactions in the transaction history.
void	setConnectionConfiguration(ConnectionConfiguration connectionConfiguration) Sets connection configuration.
void	updateDeviceInfo(String name, char[] value, char[] sessionPassword, Parameter[] params) Updates device information.

Method Detail

retrieveTransaction

@Deprecated
Transaction retrieveTransaction(char[] transactionId,
                                             char[] sessionPassword,
                                             Parameter[] params)
                                      throws AuthenticationException,
                                             RemoteException,
                                             UnsupportedDeviceException,
                                             PasswordExpiredException,
                                             LostCredentialsException,
                                             InternalException,
                                             InvalidPasswordException,
                                             TransactionContainerInvalidException,
                                             TransactionExpiredException

Deprecated. This method is no longer acceptable to retrieve transaction. Use TransactionInfo.getTransaction(char[], Parameter[]) instead.

Retrieves a transaction associated with that transaction ID.

Parameters:

transactionId - transaction ID message received in push notification.

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

params - array of Parameter objects required to retrieve the transaction.

Returns:

a Transaction (Transaction) instance containing transaction details.

Throws:

AuthenticationException - if password is incorrect.

RemoteException - if server responds with any other error.

UnsupportedDeviceException - if device is not supported by policy.

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

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

InternalException - if an unexpected error occurred.

InvalidPasswordException - if password validation fails.

TransactionContainerInvalidException - if the transaction id refers to a container that does not exist.

TransactionExpiredException - if transaction has expired.

retrieveTransactionInfo

TransactionInfo retrieveTransactionInfo(char[] transactionId)
                                 throws InternalException,
                                        TransactionContainerInvalidException

Retrieves a transaction info associated to that transaction id.

Parameters:

transactionId - transaction id message received in push notification.

Returns:

a TransactionInfo (TransactionInfo) instance containing transaction details.

Throws:

InternalException - if an unexpected error occurred.

TransactionContainerInvalidException - if the transaction id refers to a container that does not exist.

updateDeviceInfo

void updateDeviceInfo(String name,
                      char[] value,
                      char[] sessionPassword,
                      Parameter[] params)
               throws UnsupportedDeviceException,
                      RemoteException,
                      AuthenticationException,
                      InvalidPasswordException,
                      InternalException,
                      LostCredentialsException,
                      FingerprintAuthenticationRequiredException,
                      FingerprintNotEnrolledException,
                      PasswordRequiredException

Updates device information.

Parameters:

name - name of property. Supported name attributes:

• DEVICE_INFO_PUSHID: update of the 'pushId', set up at provisioning and used by the server to notify the correct phone.

value - value of property.

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

params - array of Parameter objects.

Throws:

UnsupportedDeviceException - if device is not supported by policy.

RemoteException - if server responds with any other error.

AuthenticationException - if password is incorrect.

InvalidPasswordException - if password validation fails.

InternalException - if an unexpected error occurred.

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

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.

getDeviceInfo

char[] getDeviceInfo(String param)
              throws UnsupportedDeviceException,
                     InternalException

Retrieves device information.

Parameters:

param - deviceInfo property to retrieve. Supported property names: DEVICE_INFO_BRAND DEVICE_INFO_KEYSTORE DEVICE_INFO_LOCALE DEVICE_INFO_MANUFACTURER DEVICE_INFO_MODEL DEVICE_INFO_NAME DEVICE_INFO_OS DEVICE_INFO_OS_VERSION DEVICE_INFO_OS_NAME DEVICE_INFO_PRODUCT

Returns:

the device property value.

Throws:

UnsupportedDeviceException - if device is not supported by policy.

InternalException - if an unexpected error occurred.

getVersion

String getVersion()

Returns the version of the transaction processor client API.

Returns:

version of the SDK version number.

findContainers

Container[] findContainers(Parameter[] filter)
                    throws InternalException,
                           UnsupportedDeviceException,
                           AuthenticationException,
                           InvalidPasswordException,
                           FingerprintAuthenticationRequiredException,
                           FingerprintNotEnrolledException

Retrieves a container based on input parameter filter.

Parameters:

filter - array of Parameter objects required to specify container Filter can indicate: CONTAINER_NAME: Friendly Name of the container. CONTAINER_URL: URL of server associated with the container. CONTAINER_USERID: User identifier of the container. CONTAINER_EXPIRY_DATE: Container expiration date. CONTAINER_CREATION_DATE: Container creation date.

Returns:

list of containers.

Throws:

InternalException - if an unexpected error occurred.

UnsupportedDeviceException - if device is not supported by policy.

AuthenticationException - if password is incorrect.

InvalidPasswordException - if password validation fails.

FingerprintAuthenticationRequiredException - if fingerprint authentication is required by policy.

FingerprintNotEnrolledException - if fingerprint enrollment is required.

createContainer

Container createContainer(ContainerInitialization config,
                          char[] sessionPassword,
                          EventListener listener)
                   throws UnsupportedDeviceException,
                          InternalException,
                          AuthenticationException,
                          InvalidPasswordException,
                          RemoteException,
                          UnsafeDeviceException,
                          ServerProtocolException,
                          FingerprintAuthenticationRequiredException,
                          FingerprintNotEnrolledException,
                          GooglePlayServicesObsoleteException,
                          PasswordCancelledException,
                          ServerOperationFailedException

Creates the container.

Parameters:

config - initialization configuration see ContainerInitialization for details

listener - An EventListener implementation to which to report status information or receive password request events.

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

Returns:

the container

Throws:

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.

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.

createContainer

@Deprecated
Container createContainer(ContainerInitialization config,
                                       EventListener listener)
                                throws UnsupportedDeviceException,
                                       InternalException,
                                       AuthenticationException,
                                       InvalidPasswordException,
                                       RemoteException,
                                       UnsafeDeviceException,
                                       ServerProtocolException,
                                       FingerprintAuthenticationRequiredException,
                                       FingerprintNotEnrolledException,
                                       GooglePlayServicesObsoleteException,
                                       PasswordCancelledException,
                                       ServerOperationFailedException

Deprecated.

Creates the container.

Parameters:

config - initialization configuration see ContainerInitialization for details

listener - An EventListener implementation to which to report status information or receive password request events.

Returns:

the container

Throws:

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.

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.

deleteContainer

void deleteContainer(int containerId,
                     char[] sessionPassword)
              throws InternalException,
                     AuthenticationException,
                     PasswordExpiredException

Deletes a container identified by its ID. The method notifies the server the container is deleted, thus requires the device to be online.

Parameters:

containerId - id of container.

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

Throws:

InternalException - if an unexpected error occurred.

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

AuthenticationException - if password is incorrect.

reset

@Deprecated
boolean reset(Parameter[] params)
                    throws InternalException

Deprecated. This method is no longer acceptable to delete the containers. Use com.hidglobal.ia.service.manager.DeviceFactory.reset(Context) instead.

Deletes containers and keys contained in the device.

Parameters:

params - array of Parameter objects

Returns:

true if successful.

Throws:

InternalException - if an unexpected error occurred.

searchTransactionHistory

Transaction[] searchTransactionHistory(char[] sessionPassword,
                                       TransactionFilter filter)
                                throws NotImplementedException

Searches for transactions in the transaction history.

Parameters:

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

filter - TransactionFilter.

Returns:

The list of transactions.

Throws:

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

getDefaultInitializationPolicy

@Deprecated
ProtectionPolicy getDefaultInitializationPolicy()
                                                      throws InternalException

Deprecated. This method is no longer recommended. Use EventListener instead.

Retrieves the initialization password policy for the device.

Returns:

ProtectionPolicy initialization password policy.

Throws:

InternalException - if an unexpected error occurred.

setConnectionConfiguration

void setConnectionConfiguration(ConnectionConfiguration connectionConfiguration)

Sets connection configuration.

Parameters:

connectionConfiguration - configuration, see ConnectionConfiguration for details.