com.rsa.certj.spi.pki

Class PKIRequestMessage

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

Direct Known Subclasses:

com.rsa.certj.provider.pki.cmp.CMPRequestCommon

public class PKIRequestMessage

extends PKIMessage

This class is a subclass of PKIMessage that represents certification-request messages. It contains the PKI message information that is specific to PKI certification-request messages. Note that not all of the fields of the class are used by every service provider.

Note: Objects that are passed to a constructor or method 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.

Field Summary

static int	PKI_POP_ENCRYPTION Indicates that proof-of-possession is provided by encrypted data.
static int	PKI_POP_KEY_AGREE Indicates that proof-of-possession is provided by key agreement.
static int	PKI_POP_RA_VERIFIED Indicates that proof-of-possession is verified by a registration authority.
static int	PKI_POP_SIGNATURE Indicates that proof-of-possession is provided by signature.

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

PKIRequestMessage(Certificate certificateTemplate, Properties regInfo)

Constructs a PKIRequestMessage object for requesting a certificate.

Method Summary

Certificate	getCertificateTemplate() Returns a template for the contents of the new certificate, which specifies the fields that you want the new certificate to have.
int	getPopType() Returns the type of proof-of-possession (POP) information to be included in the certification request message.
Properties	getRegInfo() Returns supplementary information that is required to fulfill a certification request.
void	setPopType(int popType) Sets the type of proof-of-possession (POP) information to be included in the certification request message to popType.

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

Field Detail

PKI_POP_RA_VERIFIED

public static final int PKI_POP_RA_VERIFIED

Indicates that proof-of-possession is verified by a registration authority.

PKI_POP_SIGNATURE

public static final int PKI_POP_SIGNATURE

Indicates that proof-of-possession is provided by signature.

PKI_POP_ENCRYPTION

public static final int PKI_POP_ENCRYPTION

Indicates that proof-of-possession is provided by encrypted data.

PKI_POP_KEY_AGREE

public static final int PKI_POP_KEY_AGREE

Indicates that proof-of-possession is provided by key agreement.

Constructor Detail

PKIRequestMessage

public PKIRequestMessage(Certificate certificateTemplate,
                         Properties regInfo)

Constructs a PKIRequestMessage object for requesting a certificate. The template in certificateTemplate specifies the fields that the new certificate should have. The registration information provided in regInfo must comply with the requirements of the PKI server provider for the request to be successful.

Parameters

	certificateTemplate		A Certificate indicating the fields the new certificate should have. For example, the template could contain the subject name that should be used in the new certificate and the public key for which the new certificate should be issued.
	regInfo		A Properties object holding supplementary information required to fulfill a certification request. This information could include contact information, billing information, or other ancillary information used to fulfill the certification request. The kind of information that should be provided in regInfo is specific to the requirements of a particular PKI server provider.

See Also

setPopType(int)

PKIMessage.PKIMessage()

Method Detail

getPopType

public int getPopType()

Returns the type of proof-of-possession (POP) information to be included in the certification request message. The choices of values for this field are PKI_POP_RA_VERIFIED, PKI_POP_SIGNATURE, PKI_POP_ENCRYPTION, and PKI_POP_KEY_AGREE. These values were previously defined in this class.

Returns

An int value indicating the POP type of this object.

setPopType

public void setPopType(int popType)

Sets the type of proof-of-possession (POP) information to be included in the certification request message to popType. The choices of values for this field are PKI_POP_RA_VERIFIED, PKI_POP_SIGNATURE, PKI_POP_ENCRYPTION, and PKI_POP_KEY_AGREE. These values were previously defined in this class.

Parameters

popType

An int value indicating the POP type of this object.

getCertificateTemplate

public Certificate getCertificateTemplate()

Returns a template for the contents of the new certificate, which specifies the fields that you want the new certificate to have. For example, the template could contain the subject name that should be used in the new certificate and the public key for which the certificate should be issued.

Returns

A Certificate that contains selected fields of the certificate to be requested.

getRegInfo

public Properties getRegInfo()

Returns supplementary information that is required to fulfill a certification request. This information could include contact information, billing information, or other ancillary information useful to the fulfillment of the certification request.

Returns

A Properties object that contains registration information.