com.entrust.toolkit.asn1.crmf.regCtrl

Class PKIArchiveOptions

java.lang.Object

com.entrust.toolkit.asn1.crmf.AttributeTypeAndValue

com.entrust.toolkit.asn1.crmf.regCtrl.PKIArchiveOptions

All Implemented Interfaces:

ASN1Type

public class PKIArchiveOptions
extends AttributeTypeAndValue
implements ASN1Type

This class is an implementation of the ASN.1 structure for the PKIArchiveOptions regCtrl as defined in the CRMF specification. PKIArchiveOptions is a regCtrl, which exists as the AttributeTypeAndValue structure.

 id-regCtrl-pkiArchiveOptions     OBJECT IDENTIFIER ::= { id-regCtrl 4 }
 --with syntax:

 PKIArchiveOptions ::= CHOICE {
     encryptedPrivKey        [0] EncryptedKey,
     -- the actual value of the private key
     keyGenParameters        [1] IMPLICIT KeyGenParameters,
     -- parameters which allow the private key to be re-generated
     archiveRemGenPrivKey    [2] IMPLICIT BOOLEAN
     -- set to TRUE if sender wishes receiver to archive the private
     -- key of a key pair which the receiver generates in response to
     -- this request; set to FALSE if no archival is desired.
 }

 EncryptedKey ::= CHOICE {
     encryptedValue    EncryptedValue, 
     envelopedData     [0] IMPLICIT EnvelopedData
     -- The encrypted private key MUST be placed in the envelopedData 
     -- encryptedContentInfo encryptedContent OCTET STRING.
 }

 KeyGenParameters ::= OCTET STRING
 
 AttributeTypeAndValue ::= SEQUENCE {
     type     OBJECT IDENTIFIER,
     value    ANY DEFINED BY type
 }
 

The pkiArchiveOptions regCtrl enables subscribers to supply information needed to establish an archive of the private key corresponding to the public key of the certification request.

Since:

7.0

Field Summary

Fields

Modifier and Type	Field and Description
static byte	archiveRemGenPrivKey PKIArchiveOptions type 'archiveRemGenPrivKey'.
static byte	encryptedPrivKey PKIArchiveOptions type 'encryptedPrivKey'.
static byte	keyGenParameters PKIArchiveOptions type 'keyGenParameters'.
static ObjectID	oid The object identifier for a PKIArchiveOptions regCtrl.

Fields inherited from class com.entrust.toolkit.asn1.crmf.AttributeTypeAndValue

m_type, m_value

Constructor Summary

Constructors

Constructor and Description
PKIArchiveOptions(ASN1Object obj) Creates a new PKIArchiveOptions regCtrl object from an ASN1Object.
PKIArchiveOptions(int choiceType, java.lang.Object choiceValue) Creates a new PKIArchiveOptions object with the specified choice-type and choice-value.

Method Summary

Modifier and Type	Method and Description
void	decode(ASN1Object obj) Decodes an PKIArchiveOptions regCtrl structure from an ASN1Object.
int	getChoiceType() Returns the choice type that this object represents.
java.lang.Object	getChoiceValue() Returns the choice value that this object represents.
java.lang.String	toString() Creates a text representation of the ASN.1 structure of this PKIArchiveOptions regCtrl object.

Methods inherited from class com.entrust.toolkit.asn1.crmf.AttributeTypeAndValue

getType, getValue, toASN1Object

Methods inherited from class java.lang.Object

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

Methods inherited from interface iaik.asn1.ASN1Type

toASN1Object

Field Detail

oid

public static final ObjectID oid

The object identifier for a PKIArchiveOptions regCtrl.

encryptedPrivKey

public static final byte encryptedPrivKey

PKIArchiveOptions type 'encryptedPrivKey'.

See Also:

Constant Field Values

keyGenParameters

public static final byte keyGenParameters

PKIArchiveOptions type 'keyGenParameters'.

See Also:

Constant Field Values

archiveRemGenPrivKey

public static final byte archiveRemGenPrivKey

PKIArchiveOptions type 'archiveRemGenPrivKey'.

See Also:

Constant Field Values

Constructor Detail

PKIArchiveOptions

public PKIArchiveOptions(int choiceType,
                         java.lang.Object choiceValue)

Creates a new PKIArchiveOptions object with the specified choice-type and choice-value. Currently, only the following combinations of type and value are supported:

• choiceType = 0, choiceValue is an EncryptedValue
• choiceType = 1, choiceValue is a byte []
• choiceType = 2, choiceValue is a Boolean

Parameters:

choiceType - the choice-type of PKIArchiveOptions

choiceValue - the choice-value of PKIArchiveOptions

PKIArchiveOptions

public PKIArchiveOptions(ASN1Object obj)
                  throws CodingException

Creates a new PKIArchiveOptions regCtrl object from an ASN1Object. The ASN1Object must be a complete ASN.1 AttributeTypeAndValue structure, not simply an ASN.1 PKIArchiveOptions structure.

Parameters:

obj - the ASN.1 representation of a PKIArchiveOptions regCtrl structure

Throws:

CodingException - thrown if an errors occurs while decoding the ANS1Object

Method Detail

getChoiceType

public int getChoiceType()

Returns the choice type that this object represents.

Returns:

the choice type

getChoiceValue

public java.lang.Object getChoiceValue()

Returns the choice value that this object represents.

Returns:

the choice value

decode

public void decode(ASN1Object obj)
            throws CodingException

Decodes an PKIArchiveOptions regCtrl structure from an ASN1Object. The ASN1Object must be a complete ASN.1 AttributeTypeAndValue structure, not simply an ASN.1 PKIArchiveOptions structure.

Specified by:

decode in interface ASN1Type

Overrides:

decode in class AttributeTypeAndValue

Parameters:

obj - an ASN.1 representation of a PKIArchiveOptions regCtrl structure

Throws:

CodingException - thrown if an errors occurs while decoding the ANS1Object

toString

public java.lang.String toString()

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

Overrides:

toString in class AttributeTypeAndValue

Returns:

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