	RSA BSAFE CERT-J	Certificate Management Components for Java
	Javadoc

PKIResult Class Reference

This class captures information returned from a PKI request message that has been sent over HTTP.

The sendMessage SPI method in the PKIInterface class returns a PKIResult object. The information includes the status of the transaction, whether it succeeded or failed, and the actual message received.

List of all members.

Public Methods

PKIResult (PKIStatusInfo statusInfo)

Constructs a PKIResult object for a transaction when no response message is received. More...

PKIResult (PKIStatusInfo statusInfo, byte[] encodedResponse)

Constructs a PKIResult object for a transaction when a response message is received. More...

PKIStatusInfo PKIResult:: getStatusInfo ()

Returns a PKIStatusInfo object that contains the status of a PKI transaction. More...

byte [] PKIResult:: getEncodedResponse ()

Returns an encoded response message that was received. More...

Constructor & Destructor Documentation

PKIResult::PKIResult ( PKIStatusInfo statusInfo ) [inline];

Constructs a PKIResult object for a transaction when no response message is received. The status of the transaction result is provided in statusInfo.
Parameters:

statusInfo A PKIStatusInfo object indicating the status of a PKI transaction.

PKIResult::PKIResult ( PKIStatusInfo statusInfo,

byte encodedResponse[]

) [inline];

Constructs a PKIResult object for a transaction when a response message is received. The status of the transaction result is contained in statusInfo and the actual response message received is provided in encodedResponse.
Parameters:

statusInfo A PKIStatusInfo indicating the status of a PKI transaction.

encodedResponse A byte array that contains the received message.

Member Function Documentation

byte [] PKIResult::getEncodedResponse ( ) [inline];

Returns an encoded response message that was received. If a transaction error has occured and no response message was received, it returns null.

Returns:
A byte array that contains the encoded message received.

PKIStatusInfo PKIResult::getStatusInfo ( ) [inline];

Returns a PKIStatusInfo object that contains the status of a PKI transaction.

Returns:
A PKIStatusInfo object indicating the status of a PKI transaction.

Public Methods
	PKIResult (PKIStatusInfo statusInfo)
	Constructs a `PKIResult` object for a transaction when no response message is received. More...
	PKIResult (PKIStatusInfo statusInfo, byte[] encodedResponse)
	Constructs a `PKIResult` object for a transaction when a response message is received. More...
PKIStatusInfo PKIResult::	getStatusInfo ()
	Returns a `PKIStatusInfo` object that contains the status of a PKI transaction. More...
byte [] PKIResult::	getEncodedResponse ()
	Returns an encoded response message that was received. More...