wwwRequestXmlBlock.h

Go to the documentation of this file.

/*********************************************************************
 ** Copyright (c) 2006 MaK Technologies, Inc.
 ** All rights reserved.
 *********************************************************************/
/*******************************************************************************
 ** $RCSfile: wwwRequestXmlBlock.h,v $ $Revision: 1.10 $ $State: Exp $
 *******************************************************************************/
#ifndef DtWwwRequestXmlBlock_H_
#define DtWwwRequestXmlBlock_H_

#include <rtiMsConfig.h>
#include "spyXmlBlock.h"
#include <mtl/env.h>
#include "webSpyUtils.h"

#include <vlutil/vlString.h>
#include <vlutil/vlFilename.h>
#include <vlutil/vlSmartPointers.h>

#include <iosfwd>
#include <map>

// Define the XML tags used by this block
DtDECLARE_SPY_XML_TAG( DtWwwRequestXmlTag );
DtDECLARE_SPY_XML_TAG( DtWwwRequestParamXmlTag );
DtDECLARE_SPY_XML_TAG( DtRequestParamValueXmlTag );
DtDECLARE_SPY_XML_TAG( DtRequestIdXmlTag );
DtDECLARE_SPY_XML_TAG( DtRequestComponentLinkXmlTag );
DtDECLARE_SPY_XML_TAG( DtRequestConnectionIdXmlTag );
DtDECLARE_SPY_XML_TAG( DtRequestProxiedXmlTag );
DtDECLARE_SPY_XML_TAG( DtRequestFederationHandleXmlTag );
DtDECLARE_SPY_XML_TAG( DtRequestFederateHandleXmlTag );
DtDECLARE_SPY_XML_TAG( DtRequestStateTypeXmlTag );
                      
class DtWwwRequestXmlBlock;
class DtWwwRequestParamXmlBlock;
typedef DtBoost::shared_ptr<DtWwwRequestXmlBlock> DtWwwRequestXmlBlockSP;
typedef DtBoost::weak_ptr<DtWwwRequestXmlBlock>   DtWwwRequestXmlBlockWP;
typedef DtBoost::shared_ptr<DtWwwRequestParamXmlBlock> DtWwwRequestParamXmlBlockSP;
typedef DtBoost::weak_ptr<DtWwwRequestParamXmlBlock>   DtWwwRequestParamXmlBlockWP;


// The DtWwwRequestParamXmlBlock holds a single name/value pair for a WWW request message
// Helper class to DtWwwRequestXmlBlock.
class DT_DLL_WWW DtWwwRequestParamXmlBlock : public DtSpyXmlBlock
{
public:
   
   static DtSpyXmlBlockSP create( DtNodeAndParentPair xmlNodeAndParent );

public:
   DtWwwRequestParamXmlBlock( DtEnvValueSP existingNode, DtEnvValueSP root );
   DtWwwRequestParamXmlBlock( const DtString& name, const DtString& val, DtEnvValueSP root );
   virtual ~DtWwwRequestParamXmlBlock();

   virtual void setVal( const DtString& val );
   virtual DtString val() const;
   
protected:

   // NOTE: use name "Val" since "Value" is heavily overloaded and will cause problems
   DtSpyXmlBlockElement< DtString, true > myVal;    
};


// The DtWwwRequestXmlBlock holds a complete WWW request message
class DT_DLL_WWW DtWwwRequestXmlBlock : public DtSpyXmlBlock
{
public:
   typedef std::set< DtWwwRequestParamXmlBlockSP > WwwRequestParamXmlBlockSet;

   static DtSpyXmlBlockSP create( DtNodeAndParentPair xmlNodeAndParent );

public:
   DtWwwRequestXmlBlock( DtEnvValueSP existingNode, DtEnvValueSP root );
   DtWwwRequestXmlBlock( DtWebSpyUtils::WwwControlMsgCommandId id, unsigned long link,
      unsigned long connId, unsigned long federationHandle, unsigned long federateHandle,
      unsigned long requestType, bool proxied, DtEnvValueSP root );
   virtual ~DtWwwRequestXmlBlock();

   // Add and Remove parameters from the list
   virtual DtWwwRequestParamXmlBlockSP addParameter( const DtString& name, const DtString& val );
   virtual DtWwwRequestParamXmlBlockSP removeParameter( const DtString& name );
   virtual void removeParameter( DtWwwRequestParamXmlBlockSP paramSP );

   // The value of a specific parameter by name
   // returns null string if parameter not found
   DtString getParamValue( const DtString& paramName );

   // List the request parameters
   virtual WwwRequestParamXmlBlockSet params();

   inline DtWebSpyUtils::WwwControlMsgCommandId commandId();
   inline unsigned long componentLink();
   inline unsigned long connectionId();
   inline unsigned long federationHandle();
   inline unsigned long federateHandle();
   inline unsigned long requestType();
   inline bool isProxied();

protected:

   DtSpyXmlBlockElement< unsigned long, true > myRequestId; 
   DtSpyXmlBlockElement< unsigned long, true >  myLink;
   DtSpyXmlBlockElement< unsigned long, true > myConnId;
   DtSpyXmlBlockElement< unsigned long, true > myFedex;
   DtSpyXmlBlockElement< unsigned long, true > myFed;
   DtSpyXmlBlockElement< unsigned long, true > myRequestType;
   DtSpyXmlBlockElement< unsigned int, true> myProxied;
};

inline DtWebSpyUtils::WwwControlMsgCommandId DtWwwRequestXmlBlock::commandId()
{
   return static_cast<DtWebSpyUtils::WwwControlMsgCommandId>( (unsigned long) myRequestId );
}

inline unsigned long DtWwwRequestXmlBlock::componentLink() { return myLink; }
inline unsigned long DtWwwRequestXmlBlock::connectionId() { return myConnId; }
inline unsigned long DtWwwRequestXmlBlock::federationHandle() { return myFedex; }
inline unsigned long DtWwwRequestXmlBlock::federateHandle() { return myFed; }
inline unsigned long DtWwwRequestXmlBlock::requestType() { return myRequestType; }
inline bool          DtWwwRequestXmlBlock::isProxied() { return (bool)myProxied; }


#endif // DtWwwRequestXmlBlock_H_