---

HeaderBlock.h

/*
 *   Copyright 2003-2004 The Apache Software Foundation.
 *
 *   Licensed under the Apache License, Version 2.0 (the "License");
 *   you may not use this file except in compliance with the License.
 *   You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 *   Unless required by applicable law or agreed to in writing, software
 *   distributed under the License is distributed on an "AS IS" BASIS,
 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *   See the License for the specific language governing permissions and
 *   limitations under the License.
 */


#if !defined(_HEADERBLOCK_H____OF_AXIS_INCLUDED_)
#define _HEADERBLOCK_H____OF_AXIS_INCLUDED_

#include "Attribute.h"
#include <string>
#include <list>

using namespace std;

class BasicNode;
#include "IHeaderBlock.h"
#include "SoapEnvVersions.h"

/*
 *  @class BasicNode
 *  @brief    The Header block of a SOAP Header according to 
 *  SOAP 1.2 specification.
 *   
 *  The Header block of a SOAP Header according to SOAP 1.2 specification.
 *
 *  Each child element information item of the SOAP Header is called a 
 *  SOAP header block. Each SOAP header block element information item:
 *    - MUST have a [namespace name] property which has a value, 
 *      that is the name of the element MUST be namespace qualified.
 *    - MAY have any number of character information item children. 
 *      Child character information items whose character code is amongst 
 *      the white space characters as defined by XML 1.0 [XML 1.0] are 
 *      considered significant.
 *    - MAY have any number of element information item children. Such element 
 *      information items MAY be namespace qualified.
 *    - MAY have zero or more attribute information items in its [attributes] 
 *       property. Among these MAY be any or all of the following, which have 
 *       special significance for SOAP processing:
 *    - encodingStyle attribute information item 
 *    - role attribute information item 
 *    - mustUnderstand attribute information item     
 *    - relay attribute information item 
 *
 *    
 *    
 *  @author Roshan Weerasuriya (roshan@opensource.lk, roshanw@jkcsworld.com)
 *  @author Samisa Abeysinghe (sabeysinghe@virtusa.com)
 *
 */

/*
 * Revision 1.1  2004/05/26 samisa
 * Added copy constructor and clone
 */

/*
 * Revision 1.2  2004/06/13 roshan
 * Added doxygen comments to help autobuild API docs
 */

class HeaderBlock : public IHeaderBlock
{
friend class SoapHeader;

private:   
    int iNoOFChildren;
    
    int serializeNamespaceDecl(SoapSerializer& pSZ);

    int serializeChildren(SoapSerializer& pSZ, 
        list<AxisChar*>& lstTmpNameSpaceStack);

    list<BasicNode*> m_children;

    bool isSerializable();

    int attrSerialize(SoapSerializer& pSZ, 
        list<AxisChar*>& lstTmpNameSpaceStack);

    AxisString m_localname;
    AxisString m_sPrefix;
    AxisString m_uri;
    list<Attribute*> m_attributes;
    list<Attribute*> m_namespaceDecls;

public:
    const BasicNode* getFirstChild();

    int getNoOfChildren();

    BasicNode* createChild(NODE_TYPE eNODE_TYPE,  
        AxisChar *pachLocalName, AxisChar *pachPrefix, AxisChar *pachUri, 
        AxisChar* pachValue);

#ifdef UNIT_TESTING_ON
    int initializeForTesting();
#endif

    BasicNode* createImmediateChild(NODE_TYPE eNODE_TYPE, 
        AxisChar *pachLocalName, AxisChar *pachPrefix, AxisChar *pachUri, 
        AxisChar* pachValue);

    void addAttribute(Attribute* attr);

    Attribute* createStdAttribute(HEADER_BLOCK_STD_ATTR_TYPE eStdAttrType, 
        SOAP_VERSION eSOAP_VERSION);

    Attribute* createAttribute(const AxisChar* localname, 
        const AxisChar* prefix, const AxisChar* uri, const AxisChar* value);

    Attribute* createAttribute(const AxisChar* localname, 
        const AxisChar* prefix, const AxisChar* value);

    BasicNode* createImmediateChild(NODE_TYPE eNODE_TYPE);

    BasicNode* createChild(NODE_TYPE eNODE_TYPE);

    const BasicNode* getLastChild();

    const BasicNode* getChild(int iChildPosition);

    int addChild(BasicNode* pBasicNode);

    void setLocalName(const AxisChar* localname);

    void setUri(const AxisChar* uri);

    /*
      * Sets the prefix of this Header Block.
      *
      * @param prefix The prefix to set in.
      */
        /* Commented by Susantha - 21/06/2004
         * The prefix should be decided by the Serializer at runtime
         *
    void setPrefix(const AxisChar* prefix);
        */
    int addNamespaceDecl(Attribute *pAttribute);

    HeaderBlock(const AxisChar* pachLocalName, const AxisChar* pachUri);

    HeaderBlock();

    HeaderBlock(const HeaderBlock& rCopy);

    IHeaderBlock* clone();

    virtual ~HeaderBlock();

    bool operator ==( const HeaderBlock &objHeaderBlock);

    int serialize(SoapSerializer& pSZ);    

    int initializeForTesting();

};

#endif 

---