SOAP Message classes. More...

#include <psoap.h>

Inheritance diagram for PSOAPMessage:

Collaboration diagram for PSOAPMessage:

Public Types
enum	{ NoFault, VersionMismatch, MustUnderstand, Client, Server }
	State of the PSOAPMessage when used as a response. More...

Public Types inherited from PXML
enum	ValidationOp { EndOfValidationList, DocType, ElementName, RequiredAttribute, RequiredNonEmptyAttribute, RequiredAttributeWithValue, RequiredElement, Subtree, RequiredAttributeWithValueMatching, RequiredElementWithBodyMatching, OptionalElement, OptionalAttribute, OptionalNonEmptyAttribute, OptionalAttributeWithValue, OptionalAttributeWithValueMatching, OptionalElementWithBodyMatching, SetDefaultNamespace, SetNamespace, RequiredAttributeWithValueMatchingEx = RequiredAttributeWithValueMatching + 0x8000, OptionalAttributeWithValueMatchingEx = OptionalAttributeWithValueMatching + 0x8000, RequiredElementWithBodyMatchingEx = RequiredElementWithBodyMatching + 0x8000, OptionalElementWithBodyMatchingEx = OptionalElementWithBodyMatching + 0x8000 }

Public Types inherited from PXMLBase
enum	{ DEFAULT_MAX_ENTITY_LENGTH = 65536 }

enum	StandAloneType { UninitialisedStandAlone = -2, UnknownStandAlone = -1, NotStandAlone, IsStandAlone }

Public Types inherited from PObject
enum	Comparison { LessThan = -1, EqualTo = 0, GreaterThan = 1 }
	Result of the comparison operation performed by the `Compare()` function. More...

Public Member Functions
	PSOAPMessage (Options options=Indent+NewLineAfterElement)
	Construct a SOAP message. More...

	PSOAPMessage (const PString &method, const PString &nameSpace)
	Construct a SOAP message with method name and namespace already provided. More...

void	SetMethod (const PString &name, const PString &nameSpace, const PString &methodPrefix="m:")
	Set the method name and namespace. More...

void	GetMethod (PString &name, PString &nameSpace)
	Get the method name and namespace. More...

void	AddParameter (PString name, PString type, PString value)
	Add a simple parameter called name, with type type and value value. More...

void	AddParameter (PXMLElement *parameter, PBoolean dirty=true)
	Add a parameter using a PXMLElement. More...

PBoolean	GetParameter (const PString &name, PString &value)
	Get parameter "name" with type "string". More...

PBoolean	GetParameter (const PString &name, int &value)
	Get parameter "name" with type "int". More...

PXMLElement *	GetParameter (const PString &name)
	Get parameter "name". More...

PBoolean	Load (const PString &str)
	Parse a string for a valid SOAP message. More...

PINDEX	GetFaultCode () const

PString	GetFaultText () const

void	SetFault (PINDEX code, const PString &text)

Public Member Functions inherited from PXML
	PXML (Options options=NoOptions, const char noIndentElements=NULL, const char defaultEncoding=NULL)

	PXML (const PXML &xml)

	~PXML ()

void	ReadFrom (istream &strm)
	Input the contents of the object from the stream. More...

void	PrintOn (ostream &strm) const
	Output the contents of the object to the stream. More...

PString	AsString () const

bool	IsDirty () const

bool	Load (const PString &data)

bool	Load (const PString &data, Options options, const char *defaultEncoding=NULL)

bool	LoadFile (const PFilePath &fn)

bool	LoadFile (const PFilePath &fn, Options options)

virtual bool	OnLoadProgress (unsigned) const

virtual void	OnLoaded ()

bool	Save ()

bool	Save (Options options)

PString	AsString ()

PString	AsString (Options options)

bool	SaveFile (const PFilePath &fn)

bool	SaveFile (const PFilePath &fn, Options options)

virtual bool	OnSaveProgress (unsigned) const

virtual bool	OutputProgress () const

virtual PINDEX	GetObjectCount () const

void	RemoveAll ()

virtual PBoolean	IsNoIndentElement (const PString &elementName) const

virtual PXMLElement *	CreateElement (const PCaselessString &name, const char *data=NULL)

virtual PXMLRootElement *	CreateRootElement (const PCaselessString &name)

PXMLElement *	GetElement (const PCaselessString &name, const PCaselessString &attr, const PString &attrval) const

PXMLElement *	GetElement (const PCaselessString &name, PINDEX idx=0) const

PXMLElement *	GetElement (PINDEX idx) const

PINDEX	GetNumElements () const

PXMLElement *	SetRootElement (PXMLRootElement *root)

PXMLElement *	SetRootElement (const PString &documentType)

bool	Validate (const ValidationInfo *validator)

bool	ValidateElements (ValidationContext &context, PXMLElement baseElement, const ValidationInfo elements)

bool	ValidateElement (ValidationContext &context, PXMLElement element, const ValidationInfo elements)

bool	LoadAndValidate (const PString &body, const PXML::ValidationInfo *validator, PString &error, Options options=NoOptions)

const PCaselessString &	GetVersion () const

const PCaselessString &	GetEncoding () const

StandAloneType	GetStandAlone () const

bool	IsLoaded () const

PXMLRootElement *	GetRootElement () const

PCaselessString	GetDocumentType () const

const PCaselessString &	GetDocType () const

const PCaselessString &	GetPubicIdentifier () const

const PCaselessString &	GetDtdURI () const

PString	GetErrorString () const

unsigned	GetErrorColumn () const

unsigned	GetErrorLine () const

Public Member Functions inherited from PXMLBase
	P_DECLARE_BITWISE_ENUM_EX (Options, 8,(NoOptions, Indent, IndentWithTabs, NewLineAfterElement, NoIgnoreWhiteSpace, CloseExtended, WithNS, FragmentOnly, ExpandEntities), AllOptions=(1<< 8)-1)

	PXMLBase (Options opts=NoOptions)

void	SetOptions (Options opts)

Options	GetOptions () const

void	SetMaxEntityLength (unsigned len)

unsigned	GetMaxEntityLength () const

bool	OutputIndent (ostream &strm, int indent, const PString &elementName=PString::Empty()) const

Public Member Functions inherited from PObject
__inline unsigned	GetTraceContextIdentifier () const
	Get PTRACE context identifier. More...

__inline void	SetTraceContextIdentifier (unsigned id)

__inline void	SetTraceContextIdentifier (const PObject &obj)

__inline void	SetTraceContextIdentifier (const PObject *obj)

__inline void	CopyTraceContextIdentifier (PObject &obj) const

__inline void	CopyTraceContextIdentifier (PObject *obj) const

virtual	~PObject ()

__inline const char *	GetClass () const

__inline bool	IsClass (const char *name) const

__inline const PObject *	PTraceObjectInstance () const

virtual PObject *	Clone () const
	Create a copy of the class on the heap. More...

template<class CLS >
CLS *	CloneAs () const
	As for Clone() but converts to specified type. More...

virtual PINDEX	HashFunction () const
	This function yields a hash value required by the `PDictionary` class. More...

virtual Comparison	Compare (const PObject &obj) const
	Compare the two objects and return their relative rank. More...

virtual Comparison	CompareObjectMemoryDirect (const PObject &obj) const
	Determine the byte wise comparison of two objects. More...

bool	operator== (const PObject &obj) const
	Compare the two objects. More...

bool	operator!= (const PObject &obj) const
	Compare the two objects. More...

bool	operator< (const PObject &obj) const
	Compare the two objects. More...

bool	operator> (const PObject &obj) const
	Compare the two objects. More...

bool	operator<= (const PObject &obj) const
	Compare the two objects. More...

bool	operator>= (const PObject &obj) const
	Compare the two objects. More...

Additional Inherited Members
Static Public Member Functions inherited from PXML
static PString	EscapeSpecialChars (const PString &string)

Static Public Member Functions inherited from PObject
static __inline void	CopyTraceContextIdentifier (PObject &to, const PObject &from)

static __inline void	CopyTraceContextIdentifier (PObject &to, const PObject *from)

static __inline void	CopyTraceContextIdentifier (PObject *to, const PObject &from)

static __inline void	CopyTraceContextIdentifier (PObject to, const PObject from)

static __inline const char *	Class ()

static __inline const PObject *	PTraceObjectInstance (const char *)

static __inline const PObject *	PTraceObjectInstance (const PObject *obj)

template<typename T >
static Comparison	Compare2 (T v1, T v2)
	Compare two types, returning Comparison type. More...

static Comparison	InternalCompareObjectMemoryDirect (const PObject obj1, const PObject obj2, PINDEX size)
	Internal function caled from CompareObjectMemoryDirect() More...

Protected Member Functions inherited from PObject
	PObject ()
	Constructor for PObject, made protected so cannot ever create one on its own. More...

Protected Attributes inherited from PXML
PFilePath	m_loadFilename

PCaselessString	m_version

PCaselessString	m_encoding

StandAloneType	m_standAlone

PCaselessString	m_docType

PCaselessString	m_publicId

PCaselessString	m_dtdURI

PXMLRootElement *	m_rootElement

PStringStream	m_errorString

unsigned	m_errorLine

unsigned	m_errorColumn

PSortedStringList	m_noIndentElements

PCaselessString	m_defaultNameSpace

PINDEX	m_totalObjects

PINDEX	m_savedObjects

unsigned	m_percent

Protected Attributes inherited from PXMLBase
Options	m_options

unsigned	m_maxEntityLength

Protected Attributes inherited from PObject
unsigned	m_traceContextIdentifier

Detailed Description

SOAP Message classes.

SOAP message according to http://www.w3.org/TR/SOAP/

Member Enumeration Documentation

anonymous enum

State of the PSOAPMessage when used as a response.

Enumerator
NoFault	Everything is alright.
VersionMismatch	Invalid namespace for SOAP Envelope.
MustUnderstand	Error processing SOAP Header field "mustUnderstand".
Client	The request was incorrectly formed or did not contain the appropriate information in order to succeed.
Server	The request could not be processed for reasons not directly attributable to the contents of the message itself but rather to the processing of the message.

Constructor & Destructor Documentation

PSOAPMessage::PSOAPMessage ( Options options = Indent+NewLineAfterElement )

Construct a SOAP message.

PSOAPMessage::PSOAPMessage	(	const PString &	method,
		const PString &	nameSpace
	)

Construct a SOAP message with method name and namespace already provided.

Member Function Documentation

void PSOAPMessage::AddParameter	(	PString	name,
		PString	type,
		PString	value
	)

Add a simple parameter called name, with type type and value value.

void PSOAPMessage::AddParameter	(	PXMLElement *	parameter,
		PBoolean	dirty = `true`
	)

Add a parameter using a PXMLElement.

PINDEX PSOAPMessage::GetFaultCode ( ) const

inline

PString PSOAPMessage::GetFaultText ( ) const

inline

void PSOAPMessage::GetMethod	(	PString &	name,
		PString &	nameSpace
	)

Get the method name and namespace.

PBoolean PSOAPMessage::GetParameter	(	const PString &	name,
		PString &	value
	)

Get parameter "name" with type "string".

PBoolean PSOAPMessage::GetParameter	(	const PString &	name,
		int &	value
	)

Get parameter "name" with type "int".

PXMLElement* PSOAPMessage::GetParameter ( const PString & name )

Get parameter "name".

PBoolean PSOAPMessage::Load ( const PString & str )

Parse a string for a valid SOAP message.

void PSOAPMessage::SetFault	(	PINDEX	code,
		const PString &	text
	)

void PSOAPMessage::SetMethod	(	const PString &	name,
		const PString &	nameSpace,
		const PString &	methodPrefix = `"m:"`
	)

Set the method name and namespace.

The documentation for this class was generated from the following file:

psoap.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation