CPKIFResponseFlags Class Reference

#include <ResponseFlags.h>

Collaboration diagram for CPKIFResponseFlags:

Collaboration graph
[legend]

List of all members.


Detailed Description

The CPKIFResponseFlags class provides an interface to SCVP ResponseFlags object.
ResponseFlags ::= SEQUENCE 
{
       fullRequestInResponse      [0] BOOLEAN DEFAULT FALSE,
       responseValidationPolByRef [1] BOOLEAN DEFAULT TRUE,
       protectResponse            [2] BOOLEAN DEFAULT TRUE,
       cachedResponse             [3] BOOLEAN DEFAULT TRUE 
}

TSP-enforcing: No

Definition at line 38 of file ResponseFlags.h.


Public Member Functions

 CPKIFResponseFlags ()
 CPKIFResponseFlags (const CPKIFBufferPtr &)
virtual ~CPKIFResponseFlags (void)
void SetFullRequestInResponse (bool fullRequestInResponse)
const bool GetFullRequestInResponse () const
void SetResponseValidationPolByRef (bool responseValidationPolByRef)
const bool GetResponseValidationPolByRef () const
void SetProtectResponse (bool protectResponse)
const bool GetProtectResponse () const
void SetcachedResponse (bool cachedResponse)
const bool GetCachedResponse () const
bool DefaultsSet ()

Constructor & Destructor Documentation

CPKIFResponseFlags::CPKIFResponseFlags (  ) 

Interface: External

This function is used to create and initialize CPKIFResponseFlags object. The constructor sets the flags to their default values.

Returns:
None

Definition at line 38 of file ResponseFlags.cpp.

References LOG_STRING_DEBUG, and TOOLKIT_SCVP_ASN.

CPKIFResponseFlags::CPKIFResponseFlags ( const CPKIFBufferPtr &  responseFlags  ) 

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:
responseFlags  [in] A reference to a smart pointer to CPKIFBuffer object containing der encoded ResponseFlags

Definition at line 59 of file ResponseFlags.cpp.

References CACASNWRAPPER_CREATE, COMMON_INVALID_INPUT, and TOOLKIT_SCVP_ASN.

CPKIFResponseFlags::~CPKIFResponseFlags ( void   )  [virtual]

Interface: External

This function destroys instances of CPKIFResponseFlags.

Returns:
None

Definition at line 86 of file ResponseFlags.cpp.

References LOG_STRING_DEBUG, and TOOLKIT_SCVP_ASN.


Member Function Documentation

void CPKIFResponseFlags::SetFullRequestInResponse ( bool  fullRequestInResponse  ) 

Interface: External

This function is used to set fullRequestInResponse value

Returns:
None
Parameters:
fullRequestInResponse  [in] Boolean value indicating setting for fullRequestInResponse field

Definition at line 101 of file ResponseFlags.cpp.

const bool CPKIFResponseFlags::GetFullRequestInResponse (  )  const

Interface: External

This function is used to get the responseValidationPolByRef flag

Returns:
The validation time

Definition at line 114 of file ResponseFlags.cpp.

void CPKIFResponseFlags::SetResponseValidationPolByRef ( bool  responseValidationPolByRef  ) 

Interface: External

This function is used to set responseValidationPolByRef value

Returns:
None
Parameters:
responseValidationPolByRef  [in] Boolean value indicating setting for responseValidationPolByRef field

Definition at line 126 of file ResponseFlags.cpp.

const bool CPKIFResponseFlags::GetResponseValidationPolByRef (  )  const

Interface: External

This function is used to get the responseValidationPolByRef flag

Returns:
The validation time

Definition at line 139 of file ResponseFlags.cpp.

void CPKIFResponseFlags::SetProtectResponse ( bool  protectResponse  ) 

Interface: External

This function is used to set protectResponse value

Returns:
None
Parameters:
protectResponse  [in] Boolean value indicating setting for protectResponse field

Definition at line 151 of file ResponseFlags.cpp.

const bool CPKIFResponseFlags::GetProtectResponse (  )  const

Interface: External

This function is used to get the protectResponse flag

Returns:
The validation time

Definition at line 164 of file ResponseFlags.cpp.

void CPKIFResponseFlags::SetcachedResponse ( bool  cachedResponse  ) 

Interface: External

This function is used to set cachedResponse value

Returns:
None
Parameters:
cachedResponse  [in] Boolean value indicating setting for cachedResponse field

Definition at line 176 of file ResponseFlags.cpp.

const bool CPKIFResponseFlags::GetCachedResponse (  )  const

Interface: External

This function is used to get the cachedResponse flag

Returns:
The validation time

Definition at line 189 of file ResponseFlags.cpp.

bool CPKIFResponseFlags::DefaultsSet (  ) 

Interface: External

This function is used to get the cachedResponse flag

Returns:
True if ResponseFlags are set to default values

Definition at line 200 of file ResponseFlags.cpp.


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

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