CPKIFEncapsulatedContentInfo Class Reference
#include <EncapsulatedContentInfo.h>
Detailed Description
This class is used for the following purposes:- To specify the type of content covered by a signature included in a SignedData message,
- To specify the content encapsulated by a SignedData message and covered by a signature included in a SignedData message,
- To retrieve encapsulated content and content type information from a SignedData message.
TSP-enforcing: Yes
Definition at line 25 of file EncapsulatedContentInfo.h.
Public Member Functions | |
| CPKIFEncapsulatedContentInfo () | |
| virtual | ~CPKIFEncapsulatedContentInfo () |
| void | SetOID (CPKIFOIDPtr &oid) |
| CPKIFOIDPtr | GetOID () const |
| void | SetContent (CPKIFBufferPtr &buf) |
| CPKIFBufferPtr | GetContent () const |
Constructor & Destructor Documentation
| CPKIFEncapsulatedContentInfo::CPKIFEncapsulatedContentInfo | ( | ) |
Interface: External
This function creates instances of CPKIFEncapsulatedContentInfo and initializes the default value of the OID property equal to g_data.
- Returns:
- None
Definition at line 32 of file EncapsulatedContentInfo.cpp.
References g_data.
| CPKIFEncapsulatedContentInfo::~CPKIFEncapsulatedContentInfo | ( | ) | [virtual] |
Interface: External
This function destroys an instance of CPKIFEncapsulatedContentInfo.
- Returns:
- None
Definition at line 44 of file EncapsulatedContentInfo.cpp.
Member Function Documentation
| void CPKIFEncapsulatedContentInfo::SetOID | ( | CPKIFOIDPtr & | oid | ) |
Interface: External
This function is used to set the OID that identifies the type of payload encapsulated by the content info structure. PKIF provides variables that define the common CMS-related OIDs, such as g_data. By default, the value of this property is set to g_data. Applications must take care when specifying an OID to identify the encapsulated content. Specification of incorrect OIDs, e.g. OIDs that do not correspond to the actual content, may result in creation of messages that can not be successfully processed by recipients of the message.
If SetOID is invoked with the oid parameter containing a NULL pointer, a CPKIFMessageException with error code set to COMMON_INVALID_INPUT will be thrown.
- Returns:
- None
- Exceptions:
-
CPKIFMessageException(COMMON_INVALID_INPUT)
- Parameters:
-
oid [in] Reference to a smart pointer to a CPKIFOID object containing the OID value identifying the type of content passed to SetContent or the type of content passed to a SignedData object via a call to UpdateMessage when content is detached.
Definition at line 65 of file EncapsulatedContentInfo.cpp.
References COMMON_INVALID_INPUT, and TOOLKIT_MESSAGE.
| CPKIFOIDPtr CPKIFEncapsulatedContentInfo::GetOID | ( | ) | const |
Interface: External
The GetOID function returns a smart pointer to a CPKIFOID object containing the value of the OID property. The value will point to the OID value passed by the application to SetOID or the value retrieved from a d ecoded SignedData message. If no value has been specified by the application or retrieved from a decoded SignedData message, the value returned will contain a NULL pointer.
- Returns:
- Returns a smart pointer to a CPKIFOID object containing the value of the OID property.
Definition at line 87 of file EncapsulatedContentInfo.cpp.
| void CPKIFEncapsulatedContentInfo::SetContent | ( | CPKIFBufferPtr & | buf | ) |
Interface: External
This function is used to set the content encapsulated by the encapsulated info structure. To specify the type of content, use the SetOID functions. If SetContent is invoked with the buf parameter containing a NULL pointer, a CPKIFMessageException with error code set to COMMON_INVALID_INPUT will be thrown.
This function cannot be used to specify detached content. Use the UpdateMessage function of CPKIFSignedData for that purpose.
- Returns:
- None
- Exceptions:
-
CPKIFMessageException(COMMON_INVALID_INPUT)
- Parameters:
-
buf [in] Reference to smart pointer to a CPKIFBuffer object containing the content buffer to be encapsulated by a SignedData message (for detached content don’t use this function, invoke the UpdateMessage function of CPKIFSignedData)
Definition at line 105 of file EncapsulatedContentInfo.cpp.
References COMMON_INVALID_INPUT, and TOOLKIT_MESSAGE.
| CPKIFBufferPtr CPKIFEncapsulatedContentInfo::GetContent | ( | ) | const |
Interface: External
The GetContent function returns a smart pointer to a CPKIFBuffer object containing the value of the Content property. The value will point to the buffer passed by the application to SetContent or the value retrieved from a decoded SignedData message. If no value has been specified by the application or retrieved from a decoded SignedData message, the value returned will contain a NULL pointer.
- Returns:
- Returns a smart pointer to a CPKIFBuffer object containing the value of the Content property.
Definition at line 127 of file EncapsulatedContentInfo.cpp.
The documentation for this class was generated from the following files:
