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

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

Inheritance diagram for com.hidglobal.ia.service.transaction.Transaction:

Public Member Functions
String	getAction ()
String []	getAllowedStatuses ()
Key	getSigningKey () throws InternalException, UnsupportedDeviceException, UnsafeDeviceException
boolean	setStatus (String status, char[] signingPassword, char[] sessionPassword, Parameter[] param) throws AuthenticationException, PasswordExpiredException, TransactionExpiredException, ServerVersionException, UnsupportedDeviceException, RemoteException, LostCredentialsException, InternalException, PasswordRequiredException, FingerprintAuthenticationRequiredException,ServerAuthenticationException, ServerOperationFailedException, InvalidParameterException
Public Member Functions inherited from com.hidglobal.ia.service.transaction.ServerAction
Date	getDate ()
Date	getExpiryDate ()
String	getPayload ()
String	toString ()

Detailed Description

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

Member Function Documentation

getAction()

String com.hidglobal.ia.service.transaction.Transaction.getAction

(

)

Returns the nature of the action.

Returns

SDKConstants.ACTION_TRANSACTION

Implements com.hidglobal.ia.service.transaction.ServerAction.

getAllowedStatuses()

String [] com.hidglobal.ia.service.transaction.Transaction.getAllowedStatuses

(

)

Returns a list of status (for instance "accept", "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

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

getSigningKey()

Key com.hidglobal.ia.service.transaction.Transaction.getSigningKey

(

)

throws InternalException, UnsupportedDeviceException, UnsafeDeviceException

Gets the Signing Key object associated with that transaction.

Returns

the key

Exceptions

InternalException	if an unexpected error occurred.
UnsupportedDeviceException	if device is not supported by policy.
UnsafeDeviceException	if the mobile is not protected by a password.

setStatus()

boolean com.hidglobal.ia.service.transaction.Transaction.setStatus	(	String	status,
		char []	signingPassword,
		char []	sessionPassword,
		Parameter []	param
	)		throws AuthenticationException, PasswordExpiredException, TransactionExpiredException, ServerVersionException, UnsupportedDeviceException, RemoteException, LostCredentialsException, InternalException, PasswordRequiredException, FingerprintAuthenticationRequiredException,ServerAuthenticationException, ServerOperationFailedException, InvalidParameterException

Communicates the status and context information of this transaction along with cryptographic signature.

Parameters

status	status to apply to transaction with signature. The status must be one of the statuses returned by the getAllowedStatuses() method.
signingPassword	the password protecting the signature key. (can be null if not required by the policy)
sessionPassword	transaction protection key password (can be null if not required by the policy)
param	array of Parameter objects

Parameter can be defined with following id:

• SDKConstants.PARAM_TX_MOBILE_CONTEXT: Optional mobile context data (expected base64, max 1000 characters)

Returns

boolean true if successful.

Exceptions

AuthenticationException	if password is incorrect.
PasswordExpiredException	if expired password is given (changePassword required).
TransactionExpiredException	if transaction has expired.
ServerVersionException	if server version does not support client operation.
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.
InvalidParameterException	if the given parameters are invalid or required parameters are missing.
UnsupportedDeviceException	if device is not supported by policy.

See also

Container#findKeys(Parameter[])

ServerActionInfo::getProtectionKey()

Transaction::getSigningKey()