com.entrust.toolkit.asn1.crmf

Class CertReqMsg

java.lang.Object

com.entrust.toolkit.asn1.crmf.CertReqMsg

All Implemented Interfaces:

ASN1Type

public class CertReqMsg
extends java.lang.Object
implements ASN1Type

This class implements the CertReqMsg structure as defined in the CRMF specification.

 CertReqMsg ::= SEQUENCE {
     certReq   CertRequest,
     pop       ProofOfPossession  OPTIONAL,
     -- content depends upon key type
     regInfo   SEQUENCE SIZE(1..MAX) OF AttributeTypeAndValue OPTIONAL
 }
 

Currently implementations exist for the following regInfos which are considered the "known-regInfos":

• UTF8Pairs
• CertReq

Any regInfo objects that are not listed here must be created using the AttributeTypeAndValue object, and can then be added.

Since:

7.0

Constructor Summary

Constructors

Constructor and Description
CertReqMsg(ASN1Object obj) Creates a CertReqMsg object from an ASN1Object.
CertReqMsg(CertRequest certReq) Creates a new CertReqMsg object with the specified component.

Method Summary

Methods

Modifier and Type	Method and Description
void	addRegInfo(AttributeTypeAndValue regInfo) Adds the specified regInfo.
int	countRegInfos() Returns the number of regInfos the object holds.
void	decode(ASN1Object obj) Decodes a CertReqMsg structure from an ASN1Object.
CertRequest	getCertReq() Returns the certificate request.
ProofOfPossession	getPOP() Returns the proof-of-possession if it has been set; otherwise null is returned.
AttributeTypeAndValue[]	getRegInfo() Returns all the supplementary registration information this object contains as an array of AttribyteTypeAndValue objects.
void	removePop() Removes the proof-of-possession value this object contains.
void	setPOP(ProofOfPossession pop) Sets the proof-of-possession value this object contains.
ASN1Object	toASN1Object() Encodes this CertReqMsg as an ASN1Object.
java.lang.String	toString() Creates a text representation of the ASN.1 structure of this CertReqMsg object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CertReqMsg

public CertReqMsg(CertRequest certReq)

Creates a new CertReqMsg object with the specified component.

Parameters:

certReq - a certificate request

CertReqMsg

public CertReqMsg(ASN1Object obj)
           throws CodingException

Creates a CertReqMsg object from an ASN1Object.

Parameters:

obj - the ASN.1 representation of a CertReqMsg structure

Throws:

CodingException - thrown if an errors occurs while decoding the ANS1Object

Method Detail

getCertReq

public CertRequest getCertReq()

Returns the certificate request.

Returns:

the certReq component

getPOP

public ProofOfPossession getPOP()

Returns the proof-of-possession if it has been set; otherwise null is returned.

Returns:

the pop component

getRegInfo

public AttributeTypeAndValue[] getRegInfo()

Returns all the supplementary registration information this object contains as an array of AttribyteTypeAndValue objects. The regInfos that are unknown-regInfos will be returned as AttributeTypeAndValue objects; known-regInfos will be returned as their appropriate regInfo objects.

Returns:

an array contains all the regInfos

setPOP

public void setPOP(ProofOfPossession pop)

Sets the proof-of-possession value this object contains.

Parameters:

pop - the proof-of-possession component

removePop

public void removePop()

Removes the proof-of-possession value this object contains.

countRegInfos

public int countRegInfos()

Returns the number of regInfos the object holds.

Returns:

the number of regInfos

addRegInfo

public void addRegInfo(AttributeTypeAndValue regInfo)

Adds the specified regInfo. If the regInfo is a known-regInfo, it ensures that it has a valid 'value' based on the indicated 'type'.

Parameters:

regInfo - the regInfo to be added

decode

public void decode(ASN1Object obj)
            throws CodingException

Decodes a CertReqMsg structure from an ASN1Object.

Specified by:

decode in interface ASN1Type

Parameters:

obj - an ASN.1 representation of a CertReqMsg structure

Throws:

CodingException - thrown if an errors occurs while decoding the ANS1Object

toASN1Object

public ASN1Object toASN1Object()

Encodes this CertReqMsg as an ASN1Object.

Specified by:

toASN1Object in interface ASN1Type

Returns:

an ASN.1 representation of this object

toString

public java.lang.String toString()

Creates a text representation of the ASN.1 structure of this CertReqMsg object.

Overrides:

toString in class java.lang.Object

Returns:

a text representation of the ASN.1 structure of this object