com.entrust.toolkit.asn1.structures
Class Controls

java.lang.Object
  |
  +--com.entrust.toolkit.asn1.structures.Controls

public class Controls

extends java.lang.Object

This class represents a PKIX full certificate template, which basically contains an (incomplete) X.509 certificate, and then a series of optional information related to it, such as archiving options and proof of possession of private keys. This class does not provide access to the full range of options in the full certificate template, but only to those which need to vary within Entrust profile creation requests. For a more complete specification of the full certificate template, see draft-ietf-pkix-ipki3cmp-04.txt by C. Adams and S. Farrell.

Constructor Summary

Controls()
This constructor creates an empty full certificate template.

Controls(ASN1Object template)
This constructor decodes an ASN.1 representation of a full certificate template.

Method Summary

boolean	getArchiveKey()
GeneralName	getOldCertIdIssuer()
INTEGER	getOldCertIdSerialNumber()
PublicKey	getProtocolEncryptionKey() This method gets the protocol encryption key.
boolean	getPublicationInfo()
void	setArchiveKey(boolean archiveKey)
void	setOldCertId(GeneralName issuer, INTEGER serialNumber)
void	setProtocolEncryptionKey(PublicKey protocolEncryptionKey) This method sets the protocol encryption key.
void	setPublicationInfo(boolean publicKey)
ASN1Object	toASN1Object() This method converts the full certificate template to an ASN.1 object for transportation.

Methods inherited from class java.lang.Object

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

Constructor Detail

Controls

public Controls()

This constructor creates an empty full certificate template. Any fields must be set manually.

Controls

public Controls(ASN1Object template)
         throws CodingException

This constructor decodes an ASN.1 representation of a full certificate template.

Parameters:

template - The ASN.1 representation.

Throws:

CodingException - This exception is thrown if the ASN.1 object does not represent a full certificate template or cannot be decoded.

Method Detail

toASN1Object

public ASN1Object toASN1Object()
                        throws CodingException

This method converts the full certificate template to an ASN.1 object for transportation.

Returns:

The ASN.1 representation of the full certificate template.

Throws:

CodingException - This exception is thrown if there is an error encoding any of the necessary values.

setProtocolEncryptionKey

public void setProtocolEncryptionKey(PublicKey protocolEncryptionKey)

This method sets the protocol encryption key.

Parameters:

protocolEncryptionKey - The protocol encryption key

getProtocolEncryptionKey

public PublicKey getProtocolEncryptionKey()

This method gets the protocol encryption key.

Returns:

The protocol encryption key.

setPublicationInfo

public void setPublicationInfo(boolean publicKey)

getPublicationInfo

public boolean getPublicationInfo()

setArchiveKey

public void setArchiveKey(boolean archiveKey)

getArchiveKey

public boolean getArchiveKey()

setOldCertId

public void setOldCertId(GeneralName issuer,
                         INTEGER serialNumber)

getOldCertIdIssuer

public GeneralName getOldCertIdIssuer()

getOldCertIdSerialNumber

public INTEGER getOldCertIdSerialNumber()