CPKIFRevokedInfo Class Reference

#include <RevokedInfo.h>

Collaboration diagram for CPKIFRevokedInfo:

Collaboration graph
[legend]

List of all members.


Detailed Description

The CPKIFRevokedInfo class provides an interface to RevokedInfo objects.

TSP-enforcing: No

Definition at line 23 of file RevokedInfo.h.


Public Member Functions

 CPKIFRevokedInfo (void)
 CPKIFRevokedInfo (const char *time, const int reason)
 ~CPKIFRevokedInfo (void)
const char * GetRevocationTime () const
void SetRevocationTime (CPKIFStringPtr &str)
CPKIFCRLReasonPtr GetRevocationReason () const
void SetRevocationReason (CPKIFCRLReasonPtr &crlReason)

Constructor & Destructor Documentation

CPKIFRevokedInfo::CPKIFRevokedInfo ( void   ) 

Interface: External

Default constructor

Returns:
None

Definition at line 35 of file RevokedInfo.cpp.

References LOG_STRING_DEBUG, and TOOLKIT_OCSP_ASN.

CPKIFRevokedInfo::CPKIFRevokedInfo ( const char *  time,
const int  reason 
)

Interface: External

This function is used to create and initialize CPKIFRevokedInfo objects. This function is used internally by PKIF when parsing OCSP objects. It is not used by applications

Returns:
None
Parameters:
time  [in] A pointer to a string containing GeneralizedTime
reason  [in] An integer indication revocation reason if reason is < 0 then reason is ommited

Definition at line 62 of file RevokedInfo.cpp.

References LOG_STRING_DEBUG, and TOOLKIT_OCSP_ASN.

CPKIFRevokedInfo::~CPKIFRevokedInfo ( void   ) 

Interface: External

This function destroys CPKIFRevokedInfo objects.

Returns:
None

Definition at line 86 of file RevokedInfo.cpp.

References LOG_STRING_DEBUG, and TOOLKIT_OCSP_ASN.


Member Function Documentation

const char * CPKIFRevokedInfo::GetRevocationTime (  )  const

Interface: External

This function is used to get the revocation time associated with a RevokedInfo object.

Returns:
The GetRevocationTime function returns a const char* to a NULL-terminated array of characters containing the time from the RevocationTime field or NULL, if no time is present. The pointer is valid only for the life of the associated CPKIFRevokedInfo object or until SetRevocationTime is invoked. If the value is required for a longer scope it should be copied into an application-allocated buffer

Definition at line 100 of file RevokedInfo.cpp.

void CPKIFRevokedInfo::SetRevocationTime ( CPKIFStringPtr str  ) 

Interface: External

This function is used to set the revocation time associated with a RevokedInfo object.

Returns:
None
Parameters:
str  [in] Reference to a CPKIFStringPtr object containing the time of revocation

Definition at line 111 of file RevokedInfo.cpp.

CPKIFCRLReasonPtr CPKIFRevokedInfo::GetRevocationReason (  )  const

Interface: External

This function is used to get the revocation reason associated with a RevokedInfo object.

Returns:
A smart pointer to CPKIFCRLReason object

Definition at line 124 of file RevokedInfo.cpp.

void CPKIFRevokedInfo::SetRevocationReason ( CPKIFCRLReasonPtr &  crlReason  ) 

Interface: External

This function is used to set the revocation reason associated with a RevokedInfo object.

Returns:
None
Parameters:
crlReason  [in] Reference to a smart pointer to a CPKIFCRLReason object

Definition at line 135 of file RevokedInfo.cpp.


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

Generated on Mon Nov 15 11:20:40 2010 for PublicKeyInfrastructureFramework(PKIF) by  doxygen 1.5.6