xmltooling/soap/SOAP.h

   1 /*
   2  *  Copyright 2001-2008 Internet2
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 /**
  18  * @file xmltooling/soap/SOAP.h
  19  *
  20  * XMLObjects representing SOAP content
  21  */
  22
  23 #ifndef __xmltooling_soap_h__
  24 #define __xmltooling_soap_h__
  25
  26 #include <xmltooling/ConcreteXMLObjectBuilder.h>
  27 #include <xmltooling/ElementProxy.h>
  28 #include <xmltooling/util/XMLConstants.h>
  29 #include <xercesc/util/XMLUniDefs.hpp>
  30
  31 /**
  32  * Macro for declaring SOAP builders.
  33  *
  34  * @param cname name of class being built
  35  */
  36 #define DECL_SOAP11OBJECTBUILDER(cname) \
  37     DECL_XMLOBJECTBUILDER(XMLTOOL_API,cname,xmlconstants::SOAP11ENV_NS,xmlconstants::SOAP11ENV_PREFIX)
  38
  39 /**
  40  * @namespace soap11
  41  * Namespace for SOAP 1.1 schema objects
  42  */
  43 namespace soap11 {
  44
  45     DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,Faultstring,String,SOAP 1.1 faultstring element);
  46     DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,Faultactor,Actor,SOAP 1.1 faultactor element);
  47
  48     BEGIN_XMLOBJECT(XMLTOOL_API,Faultcode,xmltooling::XMLObject,SOAP 1.1 faultcode element);
  49         /** Gets the QName content of the element. */
  50         virtual const xmltooling::QName* getCode() const=0;
  51         /** Sets the QName content of the element. */
  52         virtual void setCode(const xmltooling::QName* qname)=0;
  53         /** Client Fault code. **/
  54         static xmltooling::QName CLIENT;
  55         /** Server Fault code. **/
  56         static xmltooling::QName SERVER;
  57         /** MustUnderstand Fault code. **/
  58         static xmltooling::QName MUSTUNDERSTAND;
  59         /** Version Mismatch Fault code. **/
  60         static xmltooling::QName VERSIONMISMATCH;
  61     END_XMLOBJECT;
  62
  63     BEGIN_XMLOBJECT(XMLTOOL_API,Detail,xmltooling::ElementProxy,SOAP 1.1 detail element);
  64         /** detail (type) local name */
  65         static const XMLCh TYPE_NAME[];
  66     END_XMLOBJECT;
  67
  68     BEGIN_XMLOBJECT(XMLTOOL_API,Fault,xmltooling::XMLObject,SOAP 1.1 Fault element);
  69         DECL_TYPED_CHILD(Faultcode);
  70         DECL_TYPED_CHILD(Faultstring);
  71         DECL_TYPED_CHILD(Faultactor);
  72         DECL_TYPED_CHILD(Detail);
  73         /** Fault (type) local name */
  74         static const XMLCh TYPE_NAME[];
  75     END_XMLOBJECT;
  76
  77     BEGIN_XMLOBJECT(XMLTOOL_API,Body,xmltooling::ElementProxy,SOAP 1.1 Body element);
  78         /** encodingStyle attribute name */
  79         static const XMLCh ENCODINGSTYLE_ATTRIB_NAME[];
  80         /** Body (type) local name */
  81         static const XMLCh TYPE_NAME[];
  82     END_XMLOBJECT;
  83
  84     BEGIN_XMLOBJECT(XMLTOOL_API,Header,xmltooling::ElementProxy,SOAP 1.1 Header element);
  85         /** Actor header block attribute name */
  86         static const XMLCh ACTOR_ATTRIB_NAME[];
  87         /** mustUnderstand header block attribute name */
  88         static const XMLCh MUSTUNDERSTAND_ATTRIB_NAME[];
  89         /** Header (type) local name */
  90         static const XMLCh TYPE_NAME[];
  91     END_XMLOBJECT;
  92
  93     BEGIN_XMLOBJECT(XMLTOOL_API,Envelope,xmltooling::AttributeExtensibleXMLObject,SOAP 1.1 Envelope element);
  94         DECL_TYPED_CHILD(Header);
  95         DECL_TYPED_CHILD(Body);
  96         /** Envelope (type) local name */
  97         static const XMLCh TYPE_NAME[];
  98     END_XMLOBJECT;
  99
 100     DECL_SOAP11OBJECTBUILDER(Body);
 101     DECL_SOAP11OBJECTBUILDER(Envelope);
 102     DECL_SOAP11OBJECTBUILDER(Fault);
 103     DECL_SOAP11OBJECTBUILDER(Header);
 104     DECL_XMLOBJECTBUILDER(XMLTOOL_API,Detail,NULL,NULL);
 105     DECL_XMLOBJECTBUILDER(XMLTOOL_API,Faultactor,NULL,NULL);
 106     DECL_XMLOBJECTBUILDER(XMLTOOL_API,Faultcode,NULL,NULL);
 107     DECL_XMLOBJECTBUILDER(XMLTOOL_API,Faultstring,NULL,NULL);
 108
 109     /**
 110      * Registers builders and validators for SOAP 1.1 classes into the runtime.
 111      */
 112     void XMLTOOL_API registerSOAPClasses();
 113 };
 114
 115 #endif /* __xmltooling_soap_h__ */