activemq-cpp-3.6.0
activemq::wireformat::openwire::utils::MessagePropertyInterceptor Class Reference

Used the base ActiveMQMessage class to intercept calls to get and set properties in order to capture the calls that use the reserved JMS properties and get and set them in the OpenWire Message properties. More...

#include <src/main/activemq/wireformat/openwire/utils/MessagePropertyInterceptor.h>

Public Member Functions

 MessagePropertyInterceptor (commands::Message *message, util::PrimitiveMap *properties)
 Constructor, accepts the Message that will be used to store JMS reserved property values, and the PrimitiveMap to get and set the rest to.
virtual ~MessagePropertyInterceptor ()
virtual bool getBooleanProperty (const std::string &name) const
 Gets a boolean property.
virtual unsigned char getByteProperty (const std::string &name) const
 Gets a byte property.
virtual double getDoubleProperty (const std::string &name) const
 Gets a double property.
virtual float getFloatProperty (const std::string &name) const
 Gets a float property.
virtual int getIntProperty (const std::string &name) const
 Gets a int property.
virtual long long getLongProperty (const std::string &name) const
 Gets a long property.
virtual short getShortProperty (const std::string &name) const
 Gets a short property.
virtual std::string getStringProperty (const std::string &name) const
 Gets a string property.
virtual void setBooleanProperty (const std::string &name, bool value)
 Sets a boolean property.
virtual void setByteProperty (const std::string &name, unsigned char value)
 Sets a byte property.
virtual void setDoubleProperty (const std::string &name, double value)
 Sets a double property.
virtual void setFloatProperty (const std::string &name, float value)
 Sets a float property.
virtual void setIntProperty (const std::string &name, int value)
 Sets a int property.
virtual void setLongProperty (const std::string &name, long long value)
 Sets a long property.
virtual void setShortProperty (const std::string &name, short value)
 Sets a short property.
virtual void setStringProperty (const std::string &name, const std::string &value)
 Sets a string property.

Detailed Description

Used the base ActiveMQMessage class to intercept calls to get and set properties in order to capture the calls that use the reserved JMS properties and get and set them in the OpenWire Message properties.

Currently the only properties that are intercepted and handled are:

Name | Conversion Supported

JMSXDeliveryCount | Int, Long, String JMSXGroupID | String JMSXGroupSeq | Int, Long, String

Constructor & Destructor Documentation

activemq::wireformat::openwire::utils::MessagePropertyInterceptor::MessagePropertyInterceptor ( commands::Message message,
util::PrimitiveMap properties 
)

Constructor, accepts the Message that will be used to store JMS reserved property values, and the PrimitiveMap to get and set the rest to.

Parameters
message- The Message to store reserved property data in
properties- The PrimitiveMap to store the rest of the properties in.
Exceptions
NullPointerExceptionif either param is NULL
virtual activemq::wireformat::openwire::utils::MessagePropertyInterceptor::~MessagePropertyInterceptor ( )
virtual

Member Function Documentation

virtual bool activemq::wireformat::openwire::utils::MessagePropertyInterceptor::getBooleanProperty ( const std::string &  name) const
virtual

Gets a boolean property.

Parameters
nameThe name of the property to retrieve.
Returns
The value for the named property.
virtual unsigned char activemq::wireformat::openwire::utils::MessagePropertyInterceptor::getByteProperty ( const std::string &  name) const
virtual

Gets a byte property.

Parameters
nameThe name of the property to retrieve.
Returns
The value for the named property.
virtual double activemq::wireformat::openwire::utils::MessagePropertyInterceptor::getDoubleProperty ( const std::string &  name) const
virtual

Gets a double property.

Parameters
nameThe name of the property to retrieve.
Returns
The value for the named property.
virtual float activemq::wireformat::openwire::utils::MessagePropertyInterceptor::getFloatProperty ( const std::string &  name) const
virtual

Gets a float property.

Parameters
nameThe name of the property to retrieve.
Returns
The value for the named property.
virtual int activemq::wireformat::openwire::utils::MessagePropertyInterceptor::getIntProperty ( const std::string &  name) const
virtual

Gets a int property.

Parameters
nameThe name of the property to retrieve.
Returns
The value for the named property.
virtual long long activemq::wireformat::openwire::utils::MessagePropertyInterceptor::getLongProperty ( const std::string &  name) const
virtual

Gets a long property.

Parameters
nameThe name of the property to retrieve.
Returns
The value for the named property.
virtual short activemq::wireformat::openwire::utils::MessagePropertyInterceptor::getShortProperty ( const std::string &  name) const
virtual

Gets a short property.

Parameters
nameThe name of the property to retrieve.
Returns
The value for the named property.
virtual std::string activemq::wireformat::openwire::utils::MessagePropertyInterceptor::getStringProperty ( const std::string &  name) const
virtual

Gets a string property.

Parameters
nameThe name of the property to retrieve.
Returns
The value for the named property.
virtual void activemq::wireformat::openwire::utils::MessagePropertyInterceptor::setBooleanProperty ( const std::string &  name,
bool  value 
)
virtual

Sets a boolean property.

Parameters
nameThe name of the property to retrieve.
valueThe value for the named property.
virtual void activemq::wireformat::openwire::utils::MessagePropertyInterceptor::setByteProperty ( const std::string &  name,
unsigned char  value 
)
virtual

Sets a byte property.

Parameters
nameThe name of the property to retrieve.
valueThe value for the named property.
virtual void activemq::wireformat::openwire::utils::MessagePropertyInterceptor::setDoubleProperty ( const std::string &  name,
double  value 
)
virtual

Sets a double property.

Parameters
nameThe name of the property to retrieve.
valueThe value for the named property.
virtual void activemq::wireformat::openwire::utils::MessagePropertyInterceptor::setFloatProperty ( const std::string &  name,
float  value 
)
virtual

Sets a float property.

Parameters
nameThe name of the property to retrieve.
valueThe value for the named property.
virtual void activemq::wireformat::openwire::utils::MessagePropertyInterceptor::setIntProperty ( const std::string &  name,
int  value 
)
virtual

Sets a int property.

Parameters
nameThe name of the property to retrieve.
valueThe value for the named property.
virtual void activemq::wireformat::openwire::utils::MessagePropertyInterceptor::setLongProperty ( const std::string &  name,
long long  value 
)
virtual

Sets a long property.

Parameters
nameThe name of the property to retrieve.
valueThe value for the named property.
virtual void activemq::wireformat::openwire::utils::MessagePropertyInterceptor::setShortProperty ( const std::string &  name,
short  value 
)
virtual

Sets a short property.

Parameters
nameThe name of the property to retrieve.
valueThe value for the named property.
virtual void activemq::wireformat::openwire::utils::MessagePropertyInterceptor::setStringProperty ( const std::string &  name,
const std::string &  value 
)
virtual

Sets a string property.

Parameters
nameThe name of the property to retrieve.
valueThe value for the named property.

The documentation for this class was generated from the following file: