com.hidglobal.ia.service.transaction.Device Interface Reference

Parent device object used to query device information and discover any active containers. More...

Public Member Functions
Container	createContainer (ContainerInitialization config, char[] sessionPassword, EventListener listener) throws UnsupportedDeviceException, InternalException, AuthenticationException, InvalidPasswordException, RemoteException, UnsafeDeviceException, ServerProtocolException, FingerprintAuthenticationRequiredException, FingerprintNotEnrolledException, GooglePlayServicesObsoleteException, PasswordCancelledException, ServerOperationFailedException, InvalidParameterException
void	deleteContainer (int containerId, char[] sessionPassword) throws InternalException, AuthenticationException, PasswordExpiredException, InvalidParameterException
void	deleteContainer (int containerId, char[] sessionPassword, String reason) throws InternalException, AuthenticationException, PasswordExpiredException, InvalidParameterException
Container []	findContainers (Parameter[] filter) throws InternalException, UnsupportedDeviceException, InvalidParameterException
char []	getDeviceInfo (String param) throws UnsupportedDeviceException, InternalException, InvalidParameterException
String	getVersion ()
ServerActionInfo	retrieveActionInfo (char[] actionId, char[] userId) throws InternalException, InvalidContainerException, InvalidParameterException, InexplicitContainerException
ServerActionInfo	retrieveActionInfo (char[] actionId) throws InternalException, InvalidContainerException, InvalidParameterException, InexplicitContainerException
void	setConnectionConfiguration (ConnectionConfiguration connectionConfiguration) throws InvalidParameterException

Detailed Description

Parent device object used to query device information and discover any active containers.

Member Function Documentation

createContainer()

Container com.hidglobal.ia.service.transaction.Device.createContainer	(	ContainerInitialization	config,
		char []	sessionPassword,
		EventListener	listener
	)		throws UnsupportedDeviceException, InternalException, AuthenticationException, InvalidPasswordException, RemoteException, UnsafeDeviceException, ServerProtocolException, FingerprintAuthenticationRequiredException, FingerprintNotEnrolledException, GooglePlayServicesObsoleteException, PasswordCancelledException, ServerOperationFailedException, InvalidParameterException

Triggers the container activation process to create a new container.

Parameters

config	ContainerInitialization structure containing configuration for initialization.
sessionPassword	transaction protection key password (can be null if not required by the policy).
listener	An EventListener implementation to which to report status information or receive password request events.

Returns

the new container instance.

Exceptions

UnsupportedDeviceException	if device is not supported by policy.
InternalException	if an unexpected error occurred.
AuthenticationException	if password is incorrect.
InvalidPasswordException	if new container/key password is not accepted by the protection policy.
RemoteException	if server responds with any other error.
UnsafeDeviceException	if the mobile is not protected by a password.
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 canceled by the user.
ServerOperationFailedException	if the server encounters a failure for the operation requested.
InvalidParameterException	if an incorrect parameter is detected

deleteContainer() [1/2]

void com.hidglobal.ia.service.transaction.Device.deleteContainer	(	int	containerId,
		char []	sessionPassword
	)		throws InternalException, AuthenticationException, PasswordExpiredException, InvalidParameterException

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).

Exceptions

InternalException	if an unexpected error occurred.
PasswordExpiredException	if expired password is given (changePassword required).
AuthenticationException	if password is incorrect.
InvalidParameterException	if an incorrect parameter is detected

Deprecated:

Deprecated in SDK 6.0. Use [}.

deleteContainer() [2/2]

void com.hidglobal.ia.service.transaction.Device.deleteContainer	(	int	containerId,
		char []	sessionPassword,
		String	reason
	)		throws InternalException, AuthenticationException, PasswordExpiredException, InvalidParameterException

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).
reason	Optional message defining the reason for deletion for audit (default USER) (expected max 1000 characters)

Exceptions

InternalException	if an unexpected error occurred.
PasswordExpiredException	if expired password is given (changePassword required).
AuthenticationException	if password is incorrect.
InvalidParameterException	if the given parameters are invalid or required parameters are missing.

findContainers()

Container [] com.hidglobal.ia.service.transaction.Device.findContainers

(

Parameter []

filter

)

throws InternalException, UnsupportedDeviceException, InvalidParameterException

Retrieves a container based on input parameter filter.

Parameters

filter

param array of Parameter objects required to specify container

Filter parameter can be defined with following id:

• SDKConstants.CONTAINER_NAME: Friendly Name of the container.
• SDKConstants.CONTAINER_URL: URL of server associated with the container.
• SDKConstants.CONTAINER_USERID: User identifier of the container.

Returns

list of containers.

Exceptions

InternalException	if an unexpected error occurred.
UnsupportedDeviceException	if device is not supported by policy.
InvalidParameterException	if the given parameters are invalid or required parameters are missing.

getDeviceInfo()

char [] com.hidglobal.ia.service.transaction.Device.getDeviceInfo

(

String

param

)

throws UnsupportedDeviceException, InternalException, InvalidParameterException

Retrieves device information.

Parameters

param

deviceInfo property to retrieve.

Supported property parameter names:

• SDKConstants.DEVICE_INFO_BRAND
• SDKConstants.DEVICE_INFO_KEYSTORE
• SDKConstants.DEVICE_INFO_LOCALE
• SDKConstants.DEVICE_INFO_MANUFACTURER
• SDKConstants.DEVICE_INFO_MODEL
• SDKConstants.DEVICE_INFO_NAME
• SDKConstants.DEVICE_INFO_OS
• SDKConstants.DEVICE_INFO_OS_VERSION
• SDKConstants.DEVICE_INFO_OS_NAME
• SDKConstants.DEVICE_INFO_PRODUCT
• SDKConstants.DEVICE_INFO_FPENROLLED
• SDKConstants.DEVICE_INFO_FPCAPABLE
• SDKConstants.DEVICE_INFO_ISROOTED

Returns

the device property value.

Exceptions

UnsupportedDeviceException	if device is not supported by policy.
InternalException	if an unexpected error occurred.
InvalidParameterException	if the given parameters are invalid or required parameters are missing.

getVersion()

String com.hidglobal.ia.service.transaction.Device.getVersion

(

)

Returns the version of the transaction processor client API.

Returns

version of the SDK version number.

retrieveActionInfo() [1/2]

ServerActionInfo com.hidglobal.ia.service.transaction.Device.retrieveActionInfo	(	char []	actionId,
		char []	userId
	)		throws InternalException, InvalidContainerException, InvalidParameterException, InexplicitContainerException

Retrieves and decrypts an encrypted "server action" message received from the server.

Parameters

actionId	action ID message received in push notification, scan to approve or via Container.retrieveTransactionsIds()
userId	user identifier of the container to be used to retrieve action info from. ( Optional )

Returns

a ServerActionInfo instance containing transaction details.

Exceptions

InternalException	if an unexpected error occurred.
InvalidContainerException	if the action id refers to a container that does not exist.
InvalidParameterException	if the given parameters are invalid or required parameters are missing.
InexplicitContainerException	if the action id cannot determine which container to apply. Invoke retrieveActionInfo with 'UserId' parameter.

retrieveActionInfo() [2/2]

ServerActionInfo com.hidglobal.ia.service.transaction.Device.retrieveActionInfo

(

char []

actionId

)

throws InternalException, InvalidContainerException, InvalidParameterException, InexplicitContainerException

Retrieves and decrypts an encrypted "server action" message received from the server.

Parameters

actionId

action ID message received in push notification, scan to approve or via Container.retrieveTransactionsIds()

Returns

a ServerActionInfo instance containing transaction details.

Exceptions

InternalException	if an unexpected error occurred.
InvalidContainerException	if the action id refers to a container that does not exist.
InvalidParameterException	if the given parameters are invalid or required parameters are missing.
InexplicitContainerException	if the action id cannot determine which container to apply. Invoke retrieveActionInfo with 'UserId' parameter.

setConnectionConfiguration()

void com.hidglobal.ia.service.transaction.Device.setConnectionConfiguration

(

ConnectionConfiguration

connectionConfiguration

)

throws InvalidParameterException

Sets connection configuration.

Parameters

connectionConfiguration

configuration, see ConnectionConfiguration for details.

Exceptions

InvalidParameterException

if the given parameters are invalid or required parameters are missing.