public class

PKIArchiveControl

extends Object
implements Control
java.lang.Object
   ↳ org.bouncycastle.cert.crmf.PKIArchiveControl

Class Overview

Carrier for a PKIArchiveOptions structure.

Summary

Constants
int archiveRemGenPrivKey
int encryptedPrivKey
int keyGenParameters
Public Constructors
PKIArchiveControl(PKIArchiveOptions pkiArchiveOptions)
Basic constructor - build from an PKIArchiveOptions structure.
Public Methods
int getArchiveType()
Return the archive control type, one of: encryptedPrivKey,keyGenParameters,or archiveRemGenPrivKey.
CMSEnvelopedData getEnvelopedData()
Return the enveloped data structure contained in this control.
ASN1ObjectIdentifier getType()
Return the type of this control.
ASN1Encodable getValue()
Return the underlying ASN.1 object.
boolean isEnvelopedData()
Return whether this control contains enveloped data.
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.bouncycastle.cert.crmf.Control

Constants

public static final int archiveRemGenPrivKey

Constant Value: 2 (0x00000002)

public static final int encryptedPrivKey

Constant Value: 0 (0x00000000)

public static final int keyGenParameters

Constant Value: 1 (0x00000001)

Public Constructors

public PKIArchiveControl (PKIArchiveOptions pkiArchiveOptions)

Basic constructor - build from an PKIArchiveOptions structure.

Parameters
pkiArchiveOptions the ASN.1 structure that will underlie this control.

Public Methods

public int getArchiveType ()

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

Returns
  • the archive control type.

public CMSEnvelopedData getEnvelopedData ()

Return the enveloped data structure contained in this control.

Returns
  • a CMSEnvelopedData object.

public ASN1ObjectIdentifier getType ()

Return the type of this control.

Returns
  • CRMFObjectIdentifiers.id_regCtrl_pkiArchiveOptions

public ASN1Encodable getValue ()

Return the underlying ASN.1 object.

Returns
  • a PKIArchiveOptions structure.

public boolean isEnvelopedData ()

Return whether this control contains enveloped data.

Returns
  • true if the control contains enveloped data, false otherwise.