com.hidglobal.ia.service.transaction

Interface Transaction

public interface Transaction

Encapsulates a transaction and exposes an API to apply an action status.

Method Summary

Modifier and Type	Method and Description
String[]	getAllowedStatuses() Returns a list of status names (for instance approve, deny, report) that can be set for that transaction.
Date	getDate() Returns the status change date for the transaction
Key	getSigningKey() Gets the Signing Key object associated with that transaction.
boolean	setStatus(String status, char[] signingPassword, char[] sessionPassword, Parameter[] param) Communicates the status of this transaction using provided key identifier.
String	toString() Returns the transaction text to be displayed to the user.

Method Detail

setStatus

boolean setStatus(String status,
                  char[] signingPassword,
                  char[] sessionPassword,
                  Parameter[] param)
           throws AuthenticationException,
                  PasswordExpiredException,
                  TransactionExpiredException,
                  ServerVersionException,
                  RemoteException,
                  LostCredentialsException,
                  InternalException,
                  PasswordRequiredException,
                  FingerprintAuthenticationRequiredException,
                  ServerAuthenticationException,
                  ServerOperationFailedException

Communicates the status of this transaction using provided key identifier. The status must be one of the statuses returned by the getAllowedStatuses() method.

Parameters:

status - status to apply to transaction with signature.

signingPassword - the password protecting the signature key. Pass null if the key is not password protected.

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

param - reserved for future use

Returns:

boolean true if successful.

Throws:

AuthenticationException - if password is incorrect.

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

TransactionExpiredException - if transaction has expired.

ServerVersionException - if server version is not supported by the client.

RemoteException - if server responds with any other error.

LostCredentialsException - if device key has been lost. A new provisioning is needed.

InternalException - if an unexpected error occurred.

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

FingerprintAuthenticationRequiredException - if fingerprint authentication is required by policy.

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

ServerAuthenticationException - if the transaction protection key is not rejected by the server.

See Also:

TransactionInfo.getTransactionProtectionKey(), getSigningKey()

getAllowedStatuses

String[] getAllowedStatuses()

Returns a list of status names (for instance approve, deny, report) that can be set for that transaction. The values are retrieved from the transaction response message sent back by the server. The returned names can be used by the calling application to look up the corresponding value in a name, value pair resource files for customization/localization of displayed text to user.

Returns:

the String array contains the possible status values to be used with setStatus.

See Also:

setStatus(String, char[], char[], Parameter[])

toString

String toString()

Returns the transaction text to be displayed to the user.

Overrides:

toString in class Object

Returns:

Transaction text string.

See Also:

Object.toString()

getDate

Date getDate()

Returns the status change date for the transaction

Returns:

the status change date for the transaction

getSigningKey

Key getSigningKey()
           throws InternalException,
                  UnsupportedDeviceException,
                  UnsafeDeviceException

Gets the Signing Key object associated with that transaction.

Returns:

the signing key object associated to that transaction

Throws:

InternalException - if an unexpected error occurred.

UnsupportedDeviceException - if device is not supported by policy.

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