c/src/soap/SoapFault.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.
 */

#ifdef WIN32
#pragma warning (disable : 4786)
#endif

#if !defined(_SOAPFAULT_H____OF_AXIS_INCLUDED_)
#define _SOAPFAULT_H____OF_AXIS_INCLUDED_

#include <axis/server/AxisException.h>
#include <axis/ISoapFault.h>
#include "../common/Param.h"
#include <axis/server/SoapEnvVersions.h>
class SoapSerializer;
class SoapDeSerializer;

#include <string>
#include <map>

using namespace std;
    
/**
 *    The structure which is used as a container for soap faults.
 */
typedef struct
{
    const char* pcFaultcode;
    const char* pcFaultstring;    
    const char* pcFaultactor;
    const char* pcFaultDetail;
} SoapFaultStruct;

/*
 * This array of structure is used to store all the soap faults
 * which are used in Axis C++. Each time a fault object is needed it is
 * created using this array, in SoapFault class.
 */
static SoapFaultStruct* s_parrSoapFaultStruct;

/**
 *  @class SoapFault
 *  @brief interface for the SoapFault class.
 *
 *
 *  @author Roshan Weerasuriya (roshan@jkcs.slt.lk)
 *  @author damitha kumarage (damitha@jkcsworld.com, damitha@opensource.lk)
 */

/*
 * Revision 1.1  2004/June/02 roshan
 * Changed. The "SOAP-ENV" prefix was hard-coded in the "serialize" method.
 *  Corrected it to serialize the correct prefix. Added the parameter
 *  "SOAP_VERSION eSoapVersion" to the "serialize" method.
 */

class SoapFault : public ISoapFault  
{
friend class SoapFaultsTestCase;

public:
    SoapFault();

    SoapFault(string m_sFaultcode, string m_sFaultstring, 
        string m_sFaultactor, string m_sDetail);

    bool operator ==(const SoapFault &objSoapFault);

    static SoapFault* getSoapFault(int);

    static void initialize();

    const char* getSoapString();

    int serialize(SoapSerializer& pSZ, SOAP_VERSION eSoapVersion);

    void setDeSerializer(SoapDeSerializer* pDZ);

    /* int serialize(string&); */

    virtual ~SoapFault();

    int setFaultDetail(const string& sDetail);

    int setFaultDetail(const Param* pFaultDetail);

    int setFaultactor(const string& sFaultactor);

    int setFaultstring(const string& sFaultstring);

    int setFaultcode(const string& sFaultcode);

    string getFaultcode();

    string getFaultstring();

    string getFaultactor();

    string getSimpleFaultDetail();
    
    string getCmplxFaultObjectName();
 
    void* getCmplxFaultObject(void* pDZFunct, void* pCreFunct, void* pDelFunct, 
        const AxisChar* pName, const AxisChar* pNamespace);

    const void* getCmplxFaultObject();

    int setCmplxFaultObjectName(const string& sCmplxFaultObjectName);

    int setCmplxFaultObject(const void* pCmplxFaultObject);

    void setUri(const AxisChar* uri);

    void setLocalName(const AxisChar* localname);

    void setPrefix(const AxisChar* prefix);

    int setParam(Param* pParam, const AxisChar* pchName, const void* pValue, XSDTYPE type);

private:
    /* string m_sFaultSerialized; */
    string m_sFaultDetail;
    string m_sFaultactor;
    string m_sFaultstring;
    string m_sFaultcode;
    string m_sCmplxFaultObjectName;
    const void* m_pCmplxFaultObject;
    Param* m_pFaultcodeParam;
    Param* m_pFaultstringParam;
    Param* m_pFaultactorParam;
    Param* m_pFaultDetail;
    AxisString m_strPrefix;
    AxisString m_strLocalname;
    AxisString m_strUri;
    SoapDeSerializer* m_pDZ;
    bool m_bIsSimpleDetail;
    static volatile bool m_bInit;
};

#endif