Top Description Fields Constructors Methods
org.bouncycastle.cert.crmf

public Class PKIArchiveControl

extends Object
implements Control
Class Inheritance
All Implemented Interfaces
org.bouncycastle.cert.crmf.Control
Imports
org.bouncycastle.asn1.ASN1Encodable, .ASN1ObjectIdentifier, org.bouncycastle.asn1.cms.CMSObjectIdentifiers, .ContentInfo, .EnvelopedData, org.bouncycastle.asn1.crmf.CRMFObjectIdentifiers, .EncryptedKey, .PKIArchiveOptions, org.bouncycastle.cms.CMSEnvelopedData, .CMSException
Carrier for a PKIArchiveOptions structure.

Field Summary

Modifier and TypeField and Description
public static final int
archiveRemGenPrivKey

public static final int
encryptedPrivKey

public static final int
keyGenParameters

private final PKIArchiveOptions
pkiArchiveOptions

private static final ASN1ObjectIdentifier
type

Constructor Summary

AccessConstructor and Description
public
PKIArchiveControl(PKIArchiveOptions
the ASN.1 structure that will underlie this control.
pkiArchiveOptions)

Basic constructor - build from an PKIArchiveOptions structure.

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

the archive control type.
getArchiveType()

Return the archive control type, one of: encryptedPrivKey,keyGenParameters,or archiveRemGenPrivKey.

public CMSEnvelopedData

Returns:

a CMSEnvelopedData object.
getEnvelopedData()

Return the enveloped data structure contained in this control.

public ASN1ObjectIdentifier

Returns:

CRMFObjectIdentifiers.id_regCtrl_pkiArchiveOptions
getType()

Implements org.bouncycastle.cert.crmf.Control.getType.

Return the type of this control.

public ASN1Encodable

Returns:

a PKIArchiveOptions structure.
getValue()

Implements org.bouncycastle.cert.crmf.Control.getValue.

Return the underlying ASN.1 object.

public boolean

Returns:

true if the control contains enveloped data, false otherwise.
isEnvelopedData()

Return whether this control contains enveloped data.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

archiveRemGenPrivKeyback to summary
public static final int archiveRemGenPrivKey
encryptedPrivKeyback to summary
public static final int encryptedPrivKey
keyGenParametersback to summary
public static final int keyGenParameters
pkiArchiveOptionsback to summary
private final PKIArchiveOptions pkiArchiveOptions
typeback to summary
private static final ASN1ObjectIdentifier type

Constructor Detail

PKIArchiveControlback to summary
public PKIArchiveControl(PKIArchiveOptions pkiArchiveOptions)

Basic constructor - build from an PKIArchiveOptions structure.

Parameters
pkiArchiveOptions:PKIArchiveOptions

the ASN.1 structure that will underlie this control.

Method Detail

getArchiveTypeback to summary
public int getArchiveType()

Return the archive control type, one of: encryptedPrivKey,keyGenParameters,or archiveRemGenPrivKey.

Returns:int

the archive control type.

getEnvelopedDataback to summary
public CMSEnvelopedData getEnvelopedData() throws CRMFException

Return the enveloped data structure contained in this control.

Returns:CMSEnvelopedData

a CMSEnvelopedData object.

getTypeback to summary
public ASN1ObjectIdentifier getType()

Implements org.bouncycastle.cert.crmf.Control.getType.

Return the type of this control.

Returns:ASN1ObjectIdentifier

CRMFObjectIdentifiers.id_regCtrl_pkiArchiveOptions

getValueback to summary
public ASN1Encodable getValue()

Implements org.bouncycastle.cert.crmf.Control.getValue.

Return the underlying ASN.1 object.

Returns:ASN1Encodable

a PKIArchiveOptions structure.

isEnvelopedDataback to summary
public boolean isEnvelopedData()

Return whether this control contains enveloped data.

Returns:boolean

true if the control contains enveloped data, false otherwise.