com.entrust.toolkit.asn1.crmf.regCtrl

Class PKIPublicationInfo

java.lang.Object

com.entrust.toolkit.asn1.crmf.AttributeTypeAndValue

com.entrust.toolkit.asn1.crmf.regCtrl.PKIPublicationInfo

All Implemented Interfaces:

ASN1Type

public class PKIPublicationInfo
extends AttributeTypeAndValue
implements ASN1Type

This class implements the ASN.1 structure for the PKIPublicationInfo regCtrl as defined in the CRMF specification. PKIPublicationInfo is a regCtrl, which exists as the AttributeTypeAndValue structure.

 id-regCtrl-pkiPublicationInfo OBJECT IDENTIFIER ::= { id-regCtrl 3 }
 --with syntax:

 PKIPublicationInfo ::= SEQUENCE {
     action     INTEGER {
         dontPublish (0),
         pleasePublish (1)
     },
     pubInfos   SEQUENCE SIZE (1..MAX) OF SinglePubInfo OPTIONAL
 }
       -- pubInfos MUST NOT be present if action is "dontPublish"
       -- (if action is "pleasePublish" and pubInfos is omitted,
       -- "dontCare" is assumed)

 SinglePubInfo ::= SEQUENCE {
     pubMethod    INTEGER {
         dontCare    (0),
         x500        (1),
         web         (2),
         ldap        (3)
     },
     pubLocation  GeneralName OPTIONAL
 }

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

The pkiPublicationInfo regCtrl enables subscribers to control the CA's publication of the certificate. If the dontPublish option is chosen, the requester indicates that the PKI should not publish the certificate (this may indicate that the requester intends to publish the certificate him/herself).

If the dontCare method is chosen, or if the PKIPublicationInfo regCtrl is omitted from the request, the requester indicates that the PKI MAY publish the certificate using whatever means it chooses.

If the requester wishes the certificate to appear in at least some locations but wishes to enable the CA to make the certificate available in other repositories, set two values of SinglePubInfo for pubInfos: one with x500, web or ldap value and one with dontCare.

The pubLocation field, if supplied, indicates where the requester would like the certificate to be found (note that the CHOICE within GeneralName includes a URL and an IP address, for example).

Since:

7.0

Field Summary

Fields

Modifier and Type	Field and Description
static byte	action_dontPublish Action value - dontPublish.
static byte	action_pleasePublish Action value - pleasePublish.
static ObjectID	oid The object identifier for a PKIPublicationInfo regCtrl.

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

m_type, m_value

Constructor Summary

Constructors

Constructor and Description
PKIPublicationInfo(ASN1Object obj) Creates a new PKIPublicationInfo regCtrl object from an ASN1Object.
PKIPublicationInfo(boolean publish) Creates a new PKIPublicationInfo regCtrl object action determined by the publish parameter.
PKIPublicationInfo(int action) Creates a new PKIPublicationInfo regCtrl object with the specified component.

Method Summary

Methods

Modifier and Type	Method and Description
void	addPubInfo(SinglePubInfo pubInfo) Adds publishing information and updates the value component.
void	decode(ASN1Object obj) Decodes an PKIPublicationInfo regCtrl structure from an ASN1Object.
int	getAction() Returns the publishing action.
SinglePubInfo[]	getPubInfos() Returns the publishing information.
ASN1Object	toASN1Object() Encodes this PKIPublicationInfo regCtrl object as an ASN1Object.
java.lang.String	toString() Creates a text representation of the ASN.1 structure of this PKIPublicationInfo regCtrl object.

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

getType, getValue

Methods inherited from class java.lang.Object

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

Field Detail

oid

public static final ObjectID oid

The object identifier for a PKIPublicationInfo regCtrl.

action_dontPublish

public static final byte action_dontPublish

Action value - dontPublish.

See Also:

Constant Field Values

action_pleasePublish

public static final byte action_pleasePublish

Action value - pleasePublish.

See Also:

Constant Field Values

Constructor Detail

PKIPublicationInfo

public PKIPublicationInfo(int action)

Creates a new PKIPublicationInfo regCtrl object with the specified component.

Parameters:

action - the publication action

PKIPublicationInfo

public PKIPublicationInfo(boolean publish)

Creates a new PKIPublicationInfo regCtrl object action determined by the publish parameter. If publish is true, the action component is set to PLEASEPUBLISH; otherwise it is set to DONTPUBLISH.

Parameters:

publish - indicates if the certificate should be published

PKIPublicationInfo

public PKIPublicationInfo(ASN1Object obj)
                   throws CodingException

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

Parameters:

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

Throws:

CodingException - thrown if an errors occurs while decoding the ANS1Object

Method Detail

getAction

public int getAction()

Returns the publishing action.

Returns:

the action component

getPubInfos

public SinglePubInfo[] getPubInfos()

Returns the publishing information.

Returns:

the pubInfos component

addPubInfo

public void addPubInfo(SinglePubInfo pubInfo)

Adds publishing information and updates the value component. This also automatically sets the action to 'pleasePublish'.

Parameters:

pubInfo - publishing information

decode

public void decode(ASN1Object obj)
            throws CodingException

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

Specified by:

decode in interface ASN1Type

Overrides:

decode in class AttributeTypeAndValue

Parameters:

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

Throws:

CodingException - thrown if an errors occurs while decoding the ANS1Object

toASN1Object

public ASN1Object toASN1Object()

Encodes this PKIPublicationInfo regCtrl object as an ASN1Object. The encoding produces a complete ASN.1 AttributeTypeAndValue structure, not simply an ASN.1 PKIPublicationInfo structure. To retrieve only the PKIPublicationInfo structure use getValue().

Specified by:

toASN1Object in interface ASN1Type

Overrides:

toASN1Object in class AttributeTypeAndValue

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 PKIPublicationInfo regCtrl object.

Overrides:

toString in class AttributeTypeAndValue

Returns:

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