---

IHeaderBlock.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(_IHEADERBLOCK_H____OF_AXIS_INCLUDED_)
#define _IHEADERBLOCK_H____OF_AXIS_INCLUDED_

#include "BasicNode.h"
#include "SoapEnvVersions.h"
#include "Attribute.h"

enum HEADER_BLOCK_STD_ATTR_TYPE 
{   ROLE_NEXT=1, ROLE_NONE=2, 
    ROLE_ULTIMATE_RECEIVER=3, 
    ACTOR=4, MUST_UNDERSTAND_TRUE= 5, 
    MUST_UNDERSTAND_FALSE=6
};


/*
 * 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
 */

/*
 * Revision 1.12  2004/06/13 susantha
 * Added support for writing C web services and handlers
 */

typedef struct {
        const BasicNode* (AXISCALL* getFirstChild)(void* pObj);
        /*add all other API functions here*/
} HeaderBlockFunctions;

#ifdef __cplusplus

class IHeaderBlock
{
public:
    virtual const BasicNode* getFirstChild() =0;
    virtual int getNoOfChildren() =0;

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

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

    virtual Attribute* createStdAttribute(HEADER_BLOCK_STD_ATTR_TYPE 
        eStdAttrType, SOAP_VERSION eSOAP_VERSION) =0;

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

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

    virtual BasicNode* createImmediateChild(NODE_TYPE eNODE_TYPE) = 0;

    virtual BasicNode* createChild(NODE_TYPE eNODE_TYPE)=0;

    virtual const BasicNode* getLastChild() = 0;

    virtual const BasicNode* getChild(int iChildPosition) = 0;

    virtual int addChild(BasicNode* pBasicNode)=0;

    virtual void setLocalName(const AxisChar* localname)=0;

    virtual void setUri(const AxisChar* uri)=0;

    /*
      * 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
         *
    virtual void setPrefix(const AxisChar* prefix)=0;
        */
#ifdef UNIT_TESTING_ON

    virtual int initializeForTesting() = 0;
#endif
    
    IHeaderBlock(){/*empty body as there are no member variable*/};

    IHeaderBlock(const IHeaderBlock& rCopy){/*empty body as there are no member variable*/};

    virtual IHeaderBlock* clone() = 0;

    virtual ~IHeaderBlock() {};

        static HeaderBlockFunctions ms_VFtable;
        static bool bInitialized;
};

#endif

typedef struct { 
        void* _object; /* this will be C++ Call Object */
        HeaderBlockFunctions* _functions; /* this is the static function table */
} HeaderBlock_C;

#ifndef __cplusplus
typedef HeaderBlock_C HeaderBlock; 
#endif

#endif 

---