Main Page   Class Hierarchy   Compound List   File List   Compound Members   Examples  

SoapSerializer Class Reference

interface for the SoapSerializer class. More...

#include <SoapSerializer.h>

Inheritance diagram for SoapSerializer:

IHandlerSoapSerializer List of all members.

Public Methods

const AxisChar *AXISCALL getNamespacePrefix (const AxisChar *pNamespace)
const AxisChar *AXISCALL getNamespacePrefix (const AxisChar *pNamespace, bool &blnIsNewPrefix)
int setSoapVersion (SOAP_VERSION)
int setSoapHeader (SoapHeader *pSoapHeader)
IHeaderBlock * createHeaderBlock ()
IHeaderBlock * getHeaderBlock (const AxisChar *pcName, const AxisChar *pcNamespace)
IHeaderBlock * getHeaderBlock ()
IHeaderBlock * createHeaderBlock (AxisChar *pachLocalName, AxisChar *pachUri)
int AXISCALL addHeaderBlock (IHeaderBlock *pBlk)
int AXISCALL setBodyAsHexBinary (xsd__hexBinary body)
int AXISCALL setBodyAsBase64Binary (xsd__base64Binary body)
const AxisChar *AXISCALL getBodyAsString ()

Detailed Description

interface for the SoapSerializer class.

Author:
Roshan Weerasuriya (roshan@jkcs.slt.lk, roshan@opensource.lk) , Susantha Kumara (susantha@opensource.lk, skumara@virtusa.com)

Member Function Documentation

int AXISCALL SoapSerializer::addHeaderBlock (  IHeaderBlock *    pBlk )  [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.

Implements IHandlerSoapSerializer.

IHeaderBlock* SoapSerializer::createHeaderBlock (  AxisChar *    pachLocalName,
AxisChar *    pachUri
)  [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.

Implements IHandlerSoapSerializer.

IHeaderBlock* SoapSerializer::createHeaderBlock (    )  [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.

Implements IHandlerSoapSerializer.

IHeaderBlock* SoapSerializer::getHeaderBlock (    )  [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.

Implements IHandlerSoapSerializer.

IHeaderBlock* SoapSerializer::getHeaderBlock (  const AxisChar *    pcName,
const AxisChar *    pcNamespace
)  [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.

Implements IHandlerSoapSerializer.

const AxisChar* AXISCALL SoapSerializer::getNamespacePrefix (  const AxisChar *    pNamespace,
bool &    blnIsNewPrefix
) 
 

Returns the corrosponding namespace prefix. This method is called when the caller also wants to know whether this is a new namespace or not as appose to its overloaded other member.

Parameters:
pNamespace  The namespace.
blnIsNewPrefix  The boolean which behaves as a out parameter to indicate whether this is a new namespace or not.
Returns:
The corrosponding prefix.

const AxisChar* AXISCALL SoapSerializer::getNamespacePrefix (  const AxisChar *    pNamespace ) 
 

Returns the corrosponding namespace prefix.

Parameters:
pNamespace  The namespace.
Returns:
The corrosponding prefix.

int SoapSerializer::setSoapHeader (  SoapHeader *    pSoapHeader )  [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.

Implements IHandlerSoapSerializer.

int SoapSerializer::setSoapVersion (  SOAP_VERSION    )  [virtual]
 

Sets the SOAP Version.

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

Implements IHandlerSoapSerializer.

The documentation for this class was generated from the following file:
Generated on Tue Jun 15 19:13:24 2004 for axiscpp by doxygen1.2.18