---

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

Inheritance diagram for IHandlerSoapSerializer:

List of all members.

Public Methods
virtual IHeaderBlock *	createHeaderBlock ()=0
virtual IHeaderBlock *	createHeaderBlock (AxisChar *pachLocalName, AxisChar *pachUri)=0
virtual int AXISCALL	addHeaderBlock (IHeaderBlock *pBlk)=0
virtual int	setSoapHeader (SoapHeader *pSoapHeader)=0
virtual int	setSoapVersion (SOAP_VERSION eSOAP_VERSION)=0
virtual IHeaderBlock *	getHeaderBlock ()=0
virtual IHeaderBlock *	getHeaderBlock (const AxisChar *pcName, const AxisChar *pcNamespace)=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. Implemented in SoapSerializer.

virtual IHeaderBlock* IHandlerSoapSerializer::createHeaderBlock (  AxisChar *    pachLocalName, 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. Implemented in SoapSerializer.

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. Implemented in SoapSerializer.

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. Implemented in SoapSerializer.

virtual IHeaderBlock* IHandlerSoapSerializer::getHeaderBlock (    )  [pure virtual]

Gets the Header Block. 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. Implemented in SoapSerializer.

virtual int IHandlerSoapSerializer::setSoapHeader (  SoapHeader *    pSoapHeader )  [pure virtual]

Sets the given Soap Header to the Serializer. If a Soap Header already exists then this method doesn't do anything, but returns a state to indicate this situation. Parameters: pSoapHeader  The Soap Header to be set. Returns: Returns the following status: AXIS_FAIL : to indicate failuer. AXIS_SUCCESS : to indicate success. AXIS_OBJECT_ALREADY_EXISTS : if a Soap Header already exists. Implemented in SoapSerializer.

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. Implemented in SoapSerializer.

---

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

• IHandlerSoapSerializer.h

---