pegasus/src/Pegasus/Common/CIMClassRep.cpp - diff

Return to CIMClassRep.cpp CVS log

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

Diff for /pegasus/src/Pegasus/Common/CIMClassRep.cpp between version 1.27 and 1.74

version 1.27, 2002/03/22 00:48:56

version 1.74, 2006/07/21 18:40:55

Line 1

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

//%2006////////////////////////////////////////////////////////////////////////

// Company, L.P.; IBM Corp.; The Open Group; Tivoli Systems.

// IBM Corp.; EMC Corporation, The Open Group.

// IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group.

// EMC Corporation; VERITAS Software Corporation; The Open Group.

// EMC Corporation; Symantec Corporation; The Open Group.

// Permission is hereby granted, free of charge, to any person obtaining a copy

// of this software and associated documentation files (the "Software"), to

Line 22

Line 31

// Author: Mike Brasher (mbrasher@bmc.com)

// Modified By:

// Modified By: Karl Schopmeyer(k.schopmeyer@attglobal.net)

// Roger Kumpf, Hewlett-Packard Company (roger_kumpf@hp.com)

// Carol Ann Krug Graves, Hewlett-Packard Company

// (carolann_graves@hp.com)

// David Dillard, VERITAS Software Corp.

// (david.dillard@veritas.com)

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

#include "CIMClass.h"

#include "CIMClassRep.h"

#include "DeclContext.h"

#include "Resolver.h"

#include "Indentor.h"

#include "CIMName.h"

#include "CIMQualifierNames.h"

#include "CIMScope.h"

#include "XmlWriter.h"

#include "MofWriter.h"

#include <Pegasus/Common/Tracer.h>

#include <Pegasus/Common/MessageLoader.h> //l10n

#include "CIMNameUnchecked.h"

#include "StrLit.h"

#include "CIMInstanceRep.h"

PEGASUS_NAMESPACE_BEGIN

PEGASUS_USING_STD;

CIMClassRep::CIMClassRep(

const CIMReference& reference,

const CIMName& className,

const String& superClassName)

const CIMName& superClassName)

CIMObjectRep(reference),

CIMObjectRep(CIMObjectPath(String(), CIMNamespaceName(), className)),

_superClassName(superClassName)

{

if (superClassName.size() && !CIMName::legal(superClassName))

throw IllegalName();

}

CIMClassRep::~CIMClassRep()

{

}

Boolean CIMClassRep::isAssociation() const

{

Uint32 pos = findQualifier(CIMQualifierNames::ASSOCIATION);

Uint32 index = findQualifier(CIMQualifierNames::ASSOCIATION);

if (pos == PEG_NOT_FOUND)

if (index == PEG_NOT_FOUND)

return false;

Boolean flag;

const CIMValue& value = getQualifier(pos).getValue();

const CIMValue& value = getQualifier(index).getValue();

if (value.getType() != CIMType::BOOLEAN)

if (value.getType() != CIMTYPE_BOOLEAN)

return false;

value.get(flag);

Line 71

Line 91

Boolean CIMClassRep::isAbstract() const

{

Uint32 pos = findQualifier(CIMQualifierNames::ABSTRACT);

Uint32 index = findQualifier(CIMQualifierNames::ABSTRACT);

if (pos == PEG_NOT_FOUND)

if (index == PEG_NOT_FOUND)

return false;

Boolean flag;

const CIMValue& value = getQualifier(pos).getValue();

const CIMValue& value = getQualifier(index).getValue();

if (value.getType() != CIMType::BOOLEAN)

if (value.getType() != CIMTYPE_BOOLEAN)

return false;

value.get(flag);

return flag;

}

void CIMClassRep::setSuperClassName(const CIMName& superClassName)

void CIMClassRep::setSuperClassName(const String& superClassName)

{

if (!CIMName::legal(superClassName))

throw IllegalName();

_superClassName = superClassName;

}

void CIMClassRep::addProperty(const CIMProperty& x)

{

if (!x)

if (x.isUninitialized())

throw UnitializedHandle();

throw UninitializedObjectException();

// Reject addition of duplicate property name:

if (findProperty(x.getName()) != PEG_NOT_FOUND)

if (findProperty(x.getName()) != PEG_NOT_FOUND){

throw AlreadyExists();

//l10n

//throw AlreadyExistsException

//("property \"" + x.getName().getString () + "\"");

MessageLoaderParms parms("Common.CIMClassRep.PROPERTY",

"property \"$0\"",

x.getName().getString());

throw AlreadyExistsException(parms);

// Reject addition of references to non-associations:

}

if (!isAssociation() && x.getValue().getType() == CIMType::REFERENCE)

throw AddedReferenceToClass(_reference.getClassName());

// Set the class origin:

// Reject addition of a reference property without a referenceClassName

// ATTN: put this check in other places:

if (x.getClassOrigin().size() == 0)

if ((x.getType() == CIMTYPE_REFERENCE) &&

CIMProperty(x).setClassOrigin(_reference.getClassName());

(x.getReferenceClassName().isNull()))

{

throw TypeMismatchException();

}

// Add the property:

Line 122

Line 143

void CIMClassRep::addMethod(const CIMMethod& x)

{

if (!x)

if (x.isUninitialized())

throw UnitializedHandle();

throw UninitializedObjectException();

// Reject duplicate method names:

if (findMethod(x.getName()) != PEG_NOT_FOUND)

if (findMethod(x.getName()) != PEG_NOT_FOUND){

throw AlreadyExists();

//l10n

//throw AlreadyExistsException

//("method \"" + x.getName().getString() + "\"");

MessageLoaderParms parms("Common.CIMClassRep.METHOD",

"method \"$0\"",

x.getName().getString());

throw AlreadyExistsException(parms);

}

// Add the method:

_methods.append(x);

}

Uint32 CIMClassRep::findMethod(const String& name)

Uint32 CIMClassRep::findMethod(const CIMName& name) const

{

for (Uint32 i = 0, n = _methods.size(); i < n; i++)

{

if (CIMName::equal(_methods[i].getName(), name))

if (name.equal(_methods[i].getName()))

return i;

}

return PEG_NOT_FOUND;

}

Boolean CIMClassRep::existsMethod(const String& name)

CIMMethod CIMClassRep::getMethod(Uint32 index)

{

return(findMethod(name) == PEG_NOT_FOUND) ? false : true;

}

CIMMethod CIMClassRep::getMethod(Uint32 pos)

{

if (pos >= _methods.size())

if (index >= _methods.size())

throw OutOfBounds();

throw IndexOutOfBoundsException();

return _methods[pos];

return _methods[index];

}

Uint32 CIMClassRep::getMethodCount() const

Line 164

Line 188

return _methods.size();

}

void CIMClassRep::removeMethod(Uint32 pos)

void CIMClassRep::removeMethod(Uint32 index)

{

if (pos >= _methods.size())

if (index >= _methods.size())

throw OutOfBounds();

throw IndexOutOfBoundsException();

_methods.remove(pos);

_methods.remove(index);

}

void CIMClassRep::resolve(

DeclContext* context,

const String& nameSpace)

const CIMNamespaceName& nameSpace)

{

PEG_METHOD_ENTER(TRC_OBJECTRESOLUTION, "CIMClassRep::resolve()");

#if 0

if (_resolved)

throw ClassAlreadyResolved(_reference.getClassName());

Line 183

Line 208

if (!context)

throw NullPointer();

if (_superClassName.size())

PEG_TRACE_STRING(TRC_OBJECTRESOLUTION, Tracer::LEVEL3,

String("CIMClassRep::resolve class = ") +

_reference.getClassName().getString() + ", superclass = " +

_superClassName.getString());

if (!_superClassName.isNull())

{

//cout << "KSTEST Class Resolve with Super class " << getClassName()

//<< " superClass " << _superClassName << endl;

//----------------------------------------------------------------------

// First check to see if the super-class really exists:

// First check to see if the super-class really exists and the subclassing legal:

//----------------------------------------------------------------------

CIMConstClass superClass

= context->lookupClass(nameSpace, _superClassName);

if (!superClass)

if (superClass.isUninitialized())

throw PEGASUS_CIM_EXCEPTION(CIM_ERR_INVALID_SUPERCLASS,_superClassName);

throw PEGASUS_CIM_EXCEPTION(CIM_ERR_INVALID_SUPERCLASS,

_superClassName.getString());

#if 0

if (!superClass._rep->_resolved)

throw ClassNotResolved(_superClassName);

#endif

// If subclass is abstract but superclass not, throw CIM Exception

/* ATTN:KS-24 Mar 2002 P1 - Test this and confirm that rule is correct

if isAbstract() && !superclass.isAbstract()

throw PEGASUS_CIM_EXCEPTION(CIM_ERR_INVALID_SUPERCLASS,_superClassName);

/*if(superclass.isTrueQualifier(CIMQualifierNames::TERMINAL)

throw PEGASUS_CIM_EXCEPTION(CIM_ERR_INVALID_SUPERCLASS,_superClassName);

//----------------------------------------------------------------------

// Iterate all the properties of *this* class. Resolve each one and

// set the class-origin:

//----------------------------------------------------------------------

Boolean isAssociationClass = isAssociation();

for (Uint32 i = 0, n = _properties.size(); i < n; i++)

{

CIMProperty& property = _properties[i];

Uint32 pos = superClass.findProperty(property.getName());

if (pos == PEG_NOT_FOUND)

if(!isAssociationClass &&

property.getValue().getType() == CIMTYPE_REFERENCE)

{

property.resolve(context, nameSpace, false, true);

//l10n

//throw PEGASUS_CIM_EXCEPTION(CIM_ERR_INVALID_PARAMETER,

//"Non-assocation class contains reference property");

throw PEGASUS_CIM_EXCEPTION_L(CIM_ERR_INVALID_PARAMETER,

MessageLoaderParms("Common.CIMClassRep.NON_ASSOCIATION_CLASS_CONTAINS_REFERENCE_PROPERTY",

"Non-assocation class contains reference property"));

}

Uint32 index = superClass.findProperty(property.getName());

if (index == PEG_NOT_FOUND)

{

Resolver::resolveProperty (property, context,

nameSpace, false, true);

if (property.getClassOrigin().isNull())

{

property.setClassOrigin(getClassName());

}

property.setPropagated(false);

}

else

{

CIMConstProperty superClassProperty =

superClass.getProperty(pos);

superClass.getProperty(index);

property.resolve(

Resolver::resolveProperty (property, context,

context, nameSpace, false, superClassProperty, true);

nameSpace, false, superClassProperty, true);

if (property.getClassOrigin().isNull())

{

property.setClassOrigin(

superClassProperty.getClassOrigin());

}

Line 237

Line 307

// insert it (setting the propagated flag). Otherwise, change

// the class-origin and propagated flag accordingly.

Uint32 pos = PEG_NOT_FOUND;

Uint32 index = PEG_NOT_FOUND;

/* ATTN: KS move to simpler version of the find

for (Uint32 j = m, n = _properties.size(); j < n; j++)

{

if (CIMName::equal(

if (CIMName::equal(_properties[j].getName(),

_properties[j].getName(),

superClassProperty.getName()))

{

pos = j;

index = j;

break;

}

index = findProperty(superClassProperty.getName());

// If property exists in super class but not in this one, then

// clone and insert it. Otherwise, the properties class

// origin was set above.

CIMProperty superproperty = superClassProperty.clone(true);

CIMProperty superproperty = superClassProperty.clone();

if (pos == PEG_NOT_FOUND)

if (index == PEG_NOT_FOUND)

{

superproperty.setPropagated(true);

_properties.insert(m++, superproperty);

}

else

{

// Property Qualifiers must propagate if allowed

// If property exists in the superclass and in the subclass,

// then, enumerate the qualifiers of the superclass's property.

// If a qualifier is defined on the superclass's property

// but not on the subclass's, then add it to the subclass's

// property's qualifier list.

CIMProperty subproperty = _properties[pos];

CIMProperty subproperty = _properties[index];

for (Uint32 i = 0, n = superproperty.getQualifierCount();

i < n;

i < n; i++)

i++) {

{

Uint32 pos = PEG_NOT_FOUND;

Uint32 index = PEG_NOT_FOUND;

CIMQualifier superClassQualifier =

superproperty.getQualifier(i);

const String name = superClassQualifier.getName();

const CIMName name = superClassQualifier.getName();

/* ATTN KS This is replacement find function.

if((Uint32 j = subproperty.findQualifier(q.getName()) == PEG_NOT_FOUND)

{

subproperty.addQualifier(superClassQualifier);

}

for (Uint32 j = 0, m = subproperty.getQualifierCount();

j < m;

j++) {

j++)

{

CIMConstQualifier q = subproperty.getQualifier(j);

if (CIMName::equal(name,

if (name.equal(q.getName()))

q.getName())) {

{

pos = j;

index = j;

break;

}

} // end comparison of subclass property's qualifiers

if (pos == PEG_NOT_FOUND) {

if (index == PEG_NOT_FOUND)

{

subproperty.addQualifier(superClassQualifier);

}

if ((index = subproperty.findQualifier(name)) == PEG_NOT_FOUND)

{

subproperty.addQualifier(superClassQualifier);

}

} // end iteration over superclass property's qualifiers

}

Line 300

Line 388

for (Uint32 i = 0, n = _methods.size(); i < n; i++)

{

CIMMethod& method = _methods[i];

Uint32 pos = superClass.findMethod(method.getName());

Uint32 index = superClass.findMethod(method.getName());

if (pos == PEG_NOT_FOUND)

if (index == PEG_NOT_FOUND)

{

method.resolve(context, nameSpace);

Resolver::resolveMethod (method, context,

nameSpace);

}

else

{

CIMConstMethod superClassMethod = superClass.getMethod(pos);

CIMConstMethod superClassMethod = superClass.getMethod(index);

method.resolve(context, nameSpace, superClassMethod);

Resolver::resolveMethod (method, context,

nameSpace, superClassMethod);

}

Line 326

Line 416

// insert it (setting the propagated flag). Otherwise, change

// the class-origin and propagated flag accordingly.

Uint32 pos = PEG_NOT_FOUND;

Uint32 index = PEG_NOT_FOUND;

/********************** KS move to simpler version

for (Uint32 j = m, n = _methods.size(); j < n; j++)

{

if (CIMName::equal(

if (CIMName::equal(_methods[j].getName(),

_methods[j].getName(),

superClassMethod.getName()))

{

pos = j;

index = j;

break;

}

Line 343

Line 432

// clone and insert it. Otherwise, the method's class origin

// has already been set above.

if (pos == PEG_NOT_FOUND)

if (index == PEG_NOT_FOUND)

{

CIMMethod method = superClassMethod.clone();

method.setPropagated(true);

_methods.insert(m++, method);

}

if((index = findMethod(superClassMethod.getName())) == PEG_NOT_FOUND)

{

CIMMethod method = superClassMethod.clone();

method.setPropagated(true);

Line 354

Line 450

//----------------------------------------------------------------------

// Validate the qualifiers of this class:

//----------------------------------------------------------------------

//cout << "KSTEST Class Qualifiers resolve for class" << getClassName() << endl;

_qualifiers.resolve(

context,

nameSpace,

Line 363

Line 459

superClass._rep->_qualifiers,

true);

}

else

else // No SuperClass exsts

{

//----------------------------------------------------------------------

// Resolve each property:

//----------------------------------------------------------------------

//cout << "KSTEST Class Resolve, No Super class " << getClassName() << endl;

for (Uint32 i = 0, n = _properties.size(); i < n; i++)

_properties[i].resolve(context, nameSpace, false, true);

{

Resolver::resolveProperty (_properties[i], context,

nameSpace, false, true);

_properties[i].setClassOrigin(getClassName());

_properties[i].setPropagated(false);

}

//----------------------------------------------------------------------

// Resolve each method:

//----------------------------------------------------------------------

for (Uint32 i = 0, n = _methods.size(); i < n; i++)

_methods[i].resolve(context, nameSpace);

Resolver::resolveMethod (_methods[i], context, nameSpace);

//----------------------------------------------------------------------

// Resolve the qualifiers:

Line 397

Line 499

// _resolved = true;

}

void CIMClassRep::toXml(Array<Sint8>& out) const

CIMInstance CIMClassRep::buildInstance(Boolean includeQualifiers,

Boolean includeClassOrigin,

const CIMPropertyList& propertyList) const

{

// Create the new instance representation

CIMInstanceRep* newInstanceRep = new CIMInstanceRep(

CIMObjectPath(String::EMPTY,

CIMNamespaceName(),

_reference.getClassName()));

// Copy qualifiers if required

if (includeQualifiers)

{

for (Uint32 i = 0 ; i < getQualifierCount() ; i++)

{

newInstanceRep->_qualifiers.add(getQualifier(i).clone());

}

newInstanceRep->_properties.reserveCapacity(_properties.size());

// Copy Properties

for (Uint32 i = 0 ; i < _properties.size() ; i++)

{

CIMConstProperty cp = getProperty(i);

CIMName name = cp.getName();

Array<CIMName> pl = propertyList.getPropertyNameArray();

if (propertyList.isNull() || Contains(pl, name))

{

CIMProperty p;

if (includeQualifiers)

{

p = getProperty(i).clone();

}

else

{

p = CIMProperty(cp.getName(),

cp.getValue(),

cp.getArraySize(),

cp.getReferenceClassName(),

cp.getClassOrigin());

}

// Delete class origin attribute if required

if (!includeClassOrigin)

{

p.setClassOrigin(CIMName());

}

newInstanceRep->_properties.append(p);

}

// Create new CIMInstance from CIMInstanceRep

CIMInstance newInstance(newInstanceRep);

return(newInstance);

}

void CIMClassRep::toXml(Buffer& out) const

{

// Class opening element:

out << "<CLASS ";

out << STRLIT("<CLASS ");

out << " NAME=\"" << _reference.getClassName() << "\" ";

out << STRLIT(" NAME=\"") << _reference.getClassName() << STRLIT("\" ");

if (_superClassName.size())

if (!_superClassName.isNull())

out << " SUPERCLASS=\"" << _superClassName << "\" ";

out << STRLIT(" SUPERCLASS=\"") << _superClassName << STRLIT("\" ");

out << ">\n";

out << STRLIT(">\n");

// Qualifiers:

// Append Class Qualifiers:

_qualifiers.toXml(out);

// Parameters:

// Append Property definitions:

for (Uint32 i = 0, n = _properties.size(); i < n; i++)

_properties[i].toXml(out);

XmlWriter::appendPropertyElement(out, _properties[i]);

// Methods:

// Append Method definitions:

for (Uint32 i = 0, n = _methods.size(); i < n; i++)

_methods[i].toXml(out);

XmlWriter::appendMethodElement(out, _methods[i]);

// Class closing element:

out << "</CLASS>\n";

out << STRLIT("</CLASS>\n");

}

/** toMof prepares an 8-bit string with the MOF for the class.

The BNF for this is:

Line 440

Line 603

void CIMClassRep::toMof(Array<Sint8>& out) const

void CIMClassRep::toMof(Buffer& out) const

{

// Get and format the class qualifiers

out << "\n// Class " << _reference.getClassName();

out << STRLIT("\n// Class ") << _reference.getClassName();

if (_qualifiers.getCount())

out << "\n";

out.append('\n');

out << "\n";

out.append('\n');

_qualifiers.toMof(out);

// Separate qualifiers from Class Name

out << "\n";

out.append('\n');

// output class statement

out << "class " << _reference.getClassName();

out << STRLIT("class ") << _reference.getClassName();

if (_superClassName.size())

if (!_superClassName.isNull())

out << " : " << _superClassName;

out << STRLIT(" : ") << _superClassName;

out << "\n{";

out << STRLIT("\n{");

// format the Properties:

for (Uint32 i = 0, n = _properties.size(); i < n; i++)

{

// Generate MOF if this property not propogated

// Generate MOF if this property not propagated

// Note that the test is required only because

// there is an error in getclass that does not

// test the localOnly flag.

// test the localOnly flag

// The inital "false" indicates to format as property declaration.

if (!_properties[i].getPropagated())

_properties[i].toMof(out);

MofWriter::appendPropertyElement(true, out, _properties[i]);

}

// Format the Methods: for non-propagated methods

for (Uint32 i = 0, n = _methods.size(); i < n; i++)

{

if (!_methods[i].getPropagated())

_methods[i].toMof(out);

MofWriter::appendMethodElement(out, _methods[i]);

}

// Class closing element:

out << "\n};\n";

out << STRLIT("\n};\n");

}

void CIMClassRep::print(PEGASUS_STD(ostream) &os) const

{

Array<Sint8> tmp;

toXml(tmp);

tmp.append('\0');

XmlWriter::indentedPrint(os, tmp.getData(), 4);

// cout << tmp.getData() << endl;

}

void CIMClassRep::printMof(PEGASUS_STD(ostream) &os) const

{

Array<Sint8> tmp;

toMof(tmp);

tmp.append('\0');

os << tmp.getData() << PEGASUS_STD(endl);

}

CIMClassRep::CIMClassRep()

{

}

CIMClassRep::CIMClassRep(const CIMClassRep& x) :

CIMObjectRep(x),

_superClassName(x._superClassName)

{

_methods.reserve(x._methods.size());

_methods.reserveCapacity(x._methods.size());

for (Uint32 i = 0, n = x._methods.size(); i < n; i++)

_methods.append(x._methods[i].clone());

}

Boolean CIMClassRep::identical(const CIMClassRep* x) const

Boolean CIMClassRep::identical(const CIMObjectRep* x) const

{

if (!CIMObjectRep::identical(x))

return false;

if (_superClassName != x->_superClassName)

const CIMClassRep* tmprep = dynamic_cast<const CIMClassRep*>(x);

if (!tmprep)

return false;

if (!_superClassName.equal (tmprep->_superClassName))

return false;

Line 529

Line 679

{

const Array<CIMMethod>& tmp1 = _methods;

const Array<CIMMethod>& tmp2 = x->_methods;

const Array<CIMMethod>& tmp2 = tmprep->_methods;

if (tmp1.size() != tmp2.size())

return false;

Line 539

Line 689

if (!tmp1[i].identical(tmp2[i]))

return false;

if (tmp1[i].getClassOrigin() != tmp2[i].getClassOrigin())

if (!tmp1[i].getClassOrigin().equal (tmp2[i].getClassOrigin()))

return false;

if (tmp1[i].getPropagated() != tmp2[i].getPropagated())

Line 547

Line 697

}

if (_resolved != x->_resolved)

if (_resolved != tmprep->_resolved)

return false;

return true;

}

void CIMClassRep::getKeyNames(Array<String>& keyNames) const

void CIMClassRep::getKeyNames(Array<CIMName>& keyNames) const

{

keyNames.clear();

Line 561

Line 711

{

CIMConstProperty property = getProperty(i);

if (property.isKey())

Uint32 index;

if ((index = property.findQualifier(

CIMNameUnchecked("key"))) != PEG_NOT_FOUND)

{

CIMValue value;

value = property.getQualifier (index).getValue ();

if (!value.isNull ())

{

Boolean isKey;

value.get (isKey);

if (isKey)

keyNames.append(property.getName());

}

Boolean CIMClassRep::hasKeys() const

{

Line 572

Line 734

{

CIMConstProperty property = getProperty(i);

if (getProperty(i).isKey())

Uint32 index;

if ((index = property.findQualifier(

CIMNameUnchecked("key"))) != PEG_NOT_FOUND)

{

CIMValue value;

value = property.getQualifier (index).getValue ();

if (!value.isNull ())

{

Boolean isKey;

value.get (isKey);

if (isKey)

return true;

}

return false;

}

Legend:

Removed from v.1.27
changed lines
	Added in v.1.74

No CVS admin address has been configured