com.entrust.toolkit.asn1.structures

Class PKIHeader

java.lang.Object

com.entrust.toolkit.asn1.structures.PKIHeader

Deprecated.

as of 7.0, use PKIHeader

public class PKIHeader
extends java.lang.Object

This class encapsulates the ASN.1 PKIX header. It is used by the Entrust profile class to perform communications with the manager. It is very unlikely that any external application will ever want to use this on its own.

Constructor Summary

Constructors

Constructor and Description
PKIHeader(ASN1Object header) Deprecated. This constructor parses an ASN.1 object into an encapsulated PKIHeader.
PKIHeader(int pvno) Deprecated. This constructor creates an empty PKIHeader object.
PKIHeader(int pvno, GeneralName sender, GeneralName recipient, GeneralizedTime messageTime, AlgorithmID protectionAlg, ASN1Object senderKID, ASN1Object recipKID, OCTET_STRING transactionID, OCTET_STRING senderNonce, OCTET_STRING recipNonce) Deprecated. This constructor, given all of the information that can be included, creates a PKIHeader object.

Method Summary

Modifier and Type	Method and Description
void	decode(ASN1Object message) Deprecated. This method decodes an ASN.1 object into its encapsulated form.
java.lang.String[]	getFreeText() Deprecated.
GeneralizedTime	getMessageTime() Deprecated. This method returns the time at which the message was created.
AlgorithmID	getProtectionAlg() Deprecated. This method returns the protection algorithm associated with the PKIHeader.
GeneralName	getRecipient() Deprecated. This method returns the name of the intended recipient.
ASN1Object	getRecipKID() Deprecated. This method returns the recipient's key identifier.
OCTET_STRING	getRecipNonce() Deprecated. This method returns the recipient random nonce associated with the PKIHeader.
GeneralName	getSender() Deprecated. This method returns the sender associated with the PKIHeader.
ASN1Object	getSenderKID() Deprecated. This method returns the sender's key identifier.
OCTET_STRING	getSenderNonce() Deprecated. This method returns the sender random nonce associated with the PKIHeader.
OCTET_STRING	getTransactionID() Deprecated. This method returns the transaction ID associated with the PKIHeader.
void	setFreeText(java.lang.String[] freeText) Deprecated.
void	setMessageTime() Deprecated. This method sets the time at which this message was created to the current time.
void	setMessageTime(GeneralizedTime messageTime) Deprecated. This method sets the time at which this message was created.
void	setProtectionAlg(AlgorithmID protectionAlg) Deprecated. This method sets the protection algorithm field in the header.
void	setRecipient(GeneralName recipient) Deprecated. This method sets the name of the intended recipient.
void	setRecipKID(ASN1Object recipKID) Deprecated. This method sets the recipient's key identifier.
void	setRecipNonce(OCTET_STRING recipNonce) Deprecated. This method sets the recipient random nonce associated with the PKIHeader.
void	setSender(GeneralName sender) Deprecated. This method sets the sender associated with the PKIHeader.
void	setSenderKID(ASN1Object senderKID) Deprecated. This method sets the sender's key identifier.
void	setSenderNonce(OCTET_STRING senderNonce) Deprecated. This method sets the sender random nonce associated with the PKIHeader.
void	setTransactionID(OCTET_STRING transactionID) Deprecated. This method sets the transaction ID associated with the PKIHeader.
ASN1Object	toASN1Object() Deprecated. This method converts the encapsulated representation to a raw ASN.1 representation.

Methods inherited from class java.lang.Object

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

Constructor Detail

PKIHeader

public PKIHeader(int pvno)

Deprecated.

This constructor creates an empty PKIHeader object.

PKIHeader

public PKIHeader(ASN1Object header)
          throws CodingException

Deprecated.

This constructor parses an ASN.1 object into an encapsulated PKIHeader.

Parameters:

header - The ASN.1 representation of a PKIX header.

Throws:

CodingException - This exception is thrown if the header cannot be properly parsed.

PKIHeader

public PKIHeader(int pvno,
                 GeneralName sender,
                 GeneralName recipient,
                 GeneralizedTime messageTime,
                 AlgorithmID protectionAlg,
                 ASN1Object senderKID,
                 ASN1Object recipKID,
                 OCTET_STRING transactionID,
                 OCTET_STRING senderNonce,
                 OCTET_STRING recipNonce)

Deprecated.

This constructor, given all of the information that can be included, creates a PKIHeader object.

Parameters:

sender - The name of the sender.

recipient - The name of the intended recipient.

messageTime - The time at which the message was sent.

protectionAlg - The algorithm used for signing the message.

senderKID - The ID number used to identify the sender.

recipKID - The ID number used to identify the recipient.

transactionID - The ID number used to identify the transaction.

senderNonce - A random number generated by the sender to represent the transaction.

recipNonce - A random number generated by the recipient to represent the transaction.

Method Detail

toASN1Object

public ASN1Object toASN1Object()
                        throws CodingException

Deprecated.

This method converts the encapsulated representation to a raw ASN.1 representation.

Returns:

The ASN.1 representation of this PKIHeader.

Throws:

CodingException

getSender

public GeneralName getSender()

Deprecated.

This method returns the sender associated with the PKIHeader.

Returns:

The name of the sender.

setSender

public void setSender(GeneralName sender)

Deprecated.

This method sets the sender associated with the PKIHeader.

Parameters:

sender - The name of the sender.

getRecipient

public GeneralName getRecipient()

Deprecated.

This method returns the name of the intended recipient.

Returns:

The name of the intended recipient.

setRecipient

public void setRecipient(GeneralName recipient)

Deprecated.

This method sets the name of the intended recipient.

Parameters:

recipient - The name of the intended recipient.

getMessageTime

public GeneralizedTime getMessageTime()

Deprecated.

This method returns the time at which the message was created.

Returns:

The time at which the message was created.

setMessageTime

public void setMessageTime()

Deprecated.

This method sets the time at which this message was created to the current time.

setMessageTime

public void setMessageTime(GeneralizedTime messageTime)

Deprecated.

This method sets the time at which this message was created.

Parameters:

messageTime - The time at which the message was created.

getProtectionAlg

public AlgorithmID getProtectionAlg()

Deprecated.

This method returns the protection algorithm associated with the PKIHeader.

Returns:

The protection algorithm used to secure the message.

setProtectionAlg

public void setProtectionAlg(AlgorithmID protectionAlg)

Deprecated.

This method sets the protection algorithm field in the header.

Parameters:

protectionAlg - The protection algorithm used for the PKIX message.

getSenderKID

public ASN1Object getSenderKID()

Deprecated.

This method returns the sender's key identifier.

Returns:

The sender's key identifier.

setSenderKID

public void setSenderKID(ASN1Object senderKID)

Deprecated.

This method sets the sender's key identifier.

Parameters:

senderKID - The sender's key identifier.

getRecipKID

public ASN1Object getRecipKID()

Deprecated.

This method returns the recipient's key identifier.

Returns:

The recipient's key identifier.

setRecipKID

public void setRecipKID(ASN1Object recipKID)

Deprecated.

This method sets the recipient's key identifier.

Parameters:

recipKID - The recipient's key identifier.

getTransactionID

public OCTET_STRING getTransactionID()

Deprecated.

This method returns the transaction ID associated with the PKIHeader.

Returns:

The transaction ID used to identify the transaction.

setTransactionID

public void setTransactionID(OCTET_STRING transactionID)

Deprecated.

This method sets the transaction ID associated with the PKIHeader.

Parameters:

transactionID - The transaction ID used to identify the transaction.

getSenderNonce

public OCTET_STRING getSenderNonce()

Deprecated.

This method returns the sender random nonce associated with the PKIHeader.

Returns:

The random sender nonce used to identify the transaction.

setSenderNonce

public void setSenderNonce(OCTET_STRING senderNonce)

Deprecated.

This method sets the sender random nonce associated with the PKIHeader.

Parameters:

senderNonce - The random sender nonce used to identify the transaction.

getRecipNonce

public OCTET_STRING getRecipNonce()

Deprecated.

This method returns the recipient random nonce associated with the PKIHeader.

Returns:

The random recipient nonce used to identify the transaction.

setRecipNonce

public void setRecipNonce(OCTET_STRING recipNonce)

Deprecated.

This method sets the recipient random nonce associated with the PKIHeader.

Parameters:

recipNonce - The random recipient nonce used to identify the transaction.

getFreeText

public java.lang.String[] getFreeText()

Deprecated.

setFreeText

public void setFreeText(java.lang.String[] freeText)

Deprecated.

decode

public void decode(ASN1Object message)
            throws CodingException

Deprecated.

This method decodes an ASN.1 object into its encapsulated form.

Parameters:

message - The message to decode.

Throws:

CodingException - This exception is thrown if the message cannot be parsed.