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.52 and 1.90

version 1.52, 2002/08/16 01:28:06

version 1.90, 2008/12/01 17:49:47

Line 1

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

//%LICENSE////////////////////////////////////////////////////////////////

// The Open Group, Tivoli Systems

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

// Licensed to The Open Group (TOG) under one or more contributor license

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

// agreements. Refer to the OpenPegasusNOTICE.txt file distributed with

// deal in the Software without restriction, including without limitation the

// this work for additional information regarding copyright ownership.

// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or

// Each contributor licenses this file to you under the OpenPegasus Open

// sell copies of the Software, and to permit persons to whom the Software is

// Source License; you may not use this file except in compliance with the

// furnished to do so, subject to the following conditions:

// License.

// THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN

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

// ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED

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

// "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT

// to deal in the Software without restriction, including without limitation

// LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR

// the rights to use, copy, modify, merge, publish, distribute, sublicense,

// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT

// and/or sell copies of the Software, and to permit persons to whom the

// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN

// Software is furnished to do so, subject to the following conditions:

// ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION

// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

//==============================================================================

// The above copyright notice and this permission notice shall be included

// in all copies or substantial portions of the Software.

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

// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS

// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF

// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.

// IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY

// CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,

// TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE

// SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

// 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)

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

#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>

#include "StrLit.h"

#include "CIMInstanceRep.h"

#include "CIMPropertyInternal.h"

#include "CIMMethodRep.h"

PEGASUS_NAMESPACE_BEGIN

PEGASUS_USING_STD;

Line 59

Line 60

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)

return false;

Line 77

Line 78

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)

return false;

Line 92

Line 93

return flag;

}

void CIMClassRep::setSuperClassName(const CIMName& superClassName)

{

_superClassName = superClassName;

}

void CIMClassRep::addProperty(const CIMProperty& x)

{

if (x.isUninitialized())

throw UninitializedObject();

throw UninitializedObjectException();

// Reject addition of duplicate property name:

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

throw AlreadyExists();

{

MessageLoaderParms parms(

// Reject addition of references to non-associations:

"Common.CIMClassRep.PROPERTY",

"property \"$0\"",

// ATTN-RK-20020815: This is the wrong place for this check, because

x.getName().getString());

// the ASSOCIATION qualifier could be removed later

throw AlreadyExistsException(parms);

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().isNull())

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

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

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

{

throw TypeMismatchException();

}

// Add the property:

Line 128

Line 125

void CIMClassRep::addMethod(const CIMMethod& x)

{

if (x.isUninitialized())

throw UninitializedObject();

throw UninitializedObjectException();

// Reject duplicate method names:

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

throw AlreadyExists();

// Add the method:

_methods.append(x);

}

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

{

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

{

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

return i;

}

return PEG_NOT_FOUND;

}

CIMMethod CIMClassRep::getMethod(Uint32 pos)

{

if (pos >= _methods.size())

throw OutOfBounds();

return _methods[pos];

}

Uint32 CIMClassRep::getMethodCount() const

{

return _methods.size();

MessageLoaderParms parms(

"Common.CIMClassRep.METHOD",

"method \"$0\"",

x.getName().getString());

throw AlreadyExistsException(parms);

}

void CIMClassRep::removeMethod(Uint32 pos)

// Add the method:

{

if (pos >= _methods.size())

throw OutOfBounds();

_methods.remove(pos);

_methods.append(x);

}

void CIMClassRep::resolve(

Line 177

Line 148

const CIMNamespaceName& nameSpace)

{

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

#if 0

if (_resolved)

throw ClassAlreadyResolved(_reference.getClassName());

#endif

if (!context)

throw NullPointer();

PEG_TRACE_STRING(TRC_OBJECTRESOLUTION, Tracer::LEVEL3,

PEG_TRACE((TRC_OBJECTRESOLUTION, Tracer::LEVEL4,

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

"CIMClassRep::resolve class = %s, superclass = %s",

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

(const char*)_reference.getClassName().getString().getCString(),

_superClassName);

(const char*)_superClassName.getString().getCString()));

if (!_superClassName.isNull())

{

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

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

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

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

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

// subclassing legal:

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

CIMConstClass superClass

CIMConstClass superClass =

= context->lookupClass(nameSpace, _superClassName);

context->lookupClass(nameSpace, _superClassName);

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);

throw PEGASUS_CIM_EXCEPTION(

CIM_ERR_INVALID_SUPERCLASS, _superClassName);

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

throw PEGASUS_CIM_EXCEPTION(CIM_ERR_INVALID_SUPERCLASS,_superClassName);

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)

{

Resolver::resolveProperty (property, context,

throw PEGASUS_CIM_EXCEPTION_L(CIM_ERR_INVALID_PARAMETER,

nameSpace, false, true);

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);

Resolver::resolveProperty (property, context,

nameSpace, false, superClassProperty, true);

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

{

property.setClassOrigin(

superClassProperty.getClassOrigin());

}

Line 254

Line 244

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

// the class-origin and propagated flag accordingly.

Uint32 pos = PEG_NOT_FOUND;

Uint32 index = findProperty(superClassProperty.getName());

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

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

{

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

superClassProperty.getName()))

{

pos = j;

break;

}

pos = findProperty(superClassProperty.getName());

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

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

Line 274

Line 252

CIMProperty superproperty = superClassProperty.clone();

if (pos == PEG_NOT_FOUND)

if (index == PEG_NOT_FOUND)

{

superproperty.setPropagated(true);

_properties.insert(m++, superproperty);

Line 287

Line 265

// 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();

for (Uint32 j = 0, qc = superproperty.getQualifierCount();

i < n; i++)

j < qc; j++)

{

Uint32 pos = PEG_NOT_FOUND;

CIMQualifier superClassQualifier =

superproperty.getQualifier(i);

superproperty.getQualifier(j);

const CIMName name = superClassQualifier.getName();

/* ATTN KS This is replacement find function.

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

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

{

subproperty.addQualifier(superClassQualifier);

}

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

j < m;

j++)

{

CIMConstQualifier q = subproperty.getQualifier(j);

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

{

pos = j;

break;

}

} // end comparison of subclass property's qualifiers

if (pos == PEG_NOT_FOUND)

{

subproperty.addQualifier(superClassQualifier);

}

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

{

subproperty.addQualifier(superClassQualifier);

}

} // end iteration over superclass property's qualifiers

}

Line 335

Line 288

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)

{

Resolver::resolveMethod(method, context, nameSpace);

if (method.getClassOrigin().isNull())

{

Resolver::resolveMethod (method, context,

method.setClassOrigin(getClassName());

nameSpace);

}

method.setPropagated(false);

}

else

{

CIMConstMethod superClassMethod = superClass.getMethod(pos);

CIMConstMethod superClassMethod = superClass.getMethod(index);

Resolver::resolveMethod (method, context,

Resolver::resolveMethod(

nameSpace, superClassMethod);

method, context, nameSpace, superClassMethod);

}

Line 363

Line 320

// 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(_methods[j].getName(),

if (_methods[j].getName() == superClassMethod.getName())

superClassMethod.getName()))

{

pos = j;

index = j;

break;

}

Line 379

Line 335

// 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((pos = findMethod(superClassMethod.getName())) == PEG_NOT_FOUND)

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

PEG_NOT_FOUND)

{

CIMMethod method = superClassMethod.clone();

method.setPropagated(true);

_methods.insert(m++, method);

}

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

// Validate the qualifiers of this class:

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

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

_qualifiers.resolve(

context,

nameSpace,

Line 411

Line 368

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

// Resolve each property:

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

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

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

Resolver::resolveProperty (_properties[i], 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++)

{

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

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

_methods[i].setPropagated(false);

}

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

// Resolve the qualifiers:

Line 438

Line 402

dummy,

true);

}

// _resolved = true;

}

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

CIMInstance CIMClassRep::buildInstance(Boolean includeQualifiers,

Boolean includeClassOrigin,

const CIMPropertyList& propertyList) const

{

// Class opening element:

out << "<CLASS ";

// Create the new instance representation

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

CIMInstanceRep* newInstanceRep = new CIMInstanceRep(

CIMObjectPath(String::EMPTY,

CIMNamespaceName(),

_reference.getClassName()));

if (!_superClassName.isNull())

// Copy qualifiers if required

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

if (includeQualifiers)

{

out << ">\n";

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

{

// Qualifiers:

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

}

_qualifiers.toXml(out);

// Parameters:

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

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

// Methods:

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

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

// Class closing element:

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

}

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

The BNF for this is:

<pre>

classDeclaration = [ qualifierList ]

CLASS className [ alias ] [ superClass ]

"{" *classFeature "}" ";"

superClass = :" className

classFeature = propertyDeclaration | methodDeclaration

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

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

// Copy Properties

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

{

// Get and format the class qualifiers

CIMConstProperty cp = getProperty(i);

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

CIMName name = cp.getName();

if (_qualifiers.getCount())

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

out << "\n";

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

out << "\n";

{

_qualifiers.toMof(out);

CIMProperty p;

// Separate qualifiers from Class Name

out << "\n";

// output class statement

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

if (!_superClassName.isNull())

out << " : " << _superClassName;

out << "\n{";

// format the Properties:

if (includeQualifiers)

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

{

p = getProperty(i).clone();

}

else

{

// Generate MOF if this property not propagated

p = CIMProperty(cp.getName(),

// Note that the test is required only because

cp.getValue(),

// there is an error in getclass that does not

cp.getArraySize(),

// test the localOnly flag.

cp.getReferenceClassName(),

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

cp.getClassOrigin());

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

}

// Format the Methods: for non-propagated methods

// Delete class origin attribute if required

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

if (!includeClassOrigin)

{

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

p.setClassOrigin(CIMName());

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

}

// Class closing element:

newInstanceRep->_properties.append(p);

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

}

// Create new CIMInstance from CIMInstanceRep

CIMInstance newInstance(newInstanceRep);

CIMClassRep::CIMClassRep()

return newInstance;

{

}

CIMClassRep::CIMClassRep(const CIMClassRep& x) :

Line 551

Line 484

if (!tmprep)

return false;

if (_superClassName != tmprep->_superClassName)

// If the pointers are the same, the objects must be identical

if (this == tmprep)

{

return true;

}

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

return false;

Line 559

Line 498

{

const Array<CIMMethod>& tmp1 = _methods;

const MethodSet& tmp1 = _methods;

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

const MethodSet& tmp2 = tmprep->_methods;

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

return false;

Line 570

Line 509

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 578

Line 517

}

if (_resolved != tmprep->_resolved)

return false;

return true;

}

Line 592

Line 528

{

CIMConstProperty property = getProperty(i);

Uint32 pos;

if (CIMPropertyInternal::isKeyProperty(property))

if ((pos = property.findQualifier ("key")) != PEG_NOT_FOUND)

{

CIMValue value;

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

if (!value.isNull ())

{

Boolean isKey;

value.get (isKey);

if (isKey)

keyNames.append(property.getName());

}

Boolean CIMClassRep::hasKeys() const

{

for (Uint32 i = 0, n = getPropertyCount(); i < n; i++)

{

CIMConstProperty property = getProperty(i);

if (CIMPropertyInternal::isKeyProperty(property))

Uint32 pos;

if ((pos = property.findQualifier ("key")) != PEG_NOT_FOUND)

{

CIMValue value;

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

if (!value.isNull ())

{

Boolean isKey;

value.get (isKey);

if (isKey)

return true;

}

return false;

}

Legend:

Removed from v.1.52
changed lines
	Added in v.1.90

No CVS admin address has been configured