SOAPonProtocol.h

Go to the documentation of this file.

// SOAPonProtocol.h: interface for the SOAPonProtocol class.
// Class Description: Provides a couple of methods that I think
//      would be required regardless of whether SOAP messages were 
//      transmitted using HTTP, SMTP, or something else.  So far,
//      I've only done this using HTTP, so the full set of requirements
//      hasn't been set yet.  Oh well.
/*
#if !defined(SOAPONPROTOCOL_H)
    #include "SOAPonProtocol.h"    
#endif // !defined(SOAPONPROTOCOL_H)
*/
#if !defined(SOAPONPROTOCOL_H)
#define SOAPONPROTOCOL_H

#ifndef _STRING_
    #include <string>
#endif // _STRING_

class SOAPMethod;
class SOAPElement;

class SOAPonProtocol
{
public:
    
    // Constructor/Destructor
    SOAPonProtocol();
    virtual ~SOAPonProtocol();
    
    // getSendableResponse
    // Description: Given a SOAP message that has already been
    //  translated to some sort of string, this call finsihes
    //  things by adding any text required by the implemented
    //  protocol.  
    // szSOAPMessage:
    //  The message without any protocol specific adornments.
    // bIsFault:
    //  The message contains a Fault.  
    // Returns:
    //  The message WITH protocol specific adornments.  This method
    //  is for use on the server side of a SOAP call.
    virtual std::string getSendableResponse( 
        const std::string& szSOAPMessage, bool bIsFault = false ) = 0;
    
    // send
    // Description: Given a SOAPMethod and the related class on 
    //  the server, executes the method and returns the response
    //  as a string.  If any protocol specifc items will impede the 
    //  parsing of the SOAP part of the message, this item should
    //  strip that off.
    // szClassName: 
    //  Name of the class that owns the method on the server.
    // aMethod:
    //  Represents the method being called complete with any arguments.
    virtual std::string send( const std::string& szClassName, 
        SOAPMethod& aMethod ) = 0;
    
    // getMethodDetails
    // Description: When a call comes in, this takes the method,
    //  takes out its "guts", and parses the message.  This method
    //  does not execute the actual message.  That is done
    //  by another object.  The parsing is done here because this
    //  object is intimate with the details of the overhead
    //  and calling information that comes with the given protocol.
    // Arguments:
    //  KszMessage: The message in its raw form.
    //  szObjectName: On return, this contains the name of the object
    //          to execute any methods on.
    //  szMethodName: On return, this contains the name of the method
    //          the caller wants to execute.
    //  theCall: On return, this contains the parsed SOAP message.
    // Return value:
    //  true: Successfully obtained all needed information.
    //  false: Something went wrong during the parse.  Look at
    //      szObjectName for the fault details as a sendable 
    //      SOAP string, minus the protocol specific stuff.
    virtual bool getMethodDetails( const std::string& KszMessage, 
        std::string& szObjectName, std::string& szMethodName, 
        SOAPElement& theCall ) = 0;
};

#endif // !defined(SOAPONPROTOCOL_H)

---