com.rsa.certj.spi.pki

Class PKIResponseMessage

java.lang.Object
  |
  +--com.rsa.certj.spi.pki.PKIMessage
        |
        +--com.rsa.certj.spi.pki.PKIResponseMessage

Direct Known Subclasses:

CMPResponseCommon

public class PKIResponseMessage

extends PKIMessage

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.

Copyright © RSA Security Inc., 1999-2001. All rights reserved.

Fields inherited from class com.rsa.certj.spi.pki.PKIMessage

WRAP_ENVELOPE, WRAP_ENVELOPE_THEN_SIGN, WRAP_NONE, WRAP_SIGN, WRAP_SIGN_THEN_ENVELOPE

Constructor Summary

PKIResponseMessage(PKIStatusInfo statusInfo)

Constructs a PKIResponseMessage object for the response status information given in statusInfo.

Method Summary

Certificate[]	getCACerts() Returns the CA certificates received with the response message.
Certificate	getCertificate() Returns the certificate requested and received in the response message.
com.rsa.jsafe.JSAFE_PrivateKey	getPrivateKey() Returns the private key received in the response message.
Properties	getRegInfo() Returns the registration information returned by the PKI server.
PKIStatusInfo	getStatusInfo() Returns the status information of this response message.
void	setCACerts(Certificate[] caCerts) Stores the caCerts in this object.
void	setCertificate(Certificate certificate) Stores the certificate in this object.
void	setPrivateKey(com.rsa.jsafe.JSAFE_PrivateKey privateKey) Stores the privateKey in this object.
void	setRegInfo(Properties regInfo) Stores the regInfo in this object.

Methods inherited from class com.rsa.certj.spi.pki.PKIMessage

getEncryptionName, getEncryptionParams, getExtraCerts, getExtraCRLs, getFreeText, getMessageTime, getProviderData, getRecipient, getSender, getTransactionID, getVersion, getWrapType, setExtraCerts, setExtraCRLs, setFreeText, setMessageTime, setProviderData, setTransactionID, setVersion, setWrapInfo

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PKIResponseMessage

public PKIResponseMessage(PKIStatusInfo statusInfo)

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(com.rsa.certj.cert.Certificate)

setPrivateKey(com.rsa.jsafe.JSAFE_PrivateKey)

setRegInfo(java.util.Properties)

setCACerts(com.rsa.certj.cert.Certificate[])

PKIMessage.PKIMessage()

Method Detail

getStatusInfo

public PKIStatusInfo getStatusInfo()

Returns the status information of this response message.

Returns

A PKIStatusInfo object indicating the status of the response message.

getCertificate

public Certificate getCertificate()

Returns the certificate requested and received in the response message.

Returns

A Certificate that was requested.

setCertificate

public void setCertificate(Certificate certificate)

Stores the certificate in this object.

Parameters

certificate

A Certificate to associate with this reponse object.

getPrivateKey

public com.rsa.jsafe.JSAFE_PrivateKey getPrivateKey()

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.

setPrivateKey

public void setPrivateKey(com.rsa.jsafe.JSAFE_PrivateKey privateKey)

Stores the privateKey in this object.

Parameters

privateKey

A JSAFE_PrivateKey to associate with this reponse object.

getRegInfo

public Properties getRegInfo()

Returns the registration information returned by the PKI server.

Returns

A Properties object indicating the registration information.

setRegInfo

public void setRegInfo(Properties regInfo)

Stores the regInfo in this object.

Parameters

regInfo

A Properties object to associate with this reponse object.

getCACerts

public Certificate[] getCACerts()

Returns the CA certificates received with the response message.

Returns

A Certificate array that contains CA certificates returned.

setCACerts

public void setCACerts(Certificate[] caCerts)

Stores the caCerts in this object.

Parameters

caCerts

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