CPKIFCertReply Class Reference

#include <CertReply.h>

Inheritance diagram for CPKIFCertReply:

Inheritance graph
[legend]
Collaboration diagram for CPKIFCertReply:

Collaboration graph
[legend]

List of all members.

Detailed Description

The CPKIFCertReply class provides an interface to SCVP response objects. 
CertReply ::= SEQUENCE
{
	cert                       CertReference,
	replyStatus                ReplyStatus DEFAULT success,
	replyValTime               GeneralizedTime,
	replyChecks                ReplyChecks,
	replyWantBacks             ReplyWantBacks,
	validationErrors       [0] SEQUENCE SIZE (1..MAX) OF
							   OBJECT IDENTIFIER OPTIONAL,
	nextUpdate             [1] GeneralizedTime OPTIONAL,
	certReplyExtensions    [2] Extensions OPTIONAL 
}

TSP-enforcing: No

Definition at line 46 of file CertReply.h.


Public Member Functions

 CPKIFCertReply ()
 CPKIFCertReply (const CPKIFBufferPtr &)
virtual ~CPKIFCertReply (void)
void SetCertRef (CPKIFCertReferencePtr &cert)
const CPKIFCertReferencePtr GetCertRef () const
void SetReplyStatus (int replyStatus)
const int GetReplyStatus () const
void SetReplyValTime (CPKIFTimePtr &replyValTime)
const CPKIFTimePtr GetReplyValTime () const
void SetReplyChecks (CPKIFReplyCheckListPtr &replyChecks)
void GetReplyChecks (CPKIFReplyCheckListPtr &replyChecks) const
void SetReplyWantBacks (CPKIFReplyWantBackListPtr &replyWantBacks)
void GetReplyWantBacks (CPKIFReplyWantBackListPtr &replyWantBacks) const
void SetValErrors (CPKIFOIDListPtr &errors)
void GetValErrors (CPKIFOIDListPtr &errors) const
void SetNextUpdate (CPKIFTimePtr &nextUpdate)
const CPKIFTimePtr GetNextUpdate () const
bool ExtensionsPresent () const
template<class T>
boost::shared_ptr< T > GetExtension ()
void GetExtensionByOID (const CPKIFOID &oid, CPKIFX509ExtensionPtr &ref)
void GetEncodedExtensions (CPKIFBufferPtr &buf)

Constructor & Destructor Documentation

CPKIFCertReply::CPKIFCertReply (  ) 

Interface: External

This function is used to create and initialize CPKIFCertReply object.

Returns:
None

Definition at line 165 of file CertReply.cpp.

References LOG_STRING_DEBUG, and TOOLKIT_SCVP_ASN.

CPKIFCertReply::CPKIFCertReply ( const CPKIFBufferPtr &  hashValue  ) 

Interface: External

This constructor is internally invoked; it will throw a std::bad_alloc exception if allocation of memory fails or ASN.1 decoding errors if the extension cannot be parsed.

Returns:
None
Exceptions:
std::bad_alloc 
Parameters:
hashValue  [in] A reference to a smart pointer to CPKIFBuffer object containing der encoded CertReply

Definition at line 183 of file CertReply.cpp.

References CACASNWRAPPER_CREATE, COMMON_INVALID_INPUT, CPKIFTime, and TOOLKIT_SCVP_ASN.

CPKIFCertReply::~CPKIFCertReply ( void   )  [virtual]

Interface: External

This function destroys instances of CPKIFCertReply.

Returns:
None

Definition at line 275 of file CertReply.cpp.

References LOG_STRING_DEBUG, and TOOLKIT_SCVP_ASN.

Member Function Documentation

void CPKIFCertReply::SetCertRef ( CPKIFCertReferencePtr &  certRef  ) 

Interface: External

This function is used to set the certificate reference

Returns:
None
Parameters:
certRef  [in] Smart pointer to CPKIFCertReference object containing the certificate reference

Definition at line 538 of file CertReply.cpp.

const CPKIFCertReferencePtr CPKIFCertReply::GetCertRef (  )  const

Interface: External

This function is used to retrieve the certificate reference

Returns:
Smart pointer to CPKIFCertReference object containing the certificate reference

Definition at line 551 of file CertReply.cpp.

void CPKIFCertReply::SetReplyStatus ( int  replyStatus  ) 

Interface: External

This function is used to set the reply status

Reply satus values 

success = 0,
malformedPKC = 1,
malformedAC = 2,
unavailableValidityTime = 3,
referenceCertHashFail = 4,
certPathConstructFail = 5,
certPathNotValid = 6,
certPathNotValidNow = 7,
wantBackUnsatisfied = 8

Returns:
None
Parameters:
replyStatus  [in] Integer representing the reply status

Definition at line 463 of file CertReply.cpp.

const int CPKIFCertReply::GetReplyStatus (  )  const

Definition at line 470 of file CertReply.cpp.

void CPKIFCertReply::SetReplyValTime ( CPKIFTimePtr &  validationTime  ) 

Interface: External

This function is used to set an indicator that is used to set reply validation time

Returns:
None
Parameters:
validationTime  [in] Reference to a smart pointer to a CPKIFTimePtr object containing reply validation time

Definition at line 372 of file CertReply.cpp.

const CPKIFTimePtr CPKIFCertReply::GetReplyValTime (  )  const

Interface: External

This function is used to get the validation time

Returns:
The validation time

Definition at line 385 of file CertReply.cpp.

void CPKIFCertReply::SetReplyChecks ( CPKIFReplyCheckListPtr &  replyChecks  ) 

Interface: External

This function is used to set the list of reply checks

Returns:
None
Parameters:
replyChecks  [in] Reference to a smart pointer to a CPKIFReplyCheckList object containing a list of reply checks

Definition at line 482 of file CertReply.cpp.

void CPKIFCertReply::GetReplyChecks ( CPKIFReplyCheckListPtr &  replyChecks  )  const

Interface: External

This function is used to retrieve the list of reply checks

Returns:
None
Parameters:
replyChecks  [out] Reference to a smart pointer to a CPKIFReplyCheckList object.

Definition at line 496 of file CertReply.cpp.

void CPKIFCertReply::SetReplyWantBacks ( CPKIFReplyWantBackListPtr &  replyWantBacks  ) 

Interface: External

This function is used to set reply want back list

Returns:
None
Parameters:
replyWantBacks  [in] Reference to a smart pointer to a CPKIFReplyWantBackList object containing reply want back list

Definition at line 511 of file CertReply.cpp.

void CPKIFCertReply::GetReplyWantBacks ( CPKIFReplyWantBackListPtr &  replyWantBacks  )  const

Interface: External

This function is used to retrieve the reply want back list

Returns:
None
Parameters:
replyWantBacks  [out] Reference to a smart pointer to a CPKIFReplyWantBackList object.

Definition at line 525 of file CertReply.cpp.

void CPKIFCertReply::SetValErrors ( CPKIFOIDListPtr &  errors  ) 

Interface: External

This function is used to set the validation errors.

Returns:
None
Parameters:
errors  [in] Reference to a smart pointer to a CPKIFOIDList object containing a list of object identifiers

Definition at line 422 of file CertReply.cpp.

void CPKIFCertReply::GetValErrors ( CPKIFOIDListPtr &  errors  )  const

Interface: External

This function is used to retrieve the validation erros.

Returns:
None
Parameters:
errors  [out] Reference to a smart pointer to a CPKIOIDList object.

Definition at line 436 of file CertReply.cpp.

void CPKIFCertReply::SetNextUpdate ( CPKIFTimePtr &  nextUpdate  ) 

Interface: External

This function is used to set an indicator that is used to set next update time

Returns:
None
Parameters:
nextUpdate  [in] Reference to a smart pointer to a CPKIFTimePtr object containing reply next update

Definition at line 397 of file CertReply.cpp.

const CPKIFTimePtr CPKIFCertReply::GetNextUpdate (  )  const

Interface: External

This function is used to get the next update time

Returns:
The next update time

Definition at line 410 of file CertReply.cpp.

bool CPKIFCertReply::ExtensionsPresent (  )  const

Interface: External

This function returns true if CPKIFCertReply contained extensions.

Return values:
True if a CPKIFCertReply contained extensions
False if a CPKIFCertReply did not contain extensions

Definition at line 355 of file CertReply.cpp.

References LOG_STRING_DEBUG, and TOOLKIT_SCVP_ASN.

template<class T>
boost::shared_ptr<T> CPKIFCertReply::GetExtension (  )  [inline]

this function should be used to retrieve extensions in a type-safe manner you pass a type as a param and the function returns a default smart pointer to that type Interface: External

This function is used to retrieve an extension from an IPKIFHasExtensions object. It takes the type of extension sought by an application as a template parameter and returns a smart pointer to that type (containing a NULL pointer if the extension was not found).

Returns:
A smart pointer to the appropriate extension

Reimplemented from IPKIFHasExtensions.

void CPKIFCertReply::GetExtensionByOID ( const CPKIFOID &  oid,
CPKIFX509ExtensionPtr &  ref 
) [virtual]

Interface: External

This function retrives the extension identified by CPKIFOID object

Returns:
None
Parameters:
oid  [in] Identifies the extension sought
ref  [out] The extension (if present).

Implements IPKIFHasExtensions.

Definition at line 326 of file CertReply.cpp.

void CPKIFCertReply::GetEncodedExtensions ( CPKIFBufferPtr &  buf  )  [virtual]

Interface: External

This function returns a smart pointer to CPKIFBuffer object which will contain the encoded extensions

Returns:
A smart pointer to CPKIFBuffer object which will contain the encoded extensions
Parameters:
buf  [out] A reference to a smart pointer to CPKIFBuffer object which will contain the encoded extensions

Implements IPKIFHasExtensions.

Definition at line 292 of file CertReply.cpp.

References CACASNWRAPPER_CREATE, and data.

The documentation for this class was generated from the following files:
Generated on Mon Nov 15 11:20:02 2010 for PublicKeyInfrastructureFramework(PKIF) by  doxygen 1.5.6