Main Page | Class Hierarchy | Class List | File List | Class Members | File Members | Related Pages | Examples

IHandlerSoapSerializer Class Reference

interface for the IHandlerSoapSerializer class. This interface is exposed to a Handler Writer, to let him manipulate on the Serialzer object. Example usage is given below. More...

#include <IHandlerSoapSerializer.hpp>

List of all members.

Public Member Functions

virtual IHeaderBlockcreateHeaderBlock ()=0
virtual IHeaderBlockcreateHeaderBlock (const AxisChar *pachLocalName, const AxisChar *pachUri)=0
virtual int AXISCALL addHeaderBlock (IHeaderBlock *pBlk)=0
virtual int setSoapVersion (SOAP_VERSION eSOAP_VERSION)=0
virtual IHeaderBlockgetHeaderBlock (const AxisChar *pcName, const AxisChar *pcNamespace)=0
virtual IHeaderBlockgetFirstHeaderBlock ()=0
virtual IHeaderBlockgetNextHeaderBlock ()=0
virtual IHeaderBlockgetCurrentHeaderBlock ()=0
virtual int AXISCALL setBodyAsHexBinary (xsd__hexBinary body)=0
virtual int AXISCALL setBodyAsBase64Binary (xsd__base64Binary body)=0
virtual const AxisChar *AXISCALL getBodyAsString ()=0
virtual int deleteHeaderBlock (const AxisChar *pName, const AxisChar *pNamespace)=0
virtual int removeSoapHeader ()=0
virtual void addNamespaceToEnvelope (AxisChar *pachNamespaceURI, AxisChar *pachPrefix)=0


Detailed Description

interface for the IHandlerSoapSerializer class. This interface is exposed to a Handler Writer, to let him manipulate on the Serialzer object. Example usage is given below.

 int ESHHandler::invoke(void *pvIMsg)
 {
	IMessageData *pIMsg = (IMessageData*) pvIMsg;
  AxisChar* pachTemp;
	if(pIMsg->isPastPivot()) {
		//this is a response

		IHandlerSoapSerializer* pISZ;
		pIMsg->getSoapSerializer(&pISZ);

		IHeaderBlock* pIHeaderBlock= pISZ->createHeaderBlock();

		pIHeaderBlock->setLocalName("echoMeStringResponse");
 

Author:
Roshan Weerasuriya (roshan@opensource.lk, roshanw@jkcsworld.com)


Member Function Documentation

virtual int AXISCALL IHandlerSoapSerializer::addHeaderBlock IHeaderBlock pBlk  )  [pure virtual]
 

Adds the given Header Block to the Serialzer.

Parameters:
pBlk The Header Block to be added.
Returns:
AXIS_SUCCESS or AXIS_FAIL to indicate success or fail.

virtual void IHandlerSoapSerializer::addNamespaceToEnvelope AxisChar *  pachNamespaceURI,
AxisChar *  pachPrefix
[pure virtual]
 

Adds the namespace declaration to the SOAP Envelope.

virtual IHeaderBlock* IHandlerSoapSerializer::createHeaderBlock const AxisChar *  pachLocalName,
const AxisChar *  pachUri
[pure virtual]
 

Will create a Header Block using the given local name and the namespace uri, and adds it to the Serializer.

Parameters:
pachLocalName The local name of the Header Block
pachUri The namespace uri of the Header Block.
Returns:
The created Header Block pointer will be returned, which the user can manipulate on it.

virtual IHeaderBlock* IHandlerSoapSerializer::createHeaderBlock  )  [pure virtual]
 

Will create a Header Block and adds it to the Serializer.

Returns:
The created Header Block pointer will be returned, which the user can manipulate on it.

virtual int IHandlerSoapSerializer::deleteHeaderBlock const AxisChar *  pName,
const AxisChar *  pNamespace
[pure virtual]
 

Used to delete a header block

virtual IHeaderBlock* IHandlerSoapSerializer::getCurrentHeaderBlock  )  [pure virtual]
 

Used with getFirstHeaderBlock, it returns the current header block, or NULL if:

  • there are no headers,
  • or if the getFirstHeaderBlock method is not called at least once.

virtual IHeaderBlock* IHandlerSoapSerializer::getFirstHeaderBlock  )  [pure virtual]
 

Used with getNextHeaderBlock, it returns the first header block, or NULL if there are no headers.

virtual IHeaderBlock* IHandlerSoapSerializer::getHeaderBlock const AxisChar *  pcName,
const AxisChar *  pcNamespace
[pure virtual]
 

Gets and returns the Header Block of the given local name and namespace uri.After returning the Header Block pointer, it will not be removed from the available Header Block list of the Serializer. The caller of this method should not delete the returned pointer object.

virtual IHeaderBlock* IHandlerSoapSerializer::getNextHeaderBlock  )  [pure virtual]
 

Used with getFirstHeaderBlock, it returns the next header block, or NULL if there are no headers.

virtual int IHandlerSoapSerializer::removeSoapHeader  )  [pure virtual]
 

Used to delete all the header block

virtual int IHandlerSoapSerializer::setSoapVersion SOAP_VERSION  eSOAP_VERSION  )  [pure virtual]
 

Sets the SOAP Version.

Parameters:
eSOAP_VERSION The SOAP version to set.
Returns:
AXIS_SUCCESS to indicate success.


The documentation for this class was generated from the following file:
Generated on Sat Apr 9 15:11:57 2005 for AxisC++ by doxygen 1.3.8