---

SoapHeader Class Reference

The Header element information item according to SOAP 1.2 specification. More...

#include <SoapHeader.h>

Inheritance diagram for SoapHeader:

List of all members.

Public Methods
IHeaderBlock *	getHeaderBlock (const AxisChar *pName, const AxisChar *pNamespace, bool bRemoveOrNot)
int	setPrefix (const char *pcPrefix)
IHeaderBlock *	getHeaderBlock (bool bRemoveOrNot)
int	addNamespaceDecl (Attribute *pAttribute)
int	addAttribute (Attribute *pAttribute)
void	addHeaderBlock (HeaderBlock *headerBlock)
	SoapHeader ()
virtual	~SoapHeader ()

---

Detailed Description

The Header element information item according to SOAP 1.2 specification.

The Header element information item according to SOAP 1.2 specification. The Header element information item has: 1) A [local name] of Header. 2) A [namespace name] of "http://www.w3.org/2003/05/soap-envelope". 3) Zero or more namespace qualified attribute information items in its [attributes] property. 4) Zero or more namespace qualified element information items in its [children] property.

Each child element information item of the SOAP Header is called a SOAP header block.

Author:

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

---

Constructor & Destructor Documentation

SoapHeader::SoapHeader (    )

The Constructor.

virtual SoapHeader::~SoapHeader (    )  [virtual]

The Destructor.

---

Member Function Documentation

int SoapHeader::addAttribute (  Attribute *    pAttribute )

Adds a Attribute to this Soap Header. Parameters: attr  The Attribute to be added.

void SoapHeader::addHeaderBlock (  HeaderBlock *    headerBlock )

Adds a Header Block to this Soap Header. Parameters: headerBlock  The Header Block to be added.

int SoapHeader::addNamespaceDecl (  Attribute *    pAttribute )

Sets the namespace declaration of the Soap Header. Parameters: pAttribute  The Attribute pointer which points to a valid namespace declartion Attribute. Returns: AXIS_SUCCESS to indicate successfull operation.

IHeaderBlock* SoapHeader::getHeaderBlock (  bool    bRemoveOrNot )

Removes the next HeaderBlock from the list and returns it. But will not delete it. Returns: The removed HeaderBlock of the list.

IHeaderBlock* SoapHeader::getHeaderBlock (  const AxisChar *    pName, const AxisChar *    pNamespace, bool    bRemoveOrNot )

Gets and returns the Header Block, of the given name. Parameters: pName  The local name of the requested Header Block. pNamespace  The namespace uri of the requested Header Block. Returns: A pointer to the requested Header Block will be returned if found or else if not found a NULL pointer will be retured. In case of the requested Header Block is found, also it will be removed from the list of Header Blocks of this Soap Header, before returning a pointer.

int SoapHeader::setPrefix (  const char *    pcPrefix )

Sets the Prefix of the Header Block. Parameters: pcPrefix  The prefix to set.

---

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

• SoapHeader.h

---