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

Return to XmlWriter.h CVS log

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

Diff for /pegasus/src/Pegasus/Common/XmlWriter.h between version 1.5 and 1.94

version 1.5, 2001/02/18 03:56:01

version 1.94, 2013/03/28 19:54:32

Line 1

//BEGIN_LICENSE

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

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

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

// this work for additional information regarding copyright ownership.

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

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

// License.

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

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

Line 9

Line 14

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

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

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

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

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

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

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

//END_LICENSE

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

//BEGIN_HISTORY

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

// Author:

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

// $Log$

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

// Revision 1.5 2001/02/18 03:56:01 mike

// Changed more class names (e.g., ConstClassDecl -> CIMConstClass)

// Revision 1.4 2001/02/16 02:06:07 mike

// Renamed many classes and headers.

// Revision 1.3 2001/01/31 08:20:51 mike

// Added dispatcher framework.

// Added enumerateInstanceNames.

// Revision 1.2 2001/01/29 02:23:44 mike

// Added support for GetInstance operation

// Revision 1.1.1.1 2001/01/14 19:53:36 mike

// Pegasus import

//END_HISTORY

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

// XmlWriter.h

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

#ifndef Pegasus_XmlWriter_h

#define Pegasus_XmlWriter_h

#include <iostream>

#include <Pegasus/Common/Config.h>

#include <Pegasus/Common/Exception.h>

#include <Pegasus/Common/InternalException.h>

#include <Pegasus/Common/Array.h>

#include <Pegasus/Common/ArrayInternal.h>

#include <Pegasus/Common/String.h>

#include <Pegasus/Common/Indentor.h>

#include <Pegasus/Common/CIMObject.h>

#include <Pegasus/Common/CIMReference.h>

#include <Pegasus/Common/CIMClass.h>

#include <Pegasus/Common/CIMInstance.h>

#include <Pegasus/Common/CIMProperty.h>

#include <Pegasus/Common/CIMMethod.h>

#include <Pegasus/Common/CIMParameter.h>

#include <Pegasus/Common/CIMQualifier.h>

#include <Pegasus/Common/CIMQualifierDecl.h>

#include <Pegasus/Common/CIMValue.h>

#include <Pegasus/Common/CIMObjectPath.h>

#include <Pegasus/Common/CIMPropertyList.h>

#include <Pegasus/Common/CIMParamValue.h>

#include <Pegasus/Common/CommonUTF.h>

#include <Pegasus/Common/Message.h>

#include <Pegasus/Common/Linkage.h>

#include <Pegasus/Common/ContentLanguageList.h>

#include <Pegasus/Common/AcceptLanguageList.h>

#include <Pegasus/Common/Buffer.h>

#include <Pegasus/Common/StrLit.h>

#include <Pegasus/Common/XmlGenerator.h>

PEGASUS_NAMESPACE_BEGIN

class CIMConstQualifierDecl;

class PEGASUS_COMMON_LINKAGE XmlWriter : public XmlGenerator

class CIMConstClass;

class PEGASUS_COMMON_LINKAGE XmlWriter

{

public:

static void append(Array<Sint8>& out, Char16 x);

static void appendLocalNameSpacePathElement(

Buffer& out,

const CIMNamespaceName& nameSpace);

static void appendNameSpacePathElement(

Buffer& out,

const String& host,

const CIMNamespaceName& nameSpace);

static void appendClassNameElement(

Buffer& out,

const CIMName& className);

static void appendInstanceNameElement(

Buffer& out,

const CIMObjectPath& instanceName);

static void appendClassPathElement(

Buffer& out,

const CIMObjectPath& classPath);

static void appendInstancePathElement(

Buffer& out,

const CIMObjectPath& instancePath);

static void appendLocalClassPathElement(

Buffer& out,

const CIMObjectPath& classPath);

static void appendLocalInstancePathElement(

Buffer& out,

const CIMObjectPath& instancePath);

static void appendLocalObjectPathElement(

Buffer& out,

const CIMObjectPath& objectPath);

static void appendValueElement(

Buffer& out,

const CIMValue& value);

static void printValueElement(

const CIMValue& value,

PEGASUS_STD(ostream)& os=PEGASUS_STD(cout));

static void appendValueObjectWithPathElement(

Buffer& out,

const CIMObject& objectWithPath,

Boolean includeQualifiers = true,

Boolean includeClassOrigin = true,

Boolean isClassObject = false,

const CIMPropertyList& propertyList = CIMPropertyList());

// Appends classPath or instancePath based on isClassPath param

static void appendValueReferenceElement(

Buffer& out,

const CIMObjectPath& reference,

Boolean isClassPath,

Boolean putValueWrapper);

static void printValueReferenceElement(

const CIMObjectPath& reference,

Boolean isClassPath,

PEGASUS_STD(ostream)& os=PEGASUS_STD(cout));

static void appendValueNamedInstanceElement(

Buffer& out,

const CIMInstance& namedInstance,

Boolean includeQualifiers = true,

Boolean includeClassOrigin = true,

const CIMPropertyList& propertyList = CIMPropertyList());

static void appendClassElement(

Buffer& out,

const CIMConstClass& cimclass);

static void printClassElement(

const CIMConstClass& cimclass,

PEGASUS_STD(ostream)& os=PEGASUS_STD(cout));

static void appendInstanceElement(

Buffer& out,

const CIMConstInstance& instance,

Boolean includeQualifiers = true,

Boolean includeClassOrigin = true,

const CIMPropertyList& propertyList = CIMPropertyList());

static void printInstanceElement(

const CIMConstInstance& instance,

PEGASUS_STD(ostream)& os=PEGASUS_STD(cout));

static void appendObjectElement(

Buffer& out,

const CIMConstObject& object,

Boolean includeQualifiers = true,

Boolean includeClassOrigin = true,

const CIMPropertyList& propertyList = CIMPropertyList());

static void appendPropertyElement(

Buffer& out,

const CIMConstProperty& property,

Boolean includeQualifiers = true,

Boolean includeClassOrigin = true);

static void printPropertyElement(

const CIMConstProperty& property,

PEGASUS_STD(ostream)& os=PEGASUS_STD(cout));

static void appendMethodElement(

Buffer& out,

const CIMConstMethod& method);

static void printMethodElement(

const CIMConstMethod& method,

PEGASUS_STD(ostream)& os=PEGASUS_STD(cout));

static void appendParameterElement(

Buffer& out,

const CIMConstParameter& parameter);

static void printParameterElement(

const CIMConstParameter& parameter,

PEGASUS_STD(ostream)& os=PEGASUS_STD(cout));

static void appendParamValueElement(

Buffer& out,

const CIMParamValue& paramValue);

static void printParamValueElement(

const CIMParamValue& paramValue,

PEGASUS_STD(ostream)& os=PEGASUS_STD(cout));

static void appendQualifierElement(

Buffer& out,

const CIMConstQualifier& qualifier);

static void printQualifierElement(

const CIMConstQualifier& qualifier,

PEGASUS_STD(ostream)& os=PEGASUS_STD(cout));

static void append(Array<Sint8>& out, char x)

static void appendQualifierDeclElement(

{

Buffer& out,

append(out, Char16(x));

const CIMConstQualifierDecl& qualifierDecl);

}

static void append(Array<Sint8>& out, const char* x);

static void printQualifierDeclElement(

const CIMConstQualifierDecl& qualifierDecl,

PEGASUS_STD(ostream)& os=PEGASUS_STD(cout));

static void appendQualifierFlavorEntity(

Buffer& out,

const CIMFlavor & flavor);

static void appendScopeElement(

Buffer& out,

const CIMScope & scope);

static void append(Array<Sint8>& out, const String& x);

static void appendMethodCallHeader(

Buffer& out,

const char* host,

const CIMName& cimMethod,

const String& cimObject,

const String& authenticationHeader,

HttpMethod httpMethod,

const AcceptLanguageList& acceptLanguages,

const ContentLanguageList& contentLanguages,

Uint32 contentLength,

bool binaryRequest = false,

bool binaryResponse = false);

static void appendMethodResponseHeader(

Buffer& out,

HttpMethod httpMethod,

const ContentLanguageList& contentLanguages,

Uint32 contentLength,

Uint64 serverResponseTime = 0,

bool binaryResponse = false);

static void appendHttpErrorResponseHeader(

Buffer& out,

const String& status,

const String& cimError = String::EMPTY,

const String& errorDetail = String::EMPTY);

static void appendUnauthorizedResponseHeader(

Buffer& out,

const String& content);

#ifdef PEGASUS_KERBEROS_AUTHENTICATION

static void appendOKResponseHeader(

Buffer& out,

const String& content);

#endif

static void appendParamTypeAndEmbeddedObjAttrib(

Buffer& out,

const CIMType& type);

static void appendReturnValueElement(

Buffer& out,

const CIMValue& value);

static void append(Array<Sint8>& out, Uint32 x);

static void appendBooleanIParameter(

Buffer& out,

const char* name,

Boolean flag);

static void appendSpecial(Array<Sint8>& out, Char16 x);

static void appendStringIParameter(

Buffer& out,

const char* name,

const String& str);

static void appendSpecial(Array<Sint8>& out, char x);

static void appendClassNameIParameter(

Buffer& out,

const char* name,

const CIMName& className);

static void appendSpecial(Array<Sint8>& out, const char* x);

static void appendInstanceNameIParameter(

Buffer& out,

const char* name,

const CIMObjectPath& instanceName);

static void appendSpecial(Array<Sint8>& out, const String& x);

static void appendClassIParameter(

Buffer& out,

const char* name,

const CIMConstClass& cimClass);

static void append(Array<Sint8>& out, const Indentor& x);

static void appendInstanceIParameter(

Buffer& out,

const char* name,

const CIMConstInstance& instance);

static void appendLocalNameSpaceElement(

static void appendNamedInstanceIParameter(

Array<Sint8>& out,

Buffer& out,

const String& nameSpace);

const char* name,

const CIMInstance& namedInstance) ;

static void appendNameSpaceElement(

static void appendPropertyNameIParameter(

Array<Sint8>& out,

Buffer& out,

const String& nameSpace);

const CIMName& propertyName);

static Array<Sint8> formatGetHeader(

static void appendPropertyValueIParameter(

const char* documentPath);

Buffer& out,

const char* name,

const CIMValue& value);

static Array<Sint8> formatMPostHeader(

static void appendPropertyListIParameter(

const char* host,

Buffer& out,

const char* cimOperation,

const CIMPropertyList& propertyList);

const char* cimMethod,

const String& cimObject,

const Array<Sint8>& content);

static Array<Sint8> formatMethodResponseHeader(

static void appendQualifierDeclarationIParameter(

const Array<Sint8>& content);

Buffer& out,

const char* name,

const CIMConstQualifierDecl& qualifierDecl);

static Array<Sint8> formatMessageElement(

static Buffer formatHttpErrorRspMessage(

Uint32 messageId,

const String& status,

const Array<Sint8>& body);

const String& cimError = String::EMPTY,

const String& errorDetail = String::EMPTY);

static Array<Sint8> formatSimpleReqElement(

static Buffer formatSimpleMethodReqMessage(

const Array<Sint8>& body);

const char* host,

const CIMNamespaceName& nameSpace,

const CIMObjectPath& path,

const CIMName& methodName,

const Array<CIMParamValue>& parameters,

const String& messageId,

HttpMethod httpMethod,

const String& authenticationHeader,

const AcceptLanguageList& httpAcceptLanguages,

const ContentLanguageList& httpContentLanguages,

bool binaryResponse);

static Buffer formatSimpleMethodRspMessage(

const CIMName& methodName,

const String& messageId,

HttpMethod httpMethod,

const ContentLanguageList& httpContentLanguages,

const Buffer& body,

Uint64 serverResponseTime,

Boolean isFirst = true,

Boolean isLast = true);

static Buffer formatSimpleMethodErrorRspMessage(

const CIMName& methodName,

const String& messageId,

HttpMethod httpMethod,

const CIMException& cimException);

static Array<Sint8> formatSimpleRspElement(

static Buffer formatSimpleIMethodReqMessage(

const Array<Sint8>& body);

const char* host,

const CIMNamespaceName& nameSpace,

const CIMName& iMethodName,

const String& messageId,

HttpMethod httpMethod,

const String& authenticationHeader,

const AcceptLanguageList& httpAcceptLanguages,

const ContentLanguageList& httpContentLanguages,

const Buffer& body,

bool binaryResponse);

static Buffer formatSimpleIMethodRspMessage(

const CIMName& iMethodName,

const String& messageId,

HttpMethod httpMethod,

const ContentLanguageList& httpContentLanguages,

const Buffer& body,

Uint64 serverResponseTime,

Boolean isFirst = true,

Boolean isLast = true);

static Buffer formatSimpleIMethodErrorRspMessage(

const CIMName& iMethodName,

const String& messageId,

HttpMethod httpMethod,

const CIMException& cimException);

static Array<Sint8> formatIMethodCallElement(

static void appendInstanceEParameter(

Buffer& out,

const char* name,

const String& nameSpace,

const CIMInstance& instance);

const Array<Sint8>& iParamValues);

static Array<Sint8> formatIReturnValueElement(

static void appendEMethodRequestHeader(

const Array<Sint8>& body);

Buffer& out,

const char* requestUri,

const char* host,

const CIMName& cimMethod,

HttpMethod httpMethod,

const String& authenticationHeader,

const AcceptLanguageList& acceptLanguages,

const ContentLanguageList& contentLanguages,

Uint32 contentLength);

static void appendEMethodResponseHeader(

Buffer& out,

HttpMethod httpMethod,

const ContentLanguageList& contentLanguages,

Uint32 contentLength);

static Array<Sint8> formatIMethodResponseElement(

static Buffer formatSimpleEMethodReqMessage(

const char* name,

const char* requestUri,

const Array<Sint8>& iParamValues);

const char* host,

const CIMName& eMethodName,

const String& messageId,

HttpMethod httpMethod,

const String& authenticationHeader,

const AcceptLanguageList& httpAcceptLanguages,

const ContentLanguageList& httpContentLanguages,

const Buffer& body);

static Buffer formatSimpleEMethodRspMessage(

const CIMName& eMethodName,

const String& messageId,

HttpMethod httpMethod,

const ContentLanguageList& httpContentLanguages,

const Buffer& body);

static Buffer formatSimpleEMethodErrorRspMessage(

const CIMName& eMethodName,

const String& messageId,

HttpMethod httpMethod,

const CIMException& cimException);

static String getNextMessageId();

/** Converts the given CIMKeyBinding type to one of the following:

"boolean", "string", or "numeric"

static const StrLit keyBindingTypeToString (CIMKeyBinding::Type type);

static Array<Sint8>& formatIParamValueElement(

private:

Array<Sint8>& out,

const char* name,

const Array<Sint8>& body);

static Array<Sint8> formatErrorElement(

static void _appendMessageElementBegin(

CimException::Code code,

Buffer& out,

const char* description);

const String& messageId);

static void _appendMessageElementEnd(

Buffer& out);

static void _appendSimpleReqElementBegin(Buffer& out);

static void _appendSimpleReqElementEnd(Buffer& out);

static void _appendMethodCallElementBegin(

Buffer& out,

const CIMName& name);

static void _appendMethodCallElementEnd(

Buffer& out);

static void _appendIMethodCallElementBegin(

Buffer& out,

const CIMName& name);

static void _appendIMethodCallElementEnd(

Buffer& out);

static void _appendIParamValueElementBegin(

Buffer& out,

const char* name);

static void _appendIParamValueElementEnd(

Buffer& out);

static void _appendSimpleRspElementBegin(Buffer& out);

static void _appendSimpleRspElementEnd(Buffer& out);

static void _appendMethodResponseElementBegin(

Buffer& out,

const CIMName& name);

static void _appendMethodResponseElementEnd(

Buffer& out);

static void _appendIMethodResponseElementBegin(

Buffer& out,

const CIMName& name);

static void _appendIMethodResponseElementEnd(

Buffer& out);

static void _appendErrorElement(

Buffer& out,

const CIMException& cimException);

static void _appendIReturnValueElementBegin(Buffer& out);

static void _appendIReturnValueElementEnd(Buffer& out);

static void _appendSimpleExportReqElementBegin(Buffer& out);

static void _appendSimpleExportReqElementEnd(Buffer& out);

static void _appendEMethodCallElementBegin(

Buffer& out,

const CIMName& name);

static void _appendEMethodCallElementEnd(

Buffer& out);

static void _appendEParamValueElementBegin(

Buffer& out,

const char* name);

static void _appendEParamValueElementEnd(

Buffer& out);

static void _appendSimpleExportRspElementBegin(Buffer& out);

static void _appendSimpleExportRspElementEnd(Buffer& out);

static void _appendEMethodResponseElementBegin(

Buffer& out,

const CIMName& name);

static void _appendEMethodResponseElementEnd(

Buffer& out);

static void appendValueInstancePathElement(

Buffer& out,

const CIMObjectPath& reference);

static void appendValueClassPathElement(

Buffer& out,

const CIMObjectPath& reference);

static Array<Sint8>& appendBooleanParameter(

XmlWriter();

Array<Sint8>& out,

};

const char* parameterName,

Boolean flag);

static Array<Sint8>& appendClassNameParameter(

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

Array<Sint8>& out,

const char* parameterName,

// _toString() routines:

const String& className);

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

static Array<Sint8>& appendQualifierNameParameter(

Array<Sint8>& out,

const char* parameterName,

const String& qualifierName);

static Array<Sint8>& appendClassParameter(

Array<Sint8>& out,

const char* parameterName,

const CIMConstClass& classDecl);

static Array<Sint8>& appendInstanceNameParameter(

Array<Sint8>& out,

const char* parameterName,

const CIMReference& instanceName);

static Array<Sint8>& appendQualifierDeclarationParameter(

Array<Sint8>& out,

const char* parameterName,

const CIMConstQualifierDecl& qualifierDecl);

static Array<Sint8>& appendClassNameElement(

inline void _toString(Buffer& out, Boolean x)

Array<Sint8>& out,

{

const String& className);

XmlWriter::append(out, x);

}

static Array<Sint8>& appendInstanceNameElement(

Array<Sint8>& out,

const CIMReference& instanceName);

static void indentedPrint(

std::ostream& os,

const char* text,

Uint32 indentChars = 2);

static Array<Sint8> formatSimpleReqMessage(

inline void _toString(Buffer& out, Uint8 x)

const char* host,

{

const String& nameSpace,

XmlWriter::append(out, Uint32(x));

const char* iMethodName,

}

const Array<Sint8>& body);

static Array<Sint8> formatSimpleRspMessage(

const char* iMethodName,

const Array<Sint8>& body);

static Uint32 getNextMessageId();

inline void _toString(Buffer& out, Sint8 x)

{

XmlWriter::append(out, Sint32(x));

}

private:

inline void _toString(Buffer& out, Uint16 x)

{

XmlWriter::append(out, Uint32(x));

}

XmlWriter() { }

inline void _toString(Buffer& out, Sint16 x)

};

{

XmlWriter::append(out, Sint32(x));

}

inline Array<Sint8>& operator<<(Array<Sint8>& out, const char* x)

inline void _toString(Buffer& out, Uint32 x)

{

XmlWriter::append(out, x);

return out;

}

inline Array<Sint8>& operator<<(Array<Sint8>& out, char x)

inline void _toString(Buffer& out, Sint32 x)

{

XmlWriter::append(out, x);

return out;

}

inline Array<Sint8>& operator<<(Array<Sint8>& out, Char16 x)

inline void _toString(Buffer& out, Uint64 x)

{

XmlWriter::append(out, x);

return out;

}

inline Array<Sint8>& operator<<(Array<Sint8>& out, const String& x)

inline void _toString(Buffer& out, Sint64 x)

{

XmlWriter::append(out, x);

return out;

}

inline Array<Sint8>& operator<<(Array<Sint8>& out, const Indentor& x)

inline void _toString(Buffer& out, Real32 x)

{

XmlWriter::append(out, Real64(x));

}

inline void _toString(Buffer& out, Real64 x)

{

XmlWriter::append(out, x);

return out;

}

inline Array<Sint8>& operator<<(Array<Sint8>& out, const Array<Sint8>& x)

inline void _toString(Buffer& out, Char16 x)

{

// We need to convert the Char16 to UTF8 then append the UTF8

// character into the array.

// NOTE: The UTF8 character could be several bytes long.

// WARNING: This function will put in replacement character for

// all characters that have surogate pairs.

char str[6];

memset(str,0x00,sizeof(str));

char* charIN = (char *)&x;

const Uint16 *strsrc = (Uint16 *)charIN;

Uint16 *endsrc = (Uint16 *)&charIN[1];

Uint8 *strtgt = (Uint8 *)str;

Uint8 *endtgt = (Uint8 *)&str[5];

UTF16toUTF8(&strsrc, endsrc, &strtgt, endtgt);

out.append(str, UTF_8_COUNT_TRAIL_BYTES(str[0]) +1);

}

inline void _toString(Buffer& out, const String& x)

{

out.appendArray(x);

out << x;

return out;

}

inline Array<Sint8>& operator<<(Array<Sint8>& out, Uint32 x)

inline void _toString(Buffer& out, const CIMDateTime& x)

{

XmlWriter::append(out, x);

out << x.toString();

return out;

}

inline void _toString(Buffer& out, const CIMObjectPath& x)

{

out << x.toString();

}

inline void _toString(Buffer& out, const CIMObject& x)

{

out << x.toString();

}

inline void _toString(Buffer& out, const CIMInstance& x)

{

out << CIMObject(x).toString();

}

template<class T>

void _toString(Buffer& out, const T* p, Uint32 size)

{

while (size--)

{

_toString(out, *p++);

out.append(' ');

}

PEGASUS_NAMESPACE_END

Legend:

Removed from v.1.5
changed lines
	Added in v.1.94

No CVS admin address has been configured