xmltooling/soap/SOAPClient.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 xmltooling/soap/SOAPClient.h
  19  *
  20  * Implements SOAP 1.1 messaging over a transport.
  21  */
  22
  23 #ifndef __xmltooling_soap11client_h__
  24 #define __xmltooling_soap11client_h__
  25
  26 #include <xmltooling/security/KeyInfoSource.h>
  27 #include <xmltooling/soap/SOAPTransport.h>
  28
  29 namespace soap11 {
  30
  31     class XMLTOOL_API Envelope;
  32     class XMLTOOL_API Fault;
  33
  34     /**
  35      * Implements SOAP 1.1 messaging over a transport.
  36      *
  37      * In the abstract, this can be a one-way exchange, or use asynchronous
  38      * transports, but this is mostly theoretical at this point.
  39      */
  40     class XMLTOOL_API SOAPClient
  41     {
  42         MAKE_NONCOPYABLE(SOAPClient);
  43     public:
  44         SOAPClient(bool validate=false) : m_validate(validate), m_transport(NULL) {}
  45         virtual ~SOAPClient();
  46
  47         /**
  48          * Controls schema validation of incoming XML messages.
  49          * This is separate from other forms of programmatic validation of objects,
  50          * but can detect a much wider range of syntax errors.
  51          *
  52          * @param validate  true iff the client should use a validating XML parser
  53          */
  54         void setValidating(bool validate=true) {
  55             m_validate = validate;
  56         }
  57
  58         /**
  59          * Sends the supplied envelope to the identified recipient/endpoint.
  60          *
  61          * <p>The client object will instantiate a transport layer object
  62          * appropriate for the endpoint URL provided and supply it to the
  63          * prepareTransport() method below.
  64          *
  65          * @param env       SOAP envelope to send
  66          * @param peer      peer to send message to, expressed in TrustEngine terms
  67          * @param endpoint  URL of endpoint to recieve message
  68          */
  69         virtual void send(const Envelope* env, const xmltooling::KeyInfoSource& peer, const char* endpoint);
  70
  71         /**
  72          * Returns the response message, if any. As long as a response is
  73          * "expected" but not available, NULL will be returned. If no response
  74          * will be forthcoming, an exception is raised.
  75          *
  76          * <p>The caller is responsible for freeing the returned envelope.
  77          */
  78         virtual Envelope* receive();
  79
  80         /**
  81          * Resets the object for another call.
  82          */
  83         virtual void reset();
  84
  85     protected:
  86         /**
  87          * Allows client to supply transport-layer settings prior to sending message.
  88          *
  89          * @param transport reference to transport layer
  90          */
  91         virtual void prepareTransport(const xmltooling::SOAPTransport& transport) {}
  92
  93         /**
  94          * Handling of SOAP faults.
  95          *
  96          * @param fault SOAP Fault received by client
  97          * @return true iff the Fault should be treated as a fatal error
  98          */
  99         virtual bool handleFault(const soap11::Fault& fault);
 100
 101         /** Flag controlling schema validation. */
 102         bool m_validate;
 103
 104         /** Holds response until retrieved by caller. */
 105         xmltooling::SOAPTransport* m_transport;
 106     };
 107
 108 };
 109
 110 #endif /* __xmltooling_soap11client_h__ */