version 1.164, 2008/11/25 19:27:27
|
version 1.169.4.8, 2013/09/19 10:56:58
|
|
|
//%2006//////////////////////////////////////////////////////////////////////// |
//%LICENSE//////////////////////////////////////////////////////////////// |
// | // |
// Copyright (c) 2000, 2001, 2002 BMC Software; Hewlett-Packard Development |
// Licensed to The Open Group (TOG) under one or more contributor license |
// Company, L.P.; IBM Corp.; The Open Group; Tivoli Systems. |
// agreements. Refer to the OpenPegasusNOTICE.txt file distributed with |
// Copyright (c) 2003 BMC Software; Hewlett-Packard Development Company, L.P.; |
// this work for additional information regarding copyright ownership. |
// IBM Corp.; EMC Corporation, The Open Group. |
// Each contributor licenses this file to you under the OpenPegasus Open |
// Copyright (c) 2004 BMC Software; Hewlett-Packard Development Company, L.P.; |
// Source License; you may not use this file except in compliance with the |
// IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group. |
// License. |
// Copyright (c) 2005 Hewlett-Packard Development Company, L.P.; IBM Corp.; |
// |
// EMC Corporation; VERITAS Software Corporation; The Open Group. |
// Permission is hereby granted, free of charge, to any person obtaining a |
// Copyright (c) 2006 Hewlett-Packard Development Company, L.P.; IBM Corp.; |
// copy of this software and associated documentation files (the "Software"), |
// EMC Corporation; Symantec Corporation; The Open Group. |
// to deal in the Software without restriction, including without limitation |
// |
// the rights to use, copy, modify, merge, publish, distribute, sublicense, |
// Permission is hereby granted, free of charge, to any person obtaining a copy |
// and/or sell copies of the Software, and to permit persons to whom the |
// of this software and associated documentation files (the "Software"), to |
// Software is furnished to do so, subject to the following conditions: |
// deal in the Software without restriction, including without limitation the |
// |
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or |
// The above copyright notice and this permission notice shall be included |
// sell copies of the Software, and to permit persons to whom the Software is |
// in all copies or substantial portions of the Software. |
// furnished to do so, subject to the following conditions: |
// |
// |
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS |
// THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN |
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF |
// ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED |
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. |
// "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT |
// IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY |
// LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR |
// CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, |
// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT |
// TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE |
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN |
// SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
// 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. |
|
// | // |
//============================================================================== |
////////////////////////////////////////////////////////////////////////// |
// | // |
//%///////////////////////////////////////////////////////////////////////////// | //%///////////////////////////////////////////////////////////////////////////// |
| |
|
|
#include "StrLit.h" | #include "StrLit.h" |
#include "IDFactory.h" | #include "IDFactory.h" |
#include "StringConversion.h" | #include "StringConversion.h" |
|
|
PEGASUS_NAMESPACE_BEGIN | PEGASUS_NAMESPACE_BEGIN |
| |
static StrLit _XmlWriterTypeStrings[] = |
|
{ |
|
STRLIT("TYPE=\"boolean\""), STRLIT("TYPE=\"uint8\""), |
|
STRLIT("TYPE=\"sint8\""), STRLIT("TYPE=\"uint16\""), |
|
STRLIT("TYPE=\"sint16\""), STRLIT("TYPE=\"uint32\""), |
|
STRLIT("TYPE=\"sint32\""), STRLIT("TYPE=\"uint64\""), |
|
STRLIT("TYPE=\"sint64\""), STRLIT("TYPE=\"real32\""), |
|
STRLIT("TYPE=\"real64\""), STRLIT("TYPE=\"char16\""), |
|
STRLIT("TYPE=\"string\""), STRLIT("TYPE=\"datetime\""), |
|
STRLIT("TYPE=\"reference\""), STRLIT("TYPE=\"object\""), |
|
STRLIT("TYPE=\"instance\"") |
|
}; |
|
|
|
//------------------------------------------------------------------------------ | //------------------------------------------------------------------------------ |
// | // |
// appendLocalNameSpacePathElement() | // appendLocalNameSpacePathElement() |
|
|
if (keyBindings[i].getType() == CIMKeyBinding::REFERENCE) | if (keyBindings[i].getType() == CIMKeyBinding::REFERENCE) |
{ | { |
CIMObjectPath ref = keyBindings[i].getValue(); | CIMObjectPath ref = keyBindings[i].getValue(); |
appendValueReferenceElement(out, ref, true); |
// create an instancePath (i.e. isClassPath = false) |
|
appendValueReferenceElement(out, ref, false, true); |
} | } |
else | else |
{ | { |
|
|
out << keyBindingTypeToString(keyBindings[i].getType()); | out << keyBindingTypeToString(keyBindings[i].getType()); |
out << STRLIT("\">"); | out << STRLIT("\">"); |
| |
// fixed the special character problem - Markus |
// fixed the special characters |
| |
appendSpecial(out, keyBindings[i].getValue()); | appendSpecial(out, keyBindings[i].getValue()); |
out << STRLIT("</KEYVALUE>\n"); | out << STRLIT("</KEYVALUE>\n"); |
|
|
// | // |
//------------------------------------------------------------------------------ | //------------------------------------------------------------------------------ |
| |
|
// appendValueReferenceElement does this correctly with isClassPath flag |
|
// Called only but formatSimple |
void XmlWriter::appendLocalObjectPathElement( | void XmlWriter::appendLocalObjectPathElement( |
Buffer& out, | Buffer& out, |
const CIMObjectPath& objectPath) | const CIMObjectPath& objectPath) |
|
|
// distinguish instanceNames from classNames in every case | // distinguish instanceNames from classNames in every case |
// The instanceName of a singleton instance of a keyless class has no | // The instanceName of a singleton instance of a keyless class has no |
// key bindings | // key bindings |
|
// See bBUG_3302. |
// | // |
if (objectPath.getKeyBindings ().size () != 0) | if (objectPath.getKeyBindings ().size () != 0) |
{ | { |
|
|
| |
inline void _xmlWritter_appendValue(Buffer& out, const CIMObjectPath& x) | inline void _xmlWritter_appendValue(Buffer& out, const CIMObjectPath& x) |
{ | { |
XmlWriter::appendValueReferenceElement(out, x, true); |
// Emit Instance Path with value wrapper |
|
XmlWriter::appendValueReferenceElement(out, x, false, true); |
} | } |
| |
inline void _xmlWritter_appendValue(Buffer& out, const CIMObject& x) | inline void _xmlWritter_appendValue(Buffer& out, const CIMObject& x) |
|
|
break; | break; |
} | } |
default: | default: |
PEGASUS_ASSERT(false); |
PEGASUS_UNREACHABLE(PEGASUS_ASSERT(false);) |
} | } |
} | } |
else if (value.getType() == CIMTYPE_REFERENCE) | else if (value.getType() == CIMTYPE_REFERENCE) |
|
|
break; | break; |
} | } |
default: | default: |
PEGASUS_ASSERT(false); |
PEGASUS_UNREACHABLE(PEGASUS_ASSERT(false);) |
} | } |
| |
out << STRLIT("</VALUE>\n"); | out << STRLIT("</VALUE>\n"); |
|
|
| |
void XmlWriter::appendValueObjectWithPathElement( | void XmlWriter::appendValueObjectWithPathElement( |
Buffer& out, | Buffer& out, |
const CIMObject& objectWithPath) |
const CIMObject& objectWithPath, |
|
Boolean includeQualifiers, |
|
Boolean includeClassOrigin, |
|
Boolean isClassObject, |
|
const CIMPropertyList& propertyList) |
{ | { |
out << STRLIT("<VALUE.OBJECTWITHPATH>\n"); | out << STRLIT("<VALUE.OBJECTWITHPATH>\n"); |
| |
appendValueReferenceElement(out, objectWithPath.getPath (), false); |
appendValueReferenceElement(out, objectWithPath.getPath (), |
appendObjectElement(out, objectWithPath); |
isClassObject , false); |
|
|
|
appendObjectElement( |
|
out, |
|
objectWithPath, |
|
includeQualifiers, |
|
includeClassOrigin, |
|
propertyList); |
| |
out << STRLIT("</VALUE.OBJECTWITHPATH>\n"); | out << STRLIT("</VALUE.OBJECTWITHPATH>\n"); |
} | } |
|
|
// | // |
//------------------------------------------------------------------------------ | //------------------------------------------------------------------------------ |
| |
void XmlWriter::appendValueReferenceElement( |
// appends INSTANCEPATH | LOCALINSTANCEPATH | INSTANCENAME |
|
void XmlWriter::appendValueInstancePathElement( |
Buffer& out, | Buffer& out, |
const CIMObjectPath& reference, |
const CIMObjectPath& reference) |
Boolean putValueWrapper) |
|
{ |
|
if (putValueWrapper) |
|
out << STRLIT("<VALUE.REFERENCE>\n"); |
|
|
|
// See if it is a class or instance reference (instance references have |
|
// key-bindings; class references do not). |
|
// |
|
// ATTN-CAKG-P2-20020726: The following condition does not correctly |
|
// distinguish instanceNames from classNames in every case |
|
// The instanceName of a singleton instance of a keyless class has no |
|
// key bindings |
|
// |
|
|
|
const Array<CIMKeyBinding>& kbs = reference.getKeyBindings(); |
|
|
|
if (kbs.size()) |
|
{ | { |
if (reference.getHost().size()) | if (reference.getHost().size()) |
{ | { |
|
|
appendInstanceNameElement(out, reference); | appendInstanceNameElement(out, reference); |
} | } |
} | } |
else |
|
|
// appends CLASSPATH | LOCALCLASSPATH | CLASSNAME |
|
void XmlWriter::appendValueClassPathElement( |
|
Buffer& out, |
|
const CIMObjectPath& reference) |
{ | { |
if (reference.getHost().size()) | if (reference.getHost().size()) |
{ | { |
|
|
} | } |
} | } |
| |
if (putValueWrapper) |
// Builds either a classPath or InstancePath based on isClassPath |
|
// parameter which was carried forward from, for example, the |
|
// request. If wrapper true, wrap output with <VALUE.REFERENCE> |
|
void XmlWriter::appendValueReferenceElement( |
|
Buffer& out, |
|
const CIMObjectPath& reference, |
|
Boolean isClassPath, |
|
Boolean addValueWrapper) |
|
{ |
|
if (addValueWrapper) |
|
{ |
|
out << STRLIT("<VALUE.REFERENCE>\n"); |
|
} |
|
if (isClassPath) |
|
{ |
|
appendValueClassPathElement(out,reference); |
|
} |
|
else |
|
{ |
|
appendValueInstancePathElement(out,reference); |
|
} |
|
|
|
if (addValueWrapper) |
|
{ |
out << STRLIT("</VALUE.REFERENCE>\n"); | out << STRLIT("</VALUE.REFERENCE>\n"); |
} | } |
|
} |
| |
void XmlWriter::printValueReferenceElement( | void XmlWriter::printValueReferenceElement( |
const CIMObjectPath& reference, | const CIMObjectPath& reference, |
|
Boolean isClassPath, |
PEGASUS_STD(ostream)& os) | PEGASUS_STD(ostream)& os) |
{ | { |
Buffer tmp; | Buffer tmp; |
appendValueReferenceElement(tmp, reference, true); |
appendValueReferenceElement(tmp, reference, isClassPath, true); |
indentedPrint(os, tmp.getData()); | indentedPrint(os, tmp.getData()); |
} | } |
| |
|
|
| |
void XmlWriter::appendValueNamedInstanceElement( | void XmlWriter::appendValueNamedInstanceElement( |
Buffer& out, | Buffer& out, |
const CIMInstance& namedInstance) |
const CIMInstance& namedInstance, |
|
Boolean includeQualifiers, |
|
Boolean includeClassOrigin, |
|
const CIMPropertyList& propertyList) |
{ | { |
out << STRLIT("<VALUE.NAMEDINSTANCE>\n"); | out << STRLIT("<VALUE.NAMEDINSTANCE>\n"); |
| |
appendInstanceNameElement(out, namedInstance.getPath ()); | appendInstanceNameElement(out, namedInstance.getPath ()); |
appendInstanceElement(out, namedInstance); |
appendInstanceElement( |
|
out, |
|
namedInstance, |
|
includeQualifiers, |
|
includeClassOrigin, |
|
propertyList); |
| |
out << STRLIT("</VALUE.NAMEDINSTANCE>\n"); | out << STRLIT("</VALUE.NAMEDINSTANCE>\n"); |
} | } |
| |
|
//EXP_PULL_BEGIN |
|
//------------------------------------------------------------------------------ |
|
// |
|
// appendValueInstanceWithPathElement() |
|
// |
|
// <!ELEMENT VALUE.INSTANCEWITHPATH (INSTANCEPATH,INSTANCE)> |
|
// |
|
//------------------------------------------------------------------------------ |
|
// |
|
void XmlWriter::appendValueInstanceWithPathElement( |
|
Buffer& out, |
|
const CIMInstance& namedInstance, |
|
Boolean includeQualifiers, |
|
Boolean includeClassOrigin, |
|
const CIMPropertyList& propertyList) |
|
{ |
|
out << STRLIT("<VALUE.INSTANCEWITHPATH>\n"); |
|
|
|
appendInstancePathElement(out, namedInstance.getPath ()); |
|
appendInstanceElement( |
|
out, |
|
namedInstance, |
|
includeQualifiers, |
|
includeClassOrigin, |
|
propertyList); |
|
|
|
out << STRLIT("</VALUE.INSTANCEWITHPATH>\n"); |
|
} |
|
//EXP_PULL_END |
//------------------------------------------------------------------------------ | //------------------------------------------------------------------------------ |
// | // |
// appendClassElement() | // appendClassElement() |
|
|
| |
void XmlWriter::appendInstanceElement( | void XmlWriter::appendInstanceElement( |
Buffer& out, | Buffer& out, |
const CIMConstInstance& instance) |
const CIMConstInstance& instance, |
|
Boolean includeQualifiers, |
|
Boolean includeClassOrigin, |
|
const CIMPropertyList& propertyList) |
{ | { |
CheckRep(instance._rep); | CheckRep(instance._rep); |
const CIMInstanceRep* rep = instance._rep; | const CIMInstanceRep* rep = instance._rep; |
|
|
<< STRLIT("\" >\n"); | << STRLIT("\" >\n"); |
| |
// Append Instance Qualifiers: | // Append Instance Qualifiers: |
|
if(includeQualifiers) |
|
{ |
for (Uint32 i = 0, n = rep->getQualifierCount(); i < n; i++) | for (Uint32 i = 0, n = rep->getQualifierCount(); i < n; i++) |
XmlWriter::appendQualifierElement(out, rep->getQualifier(i)); | XmlWriter::appendQualifierElement(out, rep->getQualifier(i)); |
|
} |
// Append Properties: |
if(propertyList.isNull()) |
|
{ |
for (Uint32 i = 0, n = rep->getPropertyCount(); i < n; i++) | for (Uint32 i = 0, n = rep->getPropertyCount(); i < n; i++) |
XmlWriter::appendPropertyElement(out, rep->getProperty(i)); |
{ |
|
XmlWriter::appendPropertyElement( |
|
out, |
|
rep->getProperty(i), |
|
includeQualifiers,includeClassOrigin); |
|
} |
|
} |
|
else |
|
{ |
|
for (Uint32 i = 0, n = propertyList.size(); i < n; i++) |
|
{ |
|
CIMName name = propertyList[i]; |
|
Uint32 pos = rep->_properties.find( |
|
propertyList[i], |
|
propertyList.getCIMNameTag(i)); |
|
if(pos != PEG_NOT_FOUND) |
|
{ |
|
PEG_TRACE((TRC_XML,Tracer::LEVEL4, |
|
"XmlWriter::appendInstanceElement" |
|
" Filtering the property name:%s for the className:%s" |
|
"since it was not filtered by the provider.", |
|
(const char *)name.getString().getCString(), |
|
(const char *)instance.getClassName(). |
|
getString().getCString())); |
|
|
|
XmlWriter::appendPropertyElement( |
|
out, |
|
rep->getProperty(pos), |
|
includeQualifiers,includeClassOrigin); |
|
} |
|
} |
|
|
|
} |
| |
// Instance closing element: | // Instance closing element: |
| |
|
|
| |
void XmlWriter::appendObjectElement( | void XmlWriter::appendObjectElement( |
Buffer& out, | Buffer& out, |
const CIMConstObject& object) |
const CIMConstObject& object, |
|
Boolean includeQualifiers, |
|
Boolean includeClassOrigin, |
|
const CIMPropertyList& propertyList) |
{ | { |
if (object.isClass()) | if (object.isClass()) |
{ | { |
|
|
else if (object.isInstance()) | else if (object.isInstance()) |
{ | { |
CIMConstInstance i(object); | CIMConstInstance i(object); |
appendInstanceElement(out, i); |
appendInstanceElement( |
|
out, |
|
i, |
|
includeQualifiers, |
|
includeClassOrigin, |
|
propertyList); |
} | } |
// else PEGASUS_ASSERT(0); | // else PEGASUS_ASSERT(0); |
} | } |
|
|
| |
void XmlWriter::appendPropertyElement( | void XmlWriter::appendPropertyElement( |
Buffer& out, | Buffer& out, |
const CIMConstProperty& property) |
const CIMConstProperty& property, |
|
Boolean includeQualifiers, |
|
Boolean includeClassOrigin) |
{ | { |
CheckRep(property._rep); | CheckRep(property._rep); |
const CIMPropertyRep* rep = property._rep; | const CIMPropertyRep* rep = property._rep; |
|
|
// Note that if the macro PEGASUS_SNIA_INTEROP_COMPATIBILITY is | // Note that if the macro PEGASUS_SNIA_INTEROP_COMPATIBILITY is |
// defined, then the EmbeddedInstance qualifier will be added | // defined, then the EmbeddedInstance qualifier will be added |
# ifdef PEGASUS_SNIA_INTEROP_COMPATIBILITY | # ifdef PEGASUS_SNIA_INTEROP_COMPATIBILITY |
if (rep->findQualifier(PEGASUS_QUALIFIERNAME_EMBEDDEDINSTANCE == |
if (rep->findQualifier(PEGASUS_QUALIFIERNAME_EMBEDDEDINSTANCE) |
PEG_NOT_FOUND) |
== PEG_NOT_FOUND) |
{ | { |
// Note that addQualifiers() cannot be called on a const | // Note that addQualifiers() cannot be called on a const |
// CIMQualifierRep. In this case we really do want to add | // CIMQualifierRep. In this case we really do want to add |
|
|
else | else |
{ | { |
out.append(' '); | out.append(' '); |
out << _XmlWriterTypeStrings[rep->getValue().getType()]; |
out << xmlWriterTypeStrings(rep->getValue().getType()); |
} | } |
| |
if (rep->getArraySize()) | if (rep->getArraySize()) |
|
|
out.append('"'); | out.append('"'); |
} | } |
| |
if (!rep->getClassOrigin().isNull()) |
if(includeClassOrigin && !rep->getClassOrigin().isNull()) |
{ | { |
out << STRLIT(" CLASSORIGIN=\"") << rep->getClassOrigin(); | out << STRLIT(" CLASSORIGIN=\"") << rep->getClassOrigin(); |
out.append('"'); | out.append('"'); |
|
|
} | } |
| |
out << STRLIT(">\n"); | out << STRLIT(">\n"); |
|
if(includeQualifiers) |
|
{ |
for (Uint32 i = 0, n = rep->getQualifierCount(); i < n; i++) | for (Uint32 i = 0, n = rep->getQualifierCount(); i < n; i++) |
XmlWriter::appendQualifierElement(out, rep->getQualifier(i)); | XmlWriter::appendQualifierElement(out, rep->getQualifier(i)); |
|
} |
| |
XmlWriter::appendValueElement(out, rep->getValue()); | XmlWriter::appendValueElement(out, rep->getValue()); |
| |
|
|
out << STRLIT(" REFERENCECLASS=\"") << rep->getReferenceClassName(); | out << STRLIT(" REFERENCECLASS=\"") << rep->getReferenceClassName(); |
out.append('"'); | out.append('"'); |
} | } |
|
if(includeClassOrigin && !rep->getClassOrigin().isNull()) |
if (!rep->getClassOrigin().isNull()) |
|
{ | { |
out << STRLIT(" CLASSORIGIN=\"") << rep->getClassOrigin(); | out << STRLIT(" CLASSORIGIN=\"") << rep->getClassOrigin(); |
out.append('"'); | out.append('"'); |
|
|
} | } |
| |
out << STRLIT(">\n"); | out << STRLIT(">\n"); |
|
if(includeQualifiers) |
|
{ |
for (Uint32 i = 0, n = rep->getQualifierCount(); i < n; i++) | for (Uint32 i = 0, n = rep->getQualifierCount(); i < n; i++) |
XmlWriter::appendQualifierElement(out, rep->getQualifier(i)); | XmlWriter::appendQualifierElement(out, rep->getQualifier(i)); |
|
} |
| |
XmlWriter::appendValueElement(out, rep->getValue()); | XmlWriter::appendValueElement(out, rep->getValue()); |
| |
|
|
else | else |
{ | { |
out << STRLIT("<PROPERTY NAME=\"") << rep->getName() << STRLIT("\" "); | out << STRLIT("<PROPERTY NAME=\"") << rep->getName() << STRLIT("\" "); |
|
if(includeClassOrigin && !rep->getClassOrigin().isNull()) |
if (!rep->getClassOrigin().isNull()) |
|
{ | { |
out << STRLIT(" CLASSORIGIN=\"") << rep->getClassOrigin(); | out << STRLIT(" CLASSORIGIN=\"") << rep->getClassOrigin(); |
out.append('"'); | out.append('"'); |
|
|
else | else |
{ | { |
out.append(' '); | out.append(' '); |
out << _XmlWriterTypeStrings[rep->getValue().getType()]; |
out << xmlWriterTypeStrings(rep->getValue().getType()); |
} | } |
| |
out << STRLIT(">\n"); | out << STRLIT(">\n"); |
|
if(includeQualifiers) |
|
{ |
for (Uint32 i = 0, n = rep->getQualifierCount(); i < n; i++) | for (Uint32 i = 0, n = rep->getQualifierCount(); i < n; i++) |
XmlWriter::appendQualifierElement(out, rep->getQualifier(i)); | XmlWriter::appendQualifierElement(out, rep->getQualifier(i)); |
|
} |
| |
XmlWriter::appendValueElement(out, rep->getValue()); | XmlWriter::appendValueElement(out, rep->getValue()); |
| |
|
|
out << STRLIT("<METHOD NAME=\"") << rep->getName(); | out << STRLIT("<METHOD NAME=\"") << rep->getName(); |
out << STRLIT("\" "); | out << STRLIT("\" "); |
| |
out << _XmlWriterTypeStrings[rep->getType()]; |
out << xmlWriterTypeStrings(rep->getType()); |
| |
if (!rep->getClassOrigin().isNull()) | if (!rep->getClassOrigin().isNull()) |
{ | { |
|
|
{ | { |
out << STRLIT("<PARAMETER.ARRAY" | out << STRLIT("<PARAMETER.ARRAY" |
" NAME=\"") << rep->getName(); | " NAME=\"") << rep->getName(); |
out << STRLIT("\" ") << _XmlWriterTypeStrings[rep->getType()]; |
out << STRLIT("\" ") << xmlWriterTypeStrings(rep->getType()); |
| |
if (rep->getArraySize()) | if (rep->getArraySize()) |
{ | { |
|
|
{ | { |
out << STRLIT("<PARAMETER" | out << STRLIT("<PARAMETER" |
" NAME=\"") << rep->getName(); | " NAME=\"") << rep->getName(); |
out << STRLIT("\" ") << _XmlWriterTypeStrings[rep->getType()]; |
out << STRLIT("\" ") << xmlWriterTypeStrings(rep->getType()); |
| |
out << STRLIT(">\n"); | out << STRLIT(">\n"); |
| |
|
|
const CIMQualifierRep* rep = qualifier._rep; | const CIMQualifierRep* rep = qualifier._rep; |
| |
out << STRLIT("<QUALIFIER NAME=\"") << rep->getName(); | out << STRLIT("<QUALIFIER NAME=\"") << rep->getName(); |
out << STRLIT("\" ") << _XmlWriterTypeStrings[rep->getValue().getType()]; |
out << STRLIT("\" ") << xmlWriterTypeStrings(rep->getValue().getType()); |
| |
if (rep->getPropagated()) | if (rep->getPropagated()) |
{ | { |
|
|
const CIMQualifierDeclRep* rep = qualifierDecl._rep; | const CIMQualifierDeclRep* rep = qualifierDecl._rep; |
| |
out << STRLIT("<QUALIFIER.DECLARATION NAME=\"") << rep->getName(); | out << STRLIT("<QUALIFIER.DECLARATION NAME=\"") << rep->getName(); |
out << STRLIT("\" ") << _XmlWriterTypeStrings[rep->getValue().getType()]; |
out << STRLIT("\" ") << xmlWriterTypeStrings(rep->getValue().getType()); |
| |
if (rep->getValue().isArray()) | if (rep->getValue().isArray()) |
{ | { |
|
|
// TOINSTANCE (true|false) 'false' | // TOINSTANCE (true|false) 'false' |
// TRANSLATABLE (true|false) 'false'"> | // TRANSLATABLE (true|false) 'false'"> |
// | // |
|
// DEPRECATION NOTE: The attribute TOINSTANCE is DEPRECATED and MAY be |
|
// removed from the QualifierFlavor entity in a future version of this |
|
// document. Use of this qualifier is discouraged. |
|
// |
//------------------------------------------------------------------------------ | //------------------------------------------------------------------------------ |
| |
void XmlWriter::appendQualifierFlavorEntity( | void XmlWriter::appendQualifierFlavorEntity( |
|
|
if (!(flavor.hasFlavor (CIMFlavor::TOSUBCLASS))) | if (!(flavor.hasFlavor (CIMFlavor::TOSUBCLASS))) |
out << STRLIT(" TOSUBCLASS=\"false\""); | out << STRLIT(" TOSUBCLASS=\"false\""); |
| |
if (flavor.hasFlavor (CIMFlavor::TOINSTANCE)) |
//if (flavor.hasFlavor (CIMFlavor::TOINSTANCE)) |
out << STRLIT(" TOINSTANCE=\"true\""); |
// out << STRLIT(" TOINSTANCE=\"true\""); |
| |
if (flavor.hasFlavor (CIMFlavor::TRANSLATABLE)) | if (flavor.hasFlavor (CIMFlavor::TRANSLATABLE)) |
out << STRLIT(" TRANSLATABLE=\"true\""); | out << STRLIT(" TRANSLATABLE=\"true\""); |
|
|
bool binaryRequest, | bool binaryRequest, |
bool binaryResponse) | bool binaryResponse) |
{ | { |
char nn[] = { '0' + (rand() % 10), '0' + (rand() % 10), '\0' }; |
char nn[] = { char('0' + (rand() % 10)), char('0' + (rand() % 10)),'\0'}; |
| |
// ATTN: KS 20020926 - Temporary change to issue only POST. This may | // ATTN: KS 20020926 - Temporary change to issue only POST. This may |
// be changed in the DMTF CIM Operations standard in the future. | // be changed in the DMTF CIM Operations standard in the future. |
|
|
} | } |
else | else |
{ | { |
out << STRLIT("Content-Type: application/xml; charset=\"utf-8\"\r\n"); |
out << STRLIT("Content-Type: application/xml; charset=utf-8\r\n"); |
} | } |
| |
if (binaryResponse) | if (binaryResponse) |
|
|
} | } |
else | else |
{ | { |
out << STRLIT("Content-Type: application/xml; charset=\"utf-8\"\r\n"); |
out << STRLIT("Content-Type: application/xml; charset=utf-8\r\n"); |
} | } |
| |
OUTPUT_CONTENTLENGTH(out, contentLength); | OUTPUT_CONTENTLENGTH(out, contentLength); |
|
|
} | } |
if (httpMethod == HTTP_METHOD_M_POST) | if (httpMethod == HTTP_METHOD_M_POST) |
{ | { |
char nn[] = { '0' + (rand() % 10), '0' + (rand() % 10), '\0' }; |
char nn[] = {char('0'+(rand() % 10)),char('0' + (rand() % 10)),'\0'}; |
| |
out << STRLIT("Ext:\r\n" | out << STRLIT("Ext:\r\n" |
"Cache-Control: no-cache\r\n" | "Cache-Control: no-cache\r\n" |
|
|
// Returns unauthorized message in the following format: | // Returns unauthorized message in the following format: |
// | // |
// HTTP/1.1 401 Unauthorized | // HTTP/1.1 401 Unauthorized |
|
// PGErrorDetail: <error text> (if specified by caller) |
// WWW-Authenticate: Basic realm="HostName" | // WWW-Authenticate: Basic realm="HostName" |
// <HTML><HEAD> | // <HTML><HEAD> |
// <TITLE>401 Unauthorized</TITLE> | // <TITLE>401 Unauthorized</TITLE> |
|
|
| |
void XmlWriter::appendUnauthorizedResponseHeader( | void XmlWriter::appendUnauthorizedResponseHeader( |
Buffer& out, | Buffer& out, |
|
const String& errorDetail, |
const String& content) | const String& content) |
{ | { |
out << STRLIT("HTTP/1.1 " HTTP_STATUS_UNAUTHORIZED "\r\n"); | out << STRLIT("HTTP/1.1 " HTTP_STATUS_UNAUTHORIZED "\r\n"); |
|
if (errorDetail.size() > 0) |
|
{ |
|
out << STRLIT(PEGASUS_HTTPHEADERTAG_ERRORDETAIL ": ") |
|
<< encodeURICharacters(errorDetail) << STRLIT("\r\n"); |
|
} |
|
|
OUTPUT_CONTENTLENGTH(out, 0); | OUTPUT_CONTENTLENGTH(out, 0); |
out << content << STRLIT("\r\n\r\n"); | out << content << STRLIT("\r\n\r\n"); |
| |
|
|
out << STRLIT("</IPARAMVALUE>\n"); | out << STRLIT("</IPARAMVALUE>\n"); |
} | } |
| |
|
//EXP_PULL_BEGIN |
|
//------------------------------------------------------------------------------ |
|
// |
|
// _appendParamValueElementBegin() |
|
// _appendParamValueElementEnd() |
|
// |
|
// <!ELEMENT IPARAMVALUE (VALUE|VALUE.ARRAY|VALUE.REFERENCE |
|
// |INSTANCENAME|CLASSNAME|QUALIFIER.DECLARATION |
|
// |CLASS|INSTANCE|VALUE.NAMEDINSTANCE)?> |
|
// <!ATTLIST IPARAMVALUE %CIMName;> |
|
// |
|
//------------------------------------------------------------------------------ |
|
|
|
void XmlWriter::_appendParamValueElementBegin( |
|
Buffer& out, |
|
const char* name) |
|
{ |
|
out << STRLIT("<PARAMVALUE NAME=\"") << name << STRLIT("\">\n"); |
|
} |
|
|
|
void XmlWriter::_appendParamValueElementEnd( |
|
Buffer& out) |
|
{ |
|
out << STRLIT("</PARAMVALUE>\n"); |
|
} |
|
//EXP_PULL_END |
|
|
//------------------------------------------------------------------------------ | //------------------------------------------------------------------------------ |
// | // |
// _appendSimpleRspElementBegin() | // _appendSimpleRspElementBegin() |
|
|
} | } |
else | else |
{ | { |
out << STRLIT(" PARAM") << _XmlWriterTypeStrings[type]; |
out << STRLIT(" PARAM") << xmlWriterTypeStrings(type); |
} | } |
} | } |
| |
|
|
out << STRLIT("</IRETURNVALUE>\n"); | out << STRLIT("</IRETURNVALUE>\n"); |
} | } |
| |
|
//EXP_PULL_BEGIN |
|
void XmlWriter::_appendIReturnValueElementWithNameBegin( |
|
Buffer& out, |
|
const char* name) |
|
{ |
|
out << STRLIT("<IRETURNVALUE NAME=\"") << name << STRLIT("\">\n"); |
|
} |
|
//EXP_PULL_END |
|
|
//------------------------------------------------------------------------------ | //------------------------------------------------------------------------------ |
// | // |
// appendBooleanIParameter() | // appendBooleanIParameter() |
|
|
_appendIParamValueElementEnd(out); | _appendIParamValueElementEnd(out); |
} | } |
| |
|
//EXP_PULL_BEGIN |
|
void XmlWriter::appendBooleanParameter( |
|
Buffer& out, |
|
const char* name, |
|
Boolean flag) |
|
{ |
|
_appendParamValueElementBegin(out, name); |
|
out << STRLIT("<VALUE>"); |
|
append(out, flag); |
|
out << STRLIT("</VALUE>\n"); |
|
_appendParamValueElementEnd(out); |
|
} |
|
|
|
void XmlWriter::appendBooleanIReturnValue( |
|
Buffer& out, |
|
const char* name, |
|
Boolean flag) |
|
{ |
|
_appendIReturnValueElementWithNameBegin(out, name); |
|
out << STRLIT("<VALUE>"); |
|
append(out, flag); |
|
out << STRLIT("</VALUE>\n"); |
|
_appendIReturnValueElementEnd(out); |
|
} |
|
void XmlWriter::appendUint32IParameter( |
|
Buffer& out, |
|
const char* name, |
|
Uint32 val) |
|
{ |
|
_appendIParamValueElementBegin(out, name); |
|
out << STRLIT("<VALUE>"); |
|
append(out, val); |
|
out << STRLIT("</VALUE>\n"); |
|
_appendIParamValueElementEnd(out); |
|
} |
|
|
|
// Can be used to generate either parameters with value, |
|
// parameters with NULL (i.e. no value element) or |
|
// no parameters output at all. |
|
void XmlWriter::appendUint32ArgIParameter( |
|
Buffer& out, |
|
const char* name, |
|
const Uint32Arg& val, |
|
const Boolean required) |
|
{ |
|
if (!required && val.isNull()) |
|
{ |
|
return; |
|
} |
|
|
|
_appendIParamValueElementBegin(out, name); |
|
if (!val.isNull()) |
|
{ |
|
out << STRLIT("<VALUE>"); |
|
append(out, val.getValue()); |
|
out << STRLIT("</VALUE>\n"); |
|
} |
|
_appendIParamValueElementEnd(out); |
|
} |
|
|
|
/* Output return value from Uint64Arg object as |
|
Value inside IRETURNVALUE |
|
If the state of the object is NULL output |
|
the parameter without value. Else |
|
output the value |
|
*/ |
|
void XmlWriter::appendUint64ReturnValue( |
|
Buffer& out, |
|
const char* name, |
|
const Uint64Arg& val) |
|
{ |
|
_appendIReturnValueElementBegin(out); |
|
out << STRLIT("<VALUE>"); |
|
if (!val.isNull()) |
|
{ |
|
append(out, val.getValue()); |
|
} |
|
out << STRLIT("</VALUE>\n"); |
|
_appendIReturnValueElementEnd(out); |
|
} |
|
//EXP_PULL_END |
|
|
//------------------------------------------------------------------------------ | //------------------------------------------------------------------------------ |
// | // |
// appendStringIParameter() | // appendStringIParameter() |
|
|
_appendIParamValueElementEnd(out); | _appendIParamValueElementEnd(out); |
} | } |
| |
|
// EXP_PULL_BEGIN |
|
//------------------------------------------------------------------------------ |
|
// |
|
// appendStringIParameterIfNotEmpty() |
|
// |
|
//------------------------------------------------------------------------------ |
|
|
|
void XmlWriter::appendStringIParameterIfNotEmpty( |
|
Buffer& out, |
|
const char* name, |
|
const String& str) |
|
{ |
|
if (str != String::EMPTY) |
|
{ |
|
appendStringIParameter(out,name,str); |
|
} |
|
} |
|
|
|
//------------------------------------------------------------------------------ |
|
// |
|
// appendStringParameter() |
|
// |
|
//------------------------------------------------------------------------------ |
|
|
|
void XmlWriter::appendStringParameter( |
|
Buffer& out, |
|
const char* name, |
|
const String& str) |
|
{ |
|
_appendParamValueElementBegin(out, name); |
|
out << STRLIT("<VALUE>"); |
|
appendSpecial(out, str); |
|
out << STRLIT("</VALUE>\n"); |
|
_appendParamValueElementEnd(out); |
|
} |
|
|
|
//------------------------------------------------------------------------------ |
|
// |
|
// appendStringIReturnValue() |
|
// |
|
//------------------------------------------------------------------------------ |
|
|
|
void XmlWriter::appendStringIReturnValue( |
|
Buffer& out, |
|
const char* name, |
|
const String& str) |
|
{ |
|
_appendIReturnValueElementWithNameBegin(out, name); |
|
out << STRLIT("<VALUE>"); |
|
appendSpecial(out, str); |
|
out << STRLIT("</VALUE>\n"); |
|
_appendIReturnValueElementEnd(out); |
|
} |
|
//EXP_PULL_END |
//------------------------------------------------------------------------------ | //------------------------------------------------------------------------------ |
// | // |
// appendClassNameIParameter() | // appendClassNameIParameter() |
|
|
_appendIParamValueElementEnd(out); | _appendIParamValueElementEnd(out); |
} | } |
| |
void XmlWriter::appendObjectNameIParameter( |
|
Buffer& out, |
|
const char* name, |
|
const CIMObjectPath& objectName) |
|
{ |
|
// |
|
// ATTN-CAKG-P2-20020726: The following condition does not correctly |
|
// distinguish instanceNames from classNames in every case |
|
// The instanceName of a singleton instance of a keyless class also |
|
// has no key bindings |
|
// |
|
if (objectName.getKeyBindings ().size () == 0) |
|
{ |
|
XmlWriter::appendClassNameIParameter( |
|
out, name, objectName.getClassName()); |
|
} |
|
else |
|
{ |
|
XmlWriter::appendInstanceNameIParameter( |
|
out, name, objectName); |
|
} |
|
} |
|
|
|
//------------------------------------------------------------------------------ | //------------------------------------------------------------------------------ |
// | // |
// appendClassIParameter() | // appendClassIParameter() |
|
|
const String& messageId, | const String& messageId, |
HttpMethod httpMethod, | HttpMethod httpMethod, |
const ContentLanguageList& httpContentLanguages, | const ContentLanguageList& httpContentLanguages, |
|
const Buffer& bodyParams, |
const Buffer& body, | const Buffer& body, |
Uint64 serverResponseTime, | Uint64 serverResponseTime, |
Boolean isFirst, | Boolean isFirst, |
|
|
// | // |
//------------------------------------------------------------------------------ | //------------------------------------------------------------------------------ |
| |
|
/* |
|
Formats a IMethod Response Message. This function formats |
|
messages for chunking based on the isFirst and isLast parameters. |
|
If isFirst is set, it outputs headers and ResponseElement begin. |
|
It always sends the body. If isLast is set, it sends the rtnParams |
|
and the ResponseElement end followed by any parameter in the rtnParams. |
|
KS_PULL_TBD_TODO - Determine what we want to do with chunking. Since this |
|
This whole thing is based on the concept of each message sending a single |
|
chunk and we will want in the future to modify so we can chose easily |
|
whether we want to chunk or not and send the chunks. |
|
*/ |
Buffer XmlWriter::formatSimpleIMethodRspMessage( | Buffer XmlWriter::formatSimpleIMethodRspMessage( |
const CIMName& iMethodName, | const CIMName& iMethodName, |
const String& messageId, | const String& messageId, |
HttpMethod httpMethod, | HttpMethod httpMethod, |
const ContentLanguageList& httpContentLanguages, | const ContentLanguageList& httpContentLanguages, |
|
const Buffer& rtnParams, |
const Buffer& body, | const Buffer& body, |
Uint64 serverResponseTime, | Uint64 serverResponseTime, |
Boolean isFirst, | Boolean isFirst, |
|
|
{ | { |
if (body.size() != 0 || isFirst == false) | if (body.size() != 0 || isFirst == false) |
_appendIReturnValueElementEnd(out); | _appendIReturnValueElementEnd(out); |
|
|
|
// Insert any return parameters. |
|
if (rtnParams.size() != 0) |
|
{ |
|
out << rtnParams; |
|
} |
|
// //EXP_PULL_END |
|
|
_appendIMethodResponseElementEnd(out); | _appendIMethodResponseElementEnd(out); |
_appendSimpleRspElementEnd(out); | _appendSimpleRspElementEnd(out); |
_appendMessageElementEnd(out); | _appendMessageElementEnd(out); |
|
|
const ContentLanguageList& contentLanguages, | const ContentLanguageList& contentLanguages, |
Uint32 contentLength) | Uint32 contentLength) |
{ | { |
char nn[] = { '0' + (rand() % 10), '0' + (rand() % 10), '\0' }; |
char nn[] = { char('0' + (rand() % 10)), char('0' + (rand() % 10)), '\0' }; |
| |
if (httpMethod == HTTP_METHOD_M_POST) | if (httpMethod == HTTP_METHOD_M_POST) |
{ | { |
|
|
out << STRLIT("POST ") << requestUri << STRLIT(" HTTP/1.1\r\n"); | out << STRLIT("POST ") << requestUri << STRLIT(" HTTP/1.1\r\n"); |
} | } |
out << STRLIT("HOST: ") << host << STRLIT("\r\n" | out << STRLIT("HOST: ") << host << STRLIT("\r\n" |
"Content-Type: application/xml; charset=\"utf-8\"\r\n"); |
"Content-Type: application/xml; charset=utf-8\r\n"); |
OUTPUT_CONTENTLENGTH(out, contentLength); | OUTPUT_CONTENTLENGTH(out, contentLength); |
| |
if (acceptLanguages.size() > 0) | if (acceptLanguages.size() > 0) |
|
|
const ContentLanguageList& contentLanguages, | const ContentLanguageList& contentLanguages, |
Uint32 contentLength) | Uint32 contentLength) |
{ | { |
char nn[] = { '0' + (rand() % 10), '0' + (rand() % 10), '\0' }; |
char nn[] = { char('0' + (rand() % 10)), char('0' + (rand() % 10)), '\0' }; |
| |
out << STRLIT("HTTP/1.1 " HTTP_STATUS_OK "\r\n" | out << STRLIT("HTTP/1.1 " HTTP_STATUS_OK "\r\n" |
"Content-Type: application/xml; charset=\"utf-8\"\r\n"); |
"Content-Type: application/xml; charset=utf-8\r\n"); |
OUTPUT_CONTENTLENGTH(out, contentLength); | OUTPUT_CONTENTLENGTH(out, contentLength); |
| |
if (contentLanguages.size() > 0) | if (contentLanguages.size() > 0) |
|
|
| |
case CIMKeyBinding::REFERENCE: | case CIMKeyBinding::REFERENCE: |
default: | default: |
PEGASUS_ASSERT(false); |
PEGASUS_UNREACHABLE(PEGASUS_ASSERT(false);) |
} | } |
| |
return STRLIT("unknown"); | return STRLIT("unknown"); |