PKIBody ("Entrust Authority Security Toolkit for the Java Platform")

java.lang.Object
- com.entrust.toolkit.asn1.cmpv1.PKIBody

All Implemented Interfaces:: ASN1Type

public class PKIBody
extends java.lang.Object
implements ASN1Type

This class implements the ASN.1 structure for PKIBody as defined in the CMPv1 specification.

 PKIBody ::= CHOICE {       -- message-specific body elements
     ir       [0]  CertReqMessages,        --Initialization Request
     ip       [1]  CertRepMessage,         --Initialization Response
     cr       [2]  CertReqMessages,        --Certification Request
     cp       [3]  CertRepMessage,         --Certification Response
     p10cr    [4]  CertificationRequest,   --imported from [PKCS10]
     popdecc  [5]  POPODecKeyChallContent, --pop Challenge
     popdecr  [6]  POPODecKeyRespContent,  --pop Response
     kur      [7]  CertReqMessages,        --Key Update Request
     kup      [8]  CertRepMessage,         --Key Update Response
     krr      [9]  CertReqMessages,        --Key Recovery Request
     krp      [10] KeyRecRepContent,       --Key Recovery Response
     rr       [11] RevReqContent,          --Revocation Request
     rp       [12] RevRepContent,          --Revocation Response
     ccr      [13] CertReqMessages,        --Cross-Cert. Request
     ccp      [14] CertRepMessage,         --Cross-Cert. Response
     ckuann   [15] CAKeyUpdAnnContent,     --CA Key Update Ann.
     cann     [16] CertAnnContent,         --Certificate Ann.
     rann     [17] RevAnnContent,          --Revocation Ann.
     crlann   [18] CRLAnnContent,          --CRL Announcement
     conf     [19] PKIConfirmContent,      --Confirmation
     nested   [20] NestedMessageContent,   --Nested Message
     genm     [21] GenMsgContent,          --General Message
     genp     [22] GenRepContent,          --General Response
     error    [23] ErrorMsgContent         --Error Message
     certConf [24] CertConfirmContent,    --Certificate confirm
     pollReq  [25] PollReqContent,        --Polling request
     pollRep  [26] PollRepContent         --Polling response
 }

Since:: 7.0

Field Summary

Fields
Modifier and Type	Field and Description
`static byte`	`cann` PKIBody type 'cann'.
`static byte`	`ccp` PKIBody type 'ccp'.
`static byte`	`ccr` PKIBody type 'ccr'.
`static byte`	`certconf` PKIBody type 'certConf'.
`static byte`	`ckuann` PKIBody type 'ckuann'.
`static byte`	`conf` PKIBody type 'conf'.
`static byte`	`cp` PKIBody type 'cp'.
`static byte`	`cr` PKIBody type 'cr'.
`static byte`	`crlann` PKIBody type 'crlann'.
`static byte`	`error` PKIBody type 'error'.
`static byte`	`genm` PKIBody type 'genm'.
`static byte`	`genp` PKIBody type 'genp'.
`static byte`	`ip` PKIBody type 'ip'.
`static byte`	`ir` PKIBody type 'ir'.
`static byte`	`krp` PKIBody type 'krp'.
`static byte`	`krr` PKIBody type 'krr'.
`static byte`	`kup` PKIBody type 'kup'.
`static byte`	`kur` PKIBody type 'kur'.
`static byte`	`nested` PKIBody type 'nested'.
`static byte`	`p10cr` PKIBody type 'p10cr'.
`static byte`	`pollrep` PKIBody type 'pollrep'.
`static byte`	`pollreq` PKIBody type 'pollreq'.
`static byte`	`popdecc` PKIBody type 'popdecc'.
`static byte`	`popdecr` PKIBody type 'popdecr'.
`static byte`	`rann` PKIBody type 'rann'.
`static byte`	`rp` PKIBody type 'rp'.
`static byte`	`rr` PKIBody type 'rr'.
`static java.lang.String[]`	`typeName` Names of each PKIBody type.

Constructor Summary

Constructors
Constructor and Description
`PKIBody(ASN1Object obj)` Creates a new `PKIBody` object from an `ASN1Object`.
`PKIBody(int type, java.lang.Object value)` Creates a new `PKIBody` object with the specified type and value.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`decode(ASN1Object obj)` Decodes an PKIBody structure from an `ASN1Object`.
`int`	`getType()` Returns the type of PKIBody.
`java.lang.Object`	`getValue()` Returns the value of PKIBody.
`ASN1Object`	`toASN1Object()` Encodes this `PKIBody` object as an `ASN1Object`.
`java.lang.String`	`toString()` Creates a text representation of the ASN.1 structure of this `PKIBody` object.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - ir
```
public static final byte ir
```
    PKIBody type 'ir'.
    
    See Also:
    
    Constant Field Values
  - ip
```
public static final byte ip
```
    PKIBody type 'ip'.
    
    See Also:
    
    Constant Field Values
  - cr
```
public static final byte cr
```
    PKIBody type 'cr'.
    
    See Also:
    
    Constant Field Values
  - cp
```
public static final byte cp
```
    PKIBody type 'cp'.
    
    See Also:
    
    Constant Field Values
  - p10cr
```
public static final byte p10cr
```
    PKIBody type 'p10cr'.
    
    See Also:
    
    Constant Field Values
  - popdecc
```
public static final byte popdecc
```
    PKIBody type 'popdecc'.
    
    See Also:
    
    Constant Field Values
  - popdecr
```
public static final byte popdecr
```
    PKIBody type 'popdecr'.
    
    See Also:
    
    Constant Field Values
  - kur
```
public static final byte kur
```
    PKIBody type 'kur'.
    
    See Also:
    
    Constant Field Values
  - kup
```
public static final byte kup
```
    PKIBody type 'kup'.
    
    See Also:
    
    Constant Field Values
  - krr
```
public static final byte krr
```
    PKIBody type 'krr'.
    
    See Also:
    
    Constant Field Values
  - krp
```
public static final byte krp
```
    PKIBody type 'krp'.
    
    See Also:
    
    Constant Field Values
  - rr
```
public static final byte rr
```
    PKIBody type 'rr'.
    
    See Also:
    
    Constant Field Values
  - rp
```
public static final byte rp
```
    PKIBody type 'rp'.
    
    See Also:
    
    Constant Field Values
  - ccr
```
public static final byte ccr
```
    PKIBody type 'ccr'.
    
    See Also:
    
    Constant Field Values
  - ccp
```
public static final byte ccp
```
    PKIBody type 'ccp'.
    
    See Also:
    
    Constant Field Values
  - ckuann
```
public static final byte ckuann
```
    PKIBody type 'ckuann'.
    
    See Also:
    
    Constant Field Values
  - cann
```
public static final byte cann
```
    PKIBody type 'cann'.
    
    See Also:
    
    Constant Field Values
  - rann
```
public static final byte rann
```
    PKIBody type 'rann'.
    
    See Also:
    
    Constant Field Values
  - crlann
```
public static final byte crlann
```
    PKIBody type 'crlann'.
    
    See Also:
    
    Constant Field Values
  - conf
```
public static final byte conf
```
    PKIBody type 'conf'.
    
    See Also:
    
    Constant Field Values
  - nested
```
public static final byte nested
```
    PKIBody type 'nested'.
    
    See Also:
    
    Constant Field Values
  - genm
```
public static final byte genm
```
    PKIBody type 'genm'.
    
    See Also:
    
    Constant Field Values
  - genp
```
public static final byte genp
```
    PKIBody type 'genp'.
    
    See Also:
    
    Constant Field Values
  - error
```
public static final byte error
```
    PKIBody type 'error'.
    
    See Also:
    
    Constant Field Values
  - certconf
```
public static final byte certconf
```
    PKIBody type 'certConf'.
    
    See Also:
    
    Constant Field Values
  - pollreq
```
public static final byte pollreq
```
    PKIBody type 'pollreq'.
    
    See Also:
    
    Constant Field Values
  - pollrep
```
public static final byte pollrep
```
    PKIBody type 'pollrep'.
    
    See Also:
    
    Constant Field Values
  - typeName
```
public static final java.lang.String[] typeName
```
    Names of each PKIBody type.
- Constructor Detail
  - PKIBody
```
public PKIBody(int type,
               java.lang.Object value)
```
    Creates a new PKIBody object with the specified type and value. Currently, only the following combinations of type and value are supported:
    - type = 0, value is a CertReqMsg [] that contains at least one element
    - type = 1, value is a CertRepMessage
    - type = 2, value is a CertReqMsg [] that contains at least one element
    - type = 3, value is a CertRepMessage
    - type = 7, value is a CertReqMsg [] that contains at least one element
    - type = 8, value is a CertRepMessage
    - type = 9, value is a CertReqMsg [] that contains at least one element
    - type = 10, value is a KeyRecRepContent
    - type = 13, value is a CertReqMsg [] that contains at least one element
    - type = 19, value is null
    - type = 21, value is an InfoTypeAndValue []
    - type = 22, value is an InfoTypeAndValue []
    - type = 23, value is an ErrorMsgContent
    - type = 24, value is an CertConfirmContent
    Parameters:
    
    type - the type of PKIBody
    
    value - the value of PKIBody
  - PKIBody
```
public PKIBody(ASN1Object obj)
        throws CodingException
```
    Creates a new PKIBody object from an ASN1Object.
    
    Parameters:
    
    obj - the ASN.1 representation of an PKIBody structure
    
    Throws:
    
    CodingException - thrown if an errors occurs while decoding the ANS1Object
- Method Detail
  - getType
```
public int getType()
```
    Returns the type of PKIBody.
    
    Returns:
    
    the type component
  - getValue
```
public java.lang.Object getValue()
```
    Returns the value of PKIBody. Only the following object-types can be returned based on the type of PKIBody:
    - type = 0, value is a CertReqMsg [] that contains at least one element
    - type = 1, value is a CertRepMessage
    - type = 2, value is a CertReqMsg [] that contains at least one element
    - type = 3, value is a CertRepMessage
    - type = 7, value is a CertReqMsg [] that contains at least one element
    - type = 8, value is a CertRepMessage
    - type = 9, value is a CertReqMsg [] that contains at least one element
    - type = 10, value is a KeyRecRepContent
    - type = 13, value is a CertReqMsg [] that contains at least one element
    - type = 19, value is null
    - type = 21, value is an InfoTypeAndValue []
    - type = 22, value is an InfoTypeAndValue []
    - type = 23, value is an ErrorMsgContent
    - type = 24, value is an CertConfirmContent
    The value is returned as an Object, which can then cast to the appropriate object-type based on the type of PKIBody.
    Returns:
    
    the value component
  - decode
```
public void decode(ASN1Object obj)
            throws CodingException
```
    Decodes an PKIBody structure from an ASN1Object.
    
    Specified by:
    
    decode in interface ASN1Type
    
    Parameters:
    
    obj - an ASN.1 representation of a PKIBody structure
    
    Throws:
    
    CodingException - thrown if an errors occurs while decoding the ANS1Object
  - toASN1Object
```
public ASN1Object toASN1Object()
```
    Encodes this PKIBody object as an ASN1Object.
    
    Specified by:
    
    toASN1Object in interface ASN1Type
    
    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 PKIBody object.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    a text representation of the ASN.1 structure of this object

Class PKIBody

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ir

ip

cr

cp

p10cr

popdecc

popdecr

kur

kup

krr

krp

rr

rp

ccr

ccp

ckuann

cann

rann

crlann

conf

nested

genm

genp

error

certconf

pollreq

pollrep

typeName

Constructor Detail

PKIBody

PKIBody

Method Detail

getType

getValue

decode

toASN1Object

toString