CPKIFContentType Class Reference

#include <ContentType.h>

Inheritance diagram for CPKIFContentType:

Inheritance graph
[legend]
Collaboration diagram for CPKIFContentType:

Collaboration graph
[legend]

List of all members.


Detailed Description

The CPKIFContentType class is used to represent the fundamental aspects of a CMS content type. All CMS content types are identified by an object identifier. The object identifier value can be set (typically in the constructor of a derived class) and retrieved using the GetContentType and SetContentType functions. All content types have an encoded representation. The encoded representation can be set and retrieved using the SetContent and GetContent functions. CPKIFContentType provides an implemenation of these four functions that can be used by derived classes.

All content types can be encoded or decoded. CPKIFContentType defines two abstract functions, Encode and Decode, to enable applications to encode and decode content types. This class does not provide an implementation of these two functions.

TSP-enforcing: No

Definition at line 33 of file ContentType.h.


Public Member Functions

 CPKIFContentType ()
 CPKIFContentType (const CPKIFOIDPtr &oid, const CPKIFBufferPtr &ciBuf)
virtual ~CPKIFContentType ()
virtual void SetContentType (const CPKIFOIDPtr &contentType)
virtual CPKIFOIDPtr GetContentType () const
virtual void SetContent (const CPKIFBufferPtr &content)
virtual CPKIFBufferPtr GetContent () const
virtual CPKIFBufferPtr Encode ()=0
virtual void Decode (CPKIFBufferPtr &buf)=0

Constructor & Destructor Documentation

CPKIFContentType::CPKIFContentType (  ) 

Interface: External

Default constructor.

Returns:
None

Definition at line 28 of file ContentType.cpp.

CPKIFContentType::CPKIFContentType ( const CPKIFOIDPtr &  oid,
const CPKIFBufferPtr &  ciBuf 
)

Interface: External

This function creates and initializes CPKIFContentType objects.

Returns:
None
Parameters:
oid  [in] A reference to a smart pointer tp CPKIFOIDP object identifying content oid
ciBuf  [in] A reference to a smart pointer tp CPKIFOIDP object containing content value

Definition at line 39 of file ContentType.cpp.

References SetContent(), and SetContentType().

CPKIFContentType::~CPKIFContentType (  )  [virtual]

Interface: External

Destructor

Returns:
None

Definition at line 57 of file ContentType.cpp.


Member Function Documentation

void CPKIFContentType::SetContentType ( const CPKIFOIDPtr &  contentType  )  [virtual]

Interface: External

This function sets content type.

Returns:
None
Parameters:
contentType  [in] A reference to a smart pointer tp CPKIFOID object identifying content type

Definition at line 72 of file ContentType.cpp.

Referenced by CPKIFContentCollection::CPKIFContentCollection(), CPKIFContentType(), CPKIFContentWithAttributes::CPKIFContentWithAttributes(), CPKIFEncryptedData::CPKIFEncryptedData(), CPKIFEnvelopedData::CPKIFEnvelopedData(), and CPKIFSignedData::CPKIFSignedData().

CPKIFOIDPtr CPKIFContentType::GetContentType (  )  const [virtual]

Interface: External

This function returns content type.

Returns:
A smart pointer to CPKIFOID object containing content type.

Reimplemented in CPKIFContentInfo.

Definition at line 88 of file ContentType.cpp.

void CPKIFContentType::SetContent ( const CPKIFBufferPtr &  content  )  [virtual]

Interface: External

This function sets content value.

Returns:
None
Parameters:
content  [in] A reference to a smart pointer tp CPKIFBuffer object containing content value

Definition at line 99 of file ContentType.cpp.

Referenced by CPKIFContentType().

CPKIFBufferPtr CPKIFContentType::GetContent (  )  const [virtual]

Interface: External

This function returns CPKIFBuffer obejct with content value.

Returns:
A smart pointer to CPKIFBuffer object containing content value.

Reimplemented in CPKIFContentInfo.

Definition at line 115 of file ContentType.cpp.

virtual CPKIFBufferPtr CPKIFContentType::Encode (  )  [pure virtual]

virtual void CPKIFContentType::Decode ( CPKIFBufferPtr &  buf  )  [pure virtual]


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

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