Convert from NULL macro to nullptr.

[shibboleth/cpp-xmltooling.git] / xmltooling / soap / SOAPClient.h

diff --git a/xmltooling/soap/SOAPClient.h b/xmltooling/soap/SOAPClient.h
index 3e11436..27f2622 100644 (file)
--- a/xmltooling/soap/SOAPClient.h
+++ b/xmltooling/soap/SOAPClient.h
@@ -1,5 +1,5 @@
 /*
- *  Copyright 2001-2006 Internet2
+ *  Copyright 2001-2010 Internet2
  * 
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -23,59 +23,92 @@
 #ifndef __xmltooling_soap11client_h__
 #define __xmltooling_soap11client_h__
 
-#include <xmltooling/soap/SOAP.h>
 #include <xmltooling/soap/SOAPTransport.h>
 
 namespace soap11 {
-    
+
+    class XMLTOOL_API Envelope;
+    class XMLTOOL_API Fault;
+
     /**
      * Implements SOAP 1.1 messaging over a transport.
      * 
      * In the abstract, this can be a one-way exchange, or use asynchronous
-     * transports, but this is mostly theoretical.
+     * transports, but this is mostly theoretical at this point.
      */
     class XMLTOOL_API SOAPClient
     {
         MAKE_NONCOPYABLE(SOAPClient);
     public:
-        SOAPClient() : m_response(NULL) {}
+        /**
+         * Constructor
+         * 
+         * @param validate  true iff schema validation should be used 
+         */
+        SOAPClient(bool validate=false);
+        
         virtual ~SOAPClient();
         
         /**
-         * Sends the supplied envelope to the identified recipient/endpoint.
-         * 
-         * <p>The caller is responsible for freeing the outgoing envelope.
+         * Controls schema validation of incoming XML messages.
+         * This is separate from other forms of programmatic validation of objects,
+         * but can detect a much wider range of syntax errors. 
          * 
+         * @param validate  true iff the client should use a validating XML parser
+         */
+        void setValidating(bool validate=true);
+        
+        /**
+         * Sends the supplied envelope to the identified recipient/endpoint.
+         *
          * <p>The client object will instantiate a transport layer object
          * appropriate for the endpoint URL provided and supply it to the
          * prepareTransport() method below.
          * 
-         * @param env       SOAP envelope to send
-         * @param to        identifier/name of party to send message to
-         * @param endpoint  URL of endpoint to recieve message
+         * <p>To authenticate the server end, the transport layer object
+         * exposes a method to load a TrustEngine and CredentialResolver
+         * in a subclass-specific version of the prepareTransport() method.   
+         * 
+         * @param env           SOAP envelope to send
+         * @param addr          addressing information
          */
-        virtual void send(const Envelope* env, const char* to, const char* endpoint);
+        virtual void send(const Envelope& env, const xmltooling::SOAPTransport::Address& addr);
         
         /**
          * Returns the response message, if any. As long as a response is
-         * "expected" but not available, NULL will be returned. If no response
+         * "expected" but not available, nullptr will be returned. If no response
          * will be forthcoming, an exception is raised.
          * 
-         * <p>The caller is responsible for freeing the incoming envelope.
+         * <p>The caller is responsible for freeing the returned envelope.
          */
         virtual Envelope* receive();
+        
+        /**
+         * Resets the object for another call.
+         */
+        virtual void reset();
 
     protected:
         /**
          * Allows client to supply transport-layer settings prior to sending message.
          * 
          * @param transport reference to transport layer
-         * @return true iff transport preparation was successful 
          */
-        virtual bool prepareTransport(const xmltooling::SOAPTransport& transport) {}
-        
+        virtual void prepareTransport(xmltooling::SOAPTransport& transport);
+
+        /**
+         * Handling of SOAP faults.
+         * 
+         * @param fault SOAP Fault received by client
+         * @return true iff the Fault should be treated as a fatal error
+         */
+        virtual bool handleFault(const soap11::Fault& fault);
+            
+        /** Flag controlling schema validation. */
+        bool m_validate;
+
         /** Holds response until retrieved by caller. */
-        Envelope* m_response;
+        xmltooling::SOAPTransport* m_transport;
     };
 
 };