pegasus/src/Pegasus/Common/CIMResponseData.h - diff

Return to CIMResponseData.h CVS log

Up to [Pegasus] / pegasus / src / Pegasus / Common

Diff for /pegasus/src/Pegasus/Common/CIMResponseData.h between version 1.6 and 1.6.2.9

version 1.6, 2011/01/07 02:17:20

version 1.6.2.9, 2013/09/29 19:09:50

Line 27

//////////////////////////////////////////////////////////////////////////

// Class CIMResponseData encapsulates the possible types of response data

// representations and supplies conversion methods between these types.

// PEP#348 - The CMPI infrastructure using SCMO (Single Chunk Memory Objects)

// describes its usage in the server flow.

// The design document can be found on the OpenPegasus website openpegasus.org

// at https://collaboration.opengroup.org/pegasus/pp/documents/21210/PEP_348.pdf

//%/////////////////////////////////////////////////////////////////////////////

#ifndef Pegasus_CIMResponseData_h

Line 39

Line 46

#include <Pegasus/Common/SCMOClass.h>

#include <Pegasus/Common/SCMOInstance.h>

#include <Pegasus/Common/SCMODump.h>

#include <Pegasus/Common/Mutex.h> // KS_TODO Remove

#include <Pegasus/Common/Magic.h>

PEGASUS_NAMESPACE_BEGIN

PEGASUS_USING_STD;

typedef Array<Sint8> ArraySint8;

#define PEGASUS_ARRAY_T ArraySint8

# include <Pegasus/Common/ArrayInter.h>

#undef PEGASUS_ARRAY_T

//// KS_TODO REMOVE THIS _Temp test for size validity DELETE when done

//// With development of pull extensions that use the size() function

////#define PSVALID PEGASUS_ASSERT(sizeValid());

#define PSVALID

#define PSVALID {printf("PSVALID Error line %u\n",__LINE__); \

PEGASUS_ASSERT(sizeValid());}

#define PSVALID {if(!sizeValid(){printf("PSVALID Error line %u\n",__LINE__);

PEGASUS_ASSERT(false);}}

class PEGASUS_COMMON_LINKAGE CIMResponseData

{

public:

Line 66

Line 85

RESP_OBJECTS = 4,

RESP_OBJECTPATHS = 5

};

//includeClassOrigin & _includeQualifiers are set to true by default.

//_propertyList is initialized to an empty propertylist to enable

// sending all properties by default. _isClassOperation set false and

// only reset by selected operations (ex. associator response builder)

CIMResponseData(ResponseDataContent content):

_encoding(0),_dataType(content)

_encoding(0),_dataType(content),_size(0), _includeQualifiers(true),

{};

_includeClassOrigin(true),

_isClassOperation(false),

_propertyList(CIMPropertyList())

{

/// KS_TODO the following is all test code.

PEGASUS_DEBUG_ASSERT(valid()); // KS_TEMP KS_TODO DELETE THIS

size();

}

CIMResponseData(const CIMResponseData & x):

_encoding(x._encoding),

_mapObjectsToIntances(x._mapObjectsToIntances),

_dataType(x._dataType),

_size(x._size),

_referencesData(x._referencesData),

_instanceData(x._instanceData),

_hostsData(x._hostsData),

Line 84

Line 115

_instanceNames(x._instanceNames),

_instances(x._instances),

_objects(x._objects),

_scmoInstances(x._scmoInstances)

_scmoInstances(x._scmoInstances),

{};

_includeQualifiers(x._includeQualifiers),

_includeClassOrigin(x._includeClassOrigin),

_isClassOperation(x._isClassOperation),

_propertyList(x._propertyList),

_magic(x._magic)

{

PEGASUS_DEBUG_ASSERT(valid()); // KS_TEMP

}

// Construct an empty object. Issue here in that we would like to

// assure that this is invalid but if we add the _dataType parameter

// it must be a valid one. The alternative would be to define an

// invalid enum but that would cost us in all case/if statements.

// Therefore up to the user to create and then use correctly.

// KS_TODO fix this so that the empty state is somehow protected.

CIMResponseData():

_encoding(0),_mapObjectsToIntances(false), _size(0),

_includeQualifiers(true), _includeClassOrigin(true),

_propertyList(CIMPropertyList())

{

PEGASUS_DEBUG_ASSERT(valid()); // KS_TEMP

}

/**

* Move CIM objects from another CIMResponse data object to this

* CIMResponseData object. Moves the number of objects defined

* in the count parameter from one to another. They are removed

* from the from object and inserted into the to object.

* @param CIMResponseData from which the objects are moved

* @param count Uint32 count of objects to move

* @return - Actual number of objects moved.

Uint32 moveObjects(CIMResponseData & x, Uint32 count);

/**

* Return count of the number of CIM objects in the

* CIMResponseData object

* @return Uint32 The count of the number of CIM objects

* (instances, paths, or objects)in the CIMResponsedata object

Uint32 size();

/** Set the internal size variable based on the current count

* of what is in the CIMResponseData. This operation

* required after users have played with the arrays. See

* CQLOperationRequestDispatcher for example */

void setSize();

/** Determine if there is any binary content in the CIM

ResponseData object

@return Boolean true if binary data exists in content.

Boolean hasBinaryData() const;

~CIMResponseData()

{

}

// Issue with pull and other operations

// in that the other assoc operations return objects and objectPaths

// and the pulls return instances and instancePaths. The pull operation

// must be able to handle either so we use this to reset the datatype

// KS_TODO -- This should check size and only allow if nothing in the

// object.

Boolean setDataType(ResponseDataContent content)

{

PEGASUS_DEBUG_ASSERT(valid());

PEGASUS_ASSERT(_size == 0); // KS_TODO_TEMP or debug mode.

_dataType = content;

return true;

}

// get the datatype property

ResponseDataContent getResponseDataContent()

{

PEGASUS_DEBUG_ASSERT(valid()); // KS_TEMP KS_TODO

return _dataType;

}

// C++ objects interface handling

// Instance Names handling

Line 98

Line 204

void setInstanceNames(const Array<CIMObjectPath>& x)

{

//// AutoMutex autoMut(testLock);

_instanceNames=x;

_encoding |= RESP_ENC_CIM;

_size += x.size();

}

// Instance handling

Line 107

Line 215

void setInstance(const CIMInstance& x)

{

//// AutoMutex autoMut(testLock);

PSVALID;

_instances.clear();

_instances.append(x);

_size++;

_encoding |= RESP_ENC_CIM;

PSVALID;

}

// Instances handling

Array<CIMInstance>& getInstances();

// Get an array of CIMInstances from the CIMResponseData converting from

// any of the internal forms to the C++ format. This will also convert

// CIMObjects to CIMInstances if there are any CIMObjects.

// NOTE: This is a temporary solution to satisfy the BinaryCodec passing

// of data to the client where the data could be either instances or

// objects. The correct solution is to convert back when the provider, etc.

// returns the data to the server. We must convert to that solution but

// this keeps the BinaryCodec working for the moment.

// Expect that this will be used only in CIMCLient.cpp

Array<CIMInstance>& getInstancesFromInstancesOrObjects();

void setInstances(const Array<CIMInstance>& x)

{

//// AutoMutex autoMut(testLock);

PSVALID;

_instances=x;

_encoding |= RESP_ENC_CIM;

_size += x.size();

PSVALID;

}

void appendInstance(const CIMInstance& x)

{

//// AutoMutex autoMut(testLock);

PEGASUS_DEBUG_ASSERT(valid());

_instances.append(x);

_encoding |= RESP_ENC_CIM;

_size += 1;

}

void appendInstances(const Array<CIMInstance>& x)

{

//// AutoMutex autoMut(testLock);

PEGASUS_DEBUG_ASSERT(valid());

_instances.appendArray(x);

_encoding |= RESP_ENC_CIM;

_size += x.size();

}

// Objects handling

Array<CIMObject>& getObjects();

void setObjects(const Array<CIMObject>& x)

{

//// AutoMutex autoMut(testLock);

PEGASUS_DEBUG_ASSERT(valid());

_objects=x;

_encoding |= RESP_ENC_CIM;

_size += x.size();

}

void appendObject(const CIMObject& x)

{

//// AutoMutex autoMut(testLock);

PEGASUS_DEBUG_ASSERT(valid());

_objects.append(x);

_encoding |= RESP_ENC_CIM;

_size += 1;

}

// SCMO representation, single instance stored as one element array

Line 147

Line 294

void appendSCMO(const Array<SCMOInstance>& x)

{

//// AutoMutex autoMut(testLock);

PEGASUS_DEBUG_ASSERT(valid());

_scmoInstances.appendArray(x);

_encoding |= RESP_ENC_SCMO;

_size += x.size();

}

Array<Uint8>& getBinary();

Line 174

Line 324

// Function primarily used by CIMOperationRequestDispatcher to complete

// namespace and hostname on a,an,r and rn operations in the

// OperationAggregator

// OperationAggregator. Note that behavior is different for pull operations

void completeHostNameAndNamespace(

const String & hn,

const CIMNamespaceName & ns);

const CIMNamespaceName & ns,

Boolean isPullOperation = false);

// Encoding responses

// binary format used with Provider Agents and OP Clients

// Encode the CIMResponse data into binary format used with Provider Agents

// and OP Clients in the provider CIMBuffer

void encodeBinaryResponse(CIMBuffer& out);

// Xml format used with Provider Agents only

// Encode the CIMResponse data into Xml format used with Provider Agents

// only in the provided CIMBuffer

void encodeInternalXmlResponse(CIMBuffer& out);

// Encode the CIMResponse data into official Xml format(CIM over Http)

// used to communicate to clients in the provided CIMBuffer.

//Note that the pull responses requires a flag.

void encodeXmlResponse(Buffer& out, Boolean isPull);

// diagnostic tests magic number in context to see if valid object

Boolean valid() const;

// official Xml format(CIM over Http) used to communicate to clients

void encodeXmlResponse(Buffer& out);

//This function is called from buildResponce to set CIMResponcedata

//with respective values of IncludeQualifiers,IncludeClassOrigin and

//propertyFilter.

void setRequestProperties(

const Boolean includeQualifiers,

const Boolean includeClassOrigin,

const CIMPropertyList& propertyList);

// Used with association and reference operations (i.e. operations that

// return CIMObject or CIMObjectPath to set a parameter to define whether

// responseData is for operation on a class or instance.

// Allows building the correct path (classPath or instancePath) and

// object type (Class or Instance) on response.

void setIsClassOperation(Boolean b);

void setPropertyList(const CIMPropertyList& propertyList)

{

_propertyList = propertyList;

}

CIMPropertyList & getPropertyList()

{

return _propertyList;

}

bool sizeValid(); //KS_TEMP KS_TODO REMOVE

void traceResponseData(); // KS_TODO Diagnostic. remove

private:

// helper functions to transform different formats into one-another

Line 210

Line 401

SCMOInstance _getSCMOFromCIMObject(const CIMObject& cimObj);

SCMOInstance _getSCMOFromCIMObjectPath(const CIMObjectPath& cimPath);

SCMOClass* _getSCMOClass(const char* ns,const char* cls);

void _deserializeInstance(Uint32 idx,CIMInstance& cimInstance);

void _deserializeObject(Uint32 idx,CIMObject& cimObject);

Boolean _deserializeReference(Uint32 idx,CIMObjectPath& cimObjectPath);

Boolean _deserializeInstanceName(Uint32 idx,CIMObjectPath& cimObjectPath);

// Bitflags in this integer will reflect what data representation types

// Bitflags in this integer reflect what data representation types

// are currently stored in this CIMResponseData object

Uint32 _encoding;

// Special flag to handle the case where binary data in passed through the

// system but must be mapped to instances in the getInstances. This

// accounts for only one case today, binary data in the BinaryCodec

Boolean _mapObjectsToIntances;

// Storing type of data in this enumeration

ResponseDataContent _dataType;

// Count of objects stored in this CIMResponseData object. This is the

// accumulated count of objects stored in all of the data

// representations. Note that there are a couple of cases where the

// CIMResponseData can be used in a way that makes this not 100% accurate.

Uint32 _size;

// unused arrays are represented by ArrayRepBase _empty_rep

// which is a 16 byte large static shared across all of them

// so, even though this object looks large, it holds just

Line 229

Line 435

Array<String> _hostsData;

Array<CIMNamespaceName> _nameSpacesData;

// For binary encoding.

Array<Uint8> _binaryData;

CIMNamespaceName _defaultNamespace;

Line 243

Line 448

// SCMO encoding

Array<SCMOInstance> _scmoInstances;

// Request characteristics that are carried through operation for

// modification of response generation.

Boolean _includeQualifiers;

Boolean _includeClassOrigin;

// Defines whether response CIMObjects or ObjectPaths are class or instance.

// because associators, etc. operations provide both class and instance

// responses. Default is false and should only be set to true by

// operation requests such as associators (which could return either

// instances or classes) when the operation is to return class information.

Boolean _isClassOperation;

CIMPropertyList _propertyList;

// Function lock used for debugging cases where there might have been an

// issue with multithreading and CIMResponseData.

//// KS_TODO remove before pull checkin

Mutex testLock;

// magic number to use with valid function to confirm validity

// of response data.

Magic<0x57D11323> _magic;

};

PEGASUS_NAMESPACE_END

Legend:

Removed from v.1.6
changed lines
	Added in v.1.6.2.9

No CVS admin address has been configured