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

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

All Implemented Interfaces:: ASN1Type

public class PKIHeader
extends java.lang.Object
implements ASN1Type

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

 PKIHeader ::= SEQUENCE {
     pvno                 INTEGER { ietf-version2 (1) },
     sender              GeneralName,
     -- identifies the sender
     recipient            GeneralName,
     -- identifies the intended recipient
     messageTime      [0] GeneralizedTime        OPTIONAL,
     -- time of production of this message (used when sender
     -- believes that the transport will be "suitable"; i.e.,
     -- that the time will still be meaningful upon receipt)
     protectionAlg    [1] AlgorithmIdentifier    OPTIONAL,
     -- algorithm used for calculation of protection bits
     senderKID        [2] KeyIdentifier          OPTIONAL,
     recipKID         [3] KeyIdentifier          OPTIONAL,
     -- to identify specific keys used for protection
     transactionID    [4] OCTET STRING           OPTIONAL,
     -- identifies the transaction; i.e., this will be the same in
     -- corresponding request, response and confirmation messages
     senderNonce      [5] OCTET STRING           OPTIONAL,
     recipNonce       [6] OCTET STRING           OPTIONAL,
     -- nonces used to provide replay protection, senderNonce
     -- is inserted by the creator of this message; recipNonce
     -- is a nonce previously inserted in a related message by
     -- the intended recipient of this message
     freeText         [7] PKIFreeText            OPTIONAL,
     -- this may be used to indicate context-specific instructions
     -- (this field is intended for human consumption)
     generalInfo      [8] SEQUENCE SIZE (1..MAX) OF InfoTypeAndValue    OPTIONAL
     -- this may be used to convey context-specific information
     -- (this field not primarily intended for human consumption)
 }

 PKIFreeText ::= SEQUENCE SIZE (1..MAX) OF UTF8String
     -- text encoded as UTF-8 String (note:  each UTF8String SHOULD
     -- include an RFC 1766 language tag to indicate the language
     -- of the contained text)

Since:: 7.0

Constructor Summary

Constructors
Constructor and Description
`PKIHeader(ASN1Object obj)` Creates a `PKIHeader` object from an `ASN1Object`.
`PKIHeader(GeneralName sender, GeneralName recipient)` Creates a new `PKIHeader` object with the specified components.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addFreeText(java.lang.String freeText)` Adds the specified context-specific instruction to the set of context-specific instructions.
`void`	`addGeneralInfo(InfoTypeAndValue generalInfo)` Adds the specified context-specific information to the set of context-specific information.
`void`	`decode(ASN1Object obj)` Decodes a PKIHeader structure from an `ASN1Object`.
`java.lang.String[]`	`getFreeText()` Returns all the context-specific information this object contains if it has been set; otherwise `null` is returned.
`InfoTypeAndValue[]`	`getGeneralInfo()` Returns all the context-specific instructions this object contains if it has been set; otherwise `null` is returned.
`InfoTypeAndValue`	`getGeneralInfo(ObjectID oid)` Returns the context-specific instruction, specified by its object identifier, if it exists in the generalInfo structure; otherwise `null` is returned.
`java.util.Date`	`getMessageTime()` Returns the time the message was sent if it has been set; otherwise `null` is returned.
`AlgorithmID`	`getProtectionAlg()` Returns the algorithm used to protect the message if it has been set; otherwise `null` is returned.
`int`	`getPvno()` Returns the protocol version number.
`GeneralName`	`getRecipient()` Returns the recipient of the message.
`byte[]`	`getRecipKID()` Returns the recipient-key identifier if it has been set; otherwise `null` is returned.
`byte[]`	`getRecipNonce()` Returns the recipient nonce if it has been set; otherwise `null` is returned.
`GeneralName`	`getSender()` Returns the sender of the message.
`byte[]`	`getSenderKID()` Returns the sender-key identifier if it has been set; otherwise `null` is returned.
`byte[]`	`getSenderNonce()` Returns the sender nonce if it has been set; otherwise `null` is returned.
`byte[]`	`getTransactionID()` Returns the transaction identifier if it has been set; otherwise `null` is returned.
`InfoTypeAndValue`	`removeGeneralInfo(ObjectID id)` Removes a GeneralInfo value from the Map of values
`void`	`setFreeText(java.lang.String[] freeText)` Sets the set of context-specific instructions.
`void`	`setGeneralInfo(InfoTypeAndValue[] generalInfo)` Sets the set of context-specific information.
`void`	`setMessageTime(java.util.Date messageTime)` Sets the time of production of this message.
`void`	`setProtectionAlg(AlgorithmID protectionAlg)` Sets the algorithm used for calculation of the protection bits.
`void`	`setPvno(int pvno)` Sets the protocol version number.
`void`	`setRecipient(GeneralName recipient)` Sets the recipient of the message.
`void`	`setRecipKID(byte[] recipKID)` Sets an identifier of the recipient-key used for protection.
`void`	`setRecipNonce(byte[] recipNonce)` Sets the recipient nonce, which is inserted by the recipient of the message and is the copy of the sender nonce from the message it received.
`void`	`setSender(GeneralName sender)` Sets the sender of the message.
`void`	`setSenderKID(byte[] senderKID)` Sets an identifier of the sender-key used for protection.
`void`	`setSenderNonce(byte[] senderNonce)` Sets the sender nonce, which is inserted by the creator of the message to provide replay protection.
`void`	`setTransactionID(byte[] transactionID)` Sets an identifier of the transaction.
`ASN1Object`	`toASN1Object()` Encodes this `PKIHeader` object as an `ASN1Object`.
`java.lang.String`	`toString()` Creates a text representation of the ASN.1 structure of this `PKIHeader` object.

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

- Constructor Detail
  - PKIHeader
```
public PKIHeader(GeneralName sender,
         GeneralName recipient)
```
    Creates a new PKIHeader object with the specified components. The pvno component is automatically set to 1 because this structure can only be used with CMPv1.
    
    Parameters:
    sender - identifies the sender
    recipient - identifies the recipient
  - PKIHeader
```
public PKIHeader(ASN1Object obj)
          throws CodingException
```
    Creates a PKIHeader object from an ASN1Object.
    
    Parameters:
    obj - the ASN.1 representation of a PKIHeader structure
    
    Throws:
    
    CodingException - thrown if an errors occurs while decoding the ANS1Object
- Method Detail
  - getPvno
```
public int getPvno()
```
    Returns the protocol version number.
    
    Returns:
    the pvno component
  - getSender
```
public GeneralName getSender()
```
    Returns the sender of the message.
    
    Returns:
    the sender component
  - getRecipient
```
public GeneralName getRecipient()
```
    Returns the recipient of the message.
    
    Returns:
    the recipient component
  - getMessageTime
```
public java.util.Date getMessageTime()
```
    Returns the time the message was sent if it has been set; otherwise null is returned.
    
    Returns:
    the messageTime component
  - getProtectionAlg
```
public AlgorithmID getProtectionAlg()
```
    Returns the algorithm used to protect the message if it has been set; otherwise null is returned.
    
    Returns:
    the protectionAlg component
  - getSenderKID
```
public byte[] getSenderKID()
```
    Returns the sender-key identifier if it has been set; otherwise null is returned.
    
    Returns:
    the senderKID component
  - getRecipKID
```
public byte[] getRecipKID()
```
    Returns the recipient-key identifier if it has been set; otherwise null is returned.
    
    Returns:
    the recipientKID component
  - getTransactionID
```
public byte[] getTransactionID()
```
    Returns the transaction identifier if it has been set; otherwise null is returned.
    
    Returns:
    the transactionID component
  - getSenderNonce
```
public byte[] getSenderNonce()
```
    Returns the sender nonce if it has been set; otherwise null is returned.
    
    Returns:
    the senderNonce component
  - getRecipNonce
```
public byte[] getRecipNonce()
```
    Returns the recipient nonce if it has been set; otherwise null is returned.
    
    Returns:
    the recipientNonce component
  - getFreeText
```
public java.lang.String[] getFreeText()
```
    Returns all the context-specific information this object contains if it has been set; otherwise null is returned.
    
    Returns:
    the freetext component
  - getGeneralInfo
```
public InfoTypeAndValue[] getGeneralInfo()
```
    Returns all the context-specific instructions this object contains if it has been set; otherwise null is returned.
    
    Returns:
    the generalInfo component
  - removeGeneralInfo
```
public InfoTypeAndValue removeGeneralInfo(ObjectID id)
```
    Removes a GeneralInfo value from the Map of values
    
    Parameters:
    id - The ObjectID representing the value
    
    Returns:
    the GeneralInfo removed or null if it did not exist
  - getGeneralInfo
```
public InfoTypeAndValue getGeneralInfo(ObjectID oid)
```
    Returns the context-specific instruction, specified by its object identifier, if it exists in the generalInfo structure; otherwise null is returned.
    
    Parameters:
    oid - the object identifier of the context-specific instruction
  - setPvno
```
public void setPvno(int pvno)
```
    Sets the protocol version number.
    
    Parameters:
    pvno - the pvno component
  - setSender
```
public void setSender(GeneralName sender)
```
    Sets the sender of the message.
    The sender of the message cannot be set to null.
    
    Parameters:
    sender - the sender component
  - setRecipient
```
public void setRecipient(GeneralName recipient)
```
    Sets the recipient of the message.
    The receiver of the message cannot be set to null.
    
    Parameters:
    recipient - the recipient component
  - setMessageTime
```
public void setMessageTime(java.util.Date messageTime)
```
    Sets the time of production of this message.
    
    Parameters:
    messageTime - the messageTime component
  - setProtectionAlg
```
public void setProtectionAlg(AlgorithmID protectionAlg)
```
    Sets the algorithm used for calculation of the protection bits.
    
    Parameters:
    protectionAlg - the protectionAlg component
  - setSenderKID
```
public void setSenderKID(byte[] senderKID)
```
    Sets an identifier of the sender-key used for protection.
    
    Parameters:
    senderKID - the senderKID component
  - setRecipKID
```
public void setRecipKID(byte[] recipKID)
```
    Sets an identifier of the recipient-key used for protection. This field is normally only required where protection of the message uses Diffie-Hellman (DH) keys.
    
    Parameters:
    recipKID - the recipKID component
  - setTransactionID
```
public void setTransactionID(byte[] transactionID)
```
    Sets an identifier of the transaction. This component will be the same in corresponding request, response and confirmation messages.
    
    Parameters:
    transactionID - the transactionID component
  - setSenderNonce
```
public void setSenderNonce(byte[] senderNonce)
```
    Sets the sender nonce, which is inserted by the creator of the message to provide replay protection.
    
    Parameters:
    senderNonce - the senderNonce component
  - setRecipNonce
```
public void setRecipNonce(byte[] recipNonce)
```
    Sets the recipient nonce, which is inserted by the recipient of the message and is the copy of the sender nonce from the message it received. Provides replay protection.
    
    Parameters:
    recipNonce - the recipNonce component
  - setFreeText
```
public void setFreeText(java.lang.String[] freeText)
```
    Sets the set of context-specific instructions.
    If the context-specific instructions are not null, then it must consist of one or more String objects.
    
    Parameters:
    freeText - the freeText component
  - addFreeText
```
public void addFreeText(java.lang.String freeText)
```
    Adds the specified context-specific instruction to the set of context-specific instructions.
    If freeText is null, it is not added.
    
    Parameters:
    freeText - the context-specific instruction to be added to the freeText component
  - setGeneralInfo
```
public void setGeneralInfo(InfoTypeAndValue[] generalInfo)
```
    Sets the set of context-specific information.
    If the context-specific information is not null, then it must consist of one or more InfoTypeAndValue objects.
    
    Parameters:
    generalInfo - the generalInfo component
  - addGeneralInfo
```
public void addGeneralInfo(InfoTypeAndValue generalInfo)
```
    Adds the specified context-specific information to the set of context-specific information.
    If generalInfo is null, it is not added.
    
    Parameters:
    generalInfo - the context-specific information to be added to the generalInfo component
  - decode
```
public void decode(ASN1Object obj)
            throws CodingException
```
    Decodes a PKIHeader structure from an ASN1Object.
    
    Specified by:
    
    decode in interface ASN1Type
    
    Parameters:
    obj - an ASN.1 representation of a PKIHeader structure
    
    Throws:
    
    CodingException - thrown if an errors occurs while decoding the ANS1Object
  - toASN1Object
```
public ASN1Object toASN1Object()
```
    Encodes this PKIHeader 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 PKIHeader object.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    a text representation of the ASN.1 structure of this object

Class PKIHeader

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PKIHeader

PKIHeader

Method Detail

getPvno

getSender

getRecipient

getMessageTime

getProtectionAlg

getSenderKID

getRecipKID

getTransactionID

getSenderNonce

getRecipNonce

getFreeText

getGeneralInfo

removeGeneralInfo

getGeneralInfo

setPvno

setSender

setRecipient

setMessageTime

setProtectionAlg

setSenderKID

setRecipKID

setTransactionID

setSenderNonce

setRecipNonce

setFreeText

addFreeText

setGeneralInfo

addGeneralInfo

decode

toASN1Object

toString