xmltooling/soap/SOAP.h

   1 /*
   2  *  Copyright 2001-2006 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 SOAP.h
  19  *
  20  * XMLObjects representing SOAP content
  21  */
  22
  23 #ifndef __xmltooling_soap_h__
  24 #define __xmltooling_soap_h__
  25
  26 #include <xmltooling/AttributeExtensibleXMLObject.h>
  27 #include <xmltooling/ElementProxy.h>
  28 #include <xmltooling/SimpleElement.h>
  29 #include <xmltooling/XMLObjectBuilder.h>
  30 #include <xmltooling/util/XMLConstants.h>
  31 #include <xmltooling/validation/ValidatorSuite.h>
  32 #include <xercesc/util/XMLUniDefs.hpp>
  33
  34 #define DECL_SOAP11OBJECTBUILDER(cname) \
  35     DECL_XMLOBJECTBUILDER(XMLTOOL_API,cname,xmltooling::XMLConstants::SOAP11ENV_NS,xmltooling::XMLConstants::SOAP11ENV_PREFIX)
  36
  37 /**
  38  * @namespace soap11
  39  * Namespace for SOAP 1.1 schema objects
  40  */
  41 namespace soap11 {
  42
  43     DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,Faultstring,String,SOAP 1.1 faultstring element);
  44     DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,Faultactor,Actor,SOAP 1.1 faultactor element);
  45
  46     BEGIN_XMLOBJECT(XMLTOOL_API,Faultcode,xmltooling::XMLObject,SOAP 1.1 faultcode element);
  47         /** Gets the QName content of the element. */
  48         virtual xmltooling::QName* getCode() const=0;
  49         /** Sets the QName content of the element. */
  50         virtual void setCode(const xmltooling::QName* qname)=0;
  51     END_XMLOBJECT;
  52
  53     BEGIN_XMLOBJECT2(XMLTOOL_API,Detail,xmltooling::ElementProxy,xmltooling::AttributeExtensibleXMLObject,SOAP 1.1 detail element);
  54         /** detail (type) local name */
  55         static const XMLCh TYPE_NAME[];
  56     END_XMLOBJECT;
  57
  58     BEGIN_XMLOBJECT(XMLTOOL_API,Fault,xmltooling::XMLObject,SOAP 1.1 Fault element);
  59         DECL_TYPED_CHILD(Faultcode);
  60         DECL_TYPED_CHILD(Faultstring);
  61         DECL_TYPED_CHILD(Faultactor);
  62         DECL_TYPED_CHILD(Detail);
  63         /** Fault (type) local name */
  64         static const XMLCh TYPE_NAME[];
  65     END_XMLOBJECT;
  66
  67     BEGIN_XMLOBJECT2(XMLTOOL_API,Body,xmltooling::ElementProxy,xmltooling::AttributeExtensibleXMLObject,SOAP 1.1 Body element);
  68         DECL_STRING_ATTRIB(EncodingStyle,ENCODINGSTYLE);
  69         /** Body (type) local name */
  70         static const XMLCh TYPE_NAME[];
  71     END_XMLOBJECT;
  72
  73     BEGIN_XMLOBJECT2(XMLTOOL_API,Header,xmltooling::ElementProxy,xmltooling::AttributeExtensibleXMLObject,SOAP 1.1 Header element);
  74         DECL_BOOLEAN_ATTRIB(MustUnderstand,MUSTUNDERSTAND,false);
  75         DECL_STRING_ATTRIB(Actor,ACTOR);
  76         /** Header (type) local name */
  77         static const XMLCh TYPE_NAME[];
  78     END_XMLOBJECT;
  79
  80     BEGIN_XMLOBJECT(XMLTOOL_API,Envelope,xmltooling::AttributeExtensibleXMLObject,SOAP 1.1 Envelope element);
  81         DECL_TYPED_CHILD(Header);
  82         DECL_TYPED_CHILD(Body);
  83         /** Envelope (type) local name */
  84         static const XMLCh TYPE_NAME[];
  85     END_XMLOBJECT;
  86
  87     DECL_SOAP11OBJECTBUILDER(Body);
  88     DECL_SOAP11OBJECTBUILDER(Detail);
  89     DECL_SOAP11OBJECTBUILDER(Envelope);
  90     DECL_SOAP11OBJECTBUILDER(Fault);
  91     DECL_SOAP11OBJECTBUILDER(Faultactor);
  92     DECL_SOAP11OBJECTBUILDER(Faultcode);
  93     DECL_SOAP11OBJECTBUILDER(Faultstring);
  94     DECL_SOAP11OBJECTBUILDER(Header);
  95
  96     /**
  97      * Registers builders and validators for SOAP 1.1 classes into the runtime.
  98      */
  99     void XMLTOOL_API registerSOAPClasses();
 100
 101     /**
 102      * Validator suite for SOAP 1.1 schema validation.
 103      */
 104     extern XMLTOOL_API xmltooling::ValidatorSuite SOAPSchemaValidators;
 105 };
 106
 107 #endif /* __xmltooling_soap_h__ */