	RSA BSAFE CERT-J	Certificate Management Components for Java
	Javadoc

PKIResponseMessage Class Reference

This class is a subclass of PKIMessage that is specific to PKI certification-response messages.

It captures information received from a PKI service provider.

Note: Objects that are passed to a constructor or method of this class, or returned from a method of this class, are shared. No copy is made. If a copy is needed, make a copy of the object either before passing it to a constructor or method of this class, or after getting it from a method of this class.

Inheritance diagram for PKIResponseMessage:

List of all members.

Public Methods
	PKIResponseMessage (PKIStatusInfo statusInfo)
	Constructs a `PKIResponseMessage` object for the response status information given in statusInfo. More...
PKIStatusInfo PKIResponseMessage::	getStatusInfo ()
	Returns the status information of this response message. More...
Certificate PKIResponseMessage::	getCertificate ()
	Returns the certificate requested and received in the response message. More...
void PKIResponseMessage::	setCertificate (Certificate certificate)
	Stores the certificate in this object. More...
JSAFE_PrivateKey PKIResponseMessage::	getPrivateKey ()
	Returns the private key received in the response message. More...
void PKIResponseMessage::	setPrivateKey (JSAFE_PrivateKey privateKey)
	Stores the privateKey in this object. More...
Properties PKIResponseMessage::	getRegInfo ()
	Returns the registration information returned by the PKI server. More...
void PKIResponseMessage::	setRegInfo (Properties regInfo)
	Stores the regInfo in this object. More...
Certificate [] PKIResponseMessage::	getCACerts ()
	Returns the CA certificates received with the response message. More...
void PKIResponseMessage::	setCACerts (Certificate[] caCerts)
	Stores the caCerts in this object. More...

Constructor & Destructor Documentation

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

Constructs a PKIResponseMessage object for the response status information given in statusInfo. See the documentation on the PKIStatusInfo class and the PKIMessage constructor for more information about status and the contents of the response object. To examine the contents of the PKIResponseMessage object, use the get* methods of this class. To populate this object with the necessary information, use the setCertificate, setPrivateKey, setRegInfo, and setCACerts methods of this class.
Parameters:

statusInfo A PKIStatusInfo indicating the status of the response message.

See also:
setCertificate , setPrivateKey , setRegInfo , setCACerts , com.rsa.certj.spi.pki.PKIMessagePKIMessage

Member Function Documentation

Certificate [] PKIResponseMessage::getCACerts ( ) [inline];

Returns the CA certificates received with the response message.

Returns:
A Certificate array that contains CA certificates returned.

Certificate PKIResponseMessage::getCertificate ( ) [inline];

Returns the certificate requested and received in the response message.

Returns:
A Certificate that was requested.

JSAFE_PrivateKey PKIResponseMessage::getPrivateKey ( ) [inline];

Returns the private key received in the response message. Some PKI services can generate the keypair on behalf of the sender. In such cases, the private key will be returned in the response message.

Returns:
A JSAFE_PrivateKey returned in the response message.

Properties PKIResponseMessage::getRegInfo ( ) [inline];

Returns the registration information returned by the PKI server.

Returns:
A Properties object indicating the registration information.

PKIStatusInfo PKIResponseMessage::getStatusInfo ( ) [inline];

Returns the status information of this response message.

Returns:
A PKIStatusInfo object indicating the status of the response message.

void PKIResponseMessage::setCACerts ( Certificate caCerts[] ) [inline];

Stores the caCerts in this object.
Parameters:

caCerts An array of Certificate objects to associate with this reponse object.

void PKIResponseMessage::setCertificate ( Certificate certificate ) [inline];

Stores the certificate in this object.
Parameters:

certificate A Certificate to associate with this reponse object.

void PKIResponseMessage::setPrivateKey ( JSAFE_PrivateKey privateKey ) [inline];

Stores the privateKey in this object.
Parameters:

privateKey A JSAFE_PrivateKey to associate with this reponse object.

void PKIResponseMessage::setRegInfo ( Properties regInfo ) [inline];

Stores the regInfo in this object.
Parameters:

regInfo A Properties object to associate with this reponse object.

PKIResponseMessage Class Reference

Public Methods

Constructor & Destructor Documentation

Member Function Documentation