com.entrust.toolkit.asn1.cmpv1

Class PKIMessage

java.lang.Object

com.entrust.toolkit.asn1.cmpv1.PKIMessage

All Implemented Interfaces:

ASN1Type

public class PKIMessage
extends java.lang.Object
implements ASN1Type

This class implements the ASN.1 structure for PKIMessage as defined in the CMPv1 specification.

 PKIMessage ::= SEQUENCE {
     header           PKIHeader,
     body             PKIBody,
     protection   [0] PKIProtection OPTIONAL,
     extraCerts   [1] SEQUENCE SIZE (1..MAX) OF Certificate OPTIONAL
 }
 

Since:

7.0

Constructor Summary

Constructors

Constructor and Description
PKIMessage(ASN1Object obj) Creates a new PKIMessage object from an ASN1Object.
PKIMessage(PKIHeader header, PKIBody body) Creates a new PKIMessage object with the specified components.

Method Summary

Methods

Modifier and Type	Method and Description
void	addExtraCert(X509Certificate extraCert) Adds the specified certificate to the extraCerts component.
void	decode(ASN1Object obj) Decodes an PKIMessage structure from an ASN1Object.
PKIBody	getBody() Returns the message-specific information.
X509Certificate[]	getExtraCerts() Returns all the extra certificates this object contains as an array of X509Certificate objects.
PKIHeader	getHeader() Returns the information which is common to many PKI messages.
byte[]	getProtection() Returns the message protection if it has been set; otherwise null is returned.
void	setProtection(byte[] protection) Sets the message protection bits.
ASN1Object	toASN1Object() Encodes this PKIMessage object as an ASN1Object.
java.lang.String	toString() Creates a text representation of the ASN.1 structure of this PKIMessage object.

Methods inherited from class java.lang.Object

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

Constructor Detail

PKIMessage

public PKIMessage(PKIHeader header,
          PKIBody body)

Creates a new PKIMessage object with the specified components.

Parameters:

header - information which is common to many PKI messages

body - message-specific information

PKIMessage

public PKIMessage(ASN1Object obj)
           throws CodingException

Creates a new PKIMessage object from an ASN1Object.

Parameters:

obj - the ASN.1 representation of an PKIMessage structure

Throws:

CodingException - thrown if an errors occurs while decoding the ANS1Object

Method Detail

setProtection

public void setProtection(byte[] protection)

Sets the message protection bits.

Parameters:

protection - the protection component

addExtraCert

public void addExtraCert(X509Certificate extraCert)

Adds the specified certificate to the extraCerts component. If extraCert is null, it is not added.

Parameters:

extraCert - the certificate to add

getHeader

public PKIHeader getHeader()

Returns the information which is common to many PKI messages.

Returns:

the header component

getBody

public PKIBody getBody()

Returns the message-specific information.

Returns:

the body component

getProtection

public byte[] getProtection()

Returns the message protection if it has been set; otherwise null is returned.

Returns:

the protection component

getExtraCerts

public X509Certificate[] getExtraCerts()

Returns all the extra certificates this object contains as an array of X509Certificate objects. If no extra certificates have been set, an empty array is returned.

Returns:

an array containing extra certificates

decode

public void decode(ASN1Object obj)
            throws CodingException

Decodes an PKIMessage structure from an ASN1Object.

Specified by:

decode in interface ASN1Type

Parameters:

obj - an ASN.1 representation of a PKIMessage structure

Throws:

CodingException - thrown if an errors occurs while decoding the ANS1Object

toASN1Object

public ASN1Object toASN1Object()

Encodes this PKIMessage object 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 PKIMessage object.

Overrides:

toString in class java.lang.Object

Returns:

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