CPKIFTimeStampResponse Class Reference

#include <TimeStampResponse.h>

Collaboration diagram for CPKIFTimeStampResponse:

[legend]

List of all members.

---

Detailed Description

The CPKIFTimeStampRequest class provides an interface to RFC 3161 timestamp request objects. See Obtaining a timestamp sample for sample code that generates a timestamp request, posts the request and verifies the response.

TimeStampResp ::= SEQUENCE 
{
	status PKIStatusInfo,
	timeStampToken TimeStampToken OPTIONAL 
}

TSP-enforcing: No

Definition at line 35 of file TimeStampResponse.h.

Public Member Functions
	CPKIFTimeStampResponse ()
	~CPKIFTimeStampResponse ()
void	SetStatus (CPKIFPKIStatusInfoPtr &status)
CPKIFPKIStatusInfoPtr	GetStatus () const
void	SetTimeStampToken (CPKIFContentInfoPtr &timeStampToken)
CPKIFContentInfoPtr	GetTimeStampToken () const
CPKIFBufferPtr	Encode () const
void	Decode (CPKIFBufferPtr &msg)

---

Constructor & Destructor Documentation

CPKIFTimeStampResponse::CPKIFTimeStampResponse

(

)

Interface: External

This function creates and initializes an instance of CPKIFTimeStampResponse. All properties are initialized to NULL until set via a SetXXX invocation or a call to Decode.

Returns:

None

Definition at line 111 of file TimeStampResponse.cpp.

References LOG_STRING_DEBUG, and TOOLKIT_TSP_ASN.

CPKIFTimeStampResponse::~CPKIFTimeStampResponse

(

)

Interface: External

This function destroys an instance of CPKIFTimeStampResponse.

Returns:

None

Definition at line 126 of file TimeStampResponse.cpp.

References LOG_STRING_DEBUG, and TOOLKIT_TSP_ASN.

---

Member Function Documentation

void CPKIFTimeStampResponse::SetStatus

(

CPKIFPKIStatusInfoPtr &

status

)

Interface: External

These functions are used to set the status associated with a CPKIFTimeStampResponse instance.

Returns:

None

Parameters:

status

[in] Reference to a smart pointer to a CPKIFPKIStatusInfo object containing status information to include in a TimeStampResponse

Definition at line 144 of file TimeStampResponse.cpp.

References LOG_STRING_DEBUG, and TOOLKIT_TSP_ASN.

CPKIFPKIStatusInfoPtr CPKIFTimeStampResponse::GetStatus

(

)

const

Interface: External

These functions are used to get the status associated with a CPKIFTimeStampResponse instance.

Returns:

The GetStatus function returns a smart pointer to a CPKIFPKIStatusInfo object containing status information included in a TimeStampResponse.

Definition at line 162 of file TimeStampResponse.cpp.

References CACASNWRAPPER_CREATE, data, LOG_STRING_DEBUG, m_impl, and TOOLKIT_TSP_ASN.

Referenced by Encode().

void CPKIFTimeStampResponse::SetTimeStampToken

(

CPKIFContentInfoPtr &

timeStampToken

)

Interface: External

This function is used to set the timestamp token associated with a CPKIFTimeStampResponse instance.

Returns:

None

Parameters:

timeStampToken

[in] Reference to a smart pointer to a CPKIFContentInfo object containing a timestamp token

Definition at line 188 of file TimeStampResponse.cpp.

References LOG_STRING_DEBUG, and TOOLKIT_TSP_ASN.

CPKIFContentInfoPtr CPKIFTimeStampResponse::GetTimeStampToken

(

)

const

Interface: External

This function is used to get the timestamp token associated with a CPKIFTimeStampResponse instance.

Returns:

The GetTimeStampToken function returns a smart pointer to a CPKIFContentInfo object containing status information included in a TimeStampResponse.

Definition at line 205 of file TimeStampResponse.cpp.

References LOG_STRING_DEBUG, m_impl, and TOOLKIT_TSP_ASN.

Referenced by Encode().

CPKIFBufferPtr CPKIFTimeStampResponse::Encode

(

)

const

Interface: External

This function is used to get/set encode a timestamp response. This function may generate an exception containing the following error code TSP_MISSING_REQUIRED_FIELD.

Returns:

A smart pointer to CPKIFBuffer object which contains the encoded TimeStampResponse

Exceptions:

CPKIFTSPException(TSP_MISSING_REQUIRED_FIELD)

Definition at line 234 of file TimeStampResponse.cpp.

References CACASNWRAPPER_CREATE, ConvertStringToASN1OBJID(), CopyOID(), GetStatus(), GetTimeStampToken(), LOG_STRING_DEBUG, NEW_NEXT_AND_ADVANCE, NEW_NODE, PKIFTSPMemoryHelper::pResponse, SET_HEAD_TAIL_INCREMENT, and TOOLKIT_TSP_ASN.

void CPKIFTimeStampResponse::Decode

(

CPKIFBufferPtr &

buf

)

Interface: External

This function is used to decode a timestamp response.

Returns:

None

Parameters:

buf	[in] Reference to a smart pointer to a CPKIFBuffer object containing a TimeStampResponse to decode

Definition at line 311 of file TimeStampResponse.cpp.

References ASN1_DECODE_ERROR, COMMON_INVALID_INPUT, LOG_STRING_DEBUG, and TOOLKIT_TSP_ASN.

---

The documentation for this class was generated from the following files:

• TimeStampResponse.h
• TimeStampResponse.cpp