mi32/soap.h

Go to the documentation of this file.

/******************************************************************************
 *
 * \file mi32/soap.h
 * \brief SOAP - Simple Object Access Protocol -- Client-Side
 *
 * \if NODOC
 * $Log: soap.h_v $
 * Revision 1.2  2004/01/20 15:02:58  dwilliss
 * Added some methods
 *
 * Revision 1.1  2004/01/08 16:39:49  dwilliss
 * Initial revision
 *
 * \endif
 *
 *****************************************************************************/

#ifndef INC_MI32_SOAP_H
#define INC_MI32_SOAP_H


#ifndef INC_MI32_XML_H
#include <mi32/xml.h>
#endif

#ifndef INC_MI32_HTTPCLIENT_H
#include <mi32/httpclient.h>
#endif


namespace SOAP {

class VALUES {
   public:
      enum TYPE {
         TYPE_String,
         TYPE_Double,
         TYPE_Integer,
         TYPE_Bool,
         TYPE_XML
         };

      VALUES();

      // Parse the values out of the body of an HTTP message
      // Content-Type of the message should be either text/xml or
      // application/x-www-form-urlencoded (which is how HTML form data
      // is transmitted via POST or GET)
      VALUES(const HTTPMESSAGE& message);

      ~VALUES();

      void Clear();

      bool GetValue(const char* name, MISTRING& value) const;

      bool GetValue(const char* name, STRUTF8& value) const;

      bool GetValue(const char* name, double& value) const;

      bool GetValue(const char* name, INT32& value) const;

      bool GetValue(const char* name, UINT32& value) const;

      bool GetValue(const char* name, bool& value) const;

      XMLNODE* GetValue (const char* name) const;

      bool HasValue (const char* name) const;

      void SetValue(const char* name, const MISTRING& value);

      void SetValue(const char* name, const STRUTF8& value);

      void SetValue(const char* name, double value);

      void SetValue(const char* name, INT32 value);

      void SetValue(const char* name, UINT32 value);

      void SetValue(const char* name, bool value);

      void SetValue (
         const char* name, 
         XMLNODE* node
         );

      XMLNODE* GetXMLNode (
         ) const;

      void SetXMLNode (
         XMLNODE* node
         );
   
   private:
      // Construct given an XML node
      VALUES (
         XMLNODE* node
         );

      XMLNODE *m_node;
      XMLDOC *m_doc;

      friend class METHOD; // Server side method defn can construct one
      friend class HANDLER;   // The server-side handler can construct one
   };


class OBJECT {
   public:
      OBJECT();

      OBJECT (
         HTTPCLIENT* client,
         const char* ObjectClass
         );

      virtual ~OBJECT();

      ERRVALUE Allocate (
         );
      
      void Attach (
         HTTPCLIENT* client,  // XXX May want to define a SOAPCLIENT
         const char* ObjectClass
         );
      
      ERRVALUE CallMethod (
         const char* name,
         const VALUES* parms = 0,
         VALUES* ret = 0
         );
   
      void Free (
         );

      // Get the object's ID. 
      // An object's ID is like a pointer, but identifies where the object
      // in in the server.
      const char* GetObjectID (
         ) const;

   protected:

      HTTPCLIENT* GetClient(
         ) const;

   private:
      STRUTF8 m_id;
      STRUTF8 m_ObjClass;
      HTTPCLIENT* m_client;

   };

}     // End of SOAP namespace

#endif // INC_MI32_SOAP_H

---