#include <src/main/activemq/commands/ActiveMQObjectMessage.h>

Inheritance diagram for activemq::commands::ActiveMQObjectMessage:

Public Member Functions
	ActiveMQObjectMessage ()

virtual	~ActiveMQObjectMessage () throw ()

virtual unsigned char	getDataStructureType () const
	Get the DataStructure Type as defined in CommandTypes.h. More...

virtual ActiveMQObjectMessage *	cloneDataStructure () const
	Clone this obbject and return a new instance that the caller now owns, this will be an exact copy of this one. More...

virtual void	copyDataStructure (const DataStructure *src)
	Copy the contents of the passed object into this objects members, overwriting any existing data. More...

virtual std::string	toString () const
	Returns a string containing the information for this DataStructure such as its type and value of its elements. More...

virtual bool	equals (const DataStructure *value) const
	Compares the DataStructure passed in to this one, and returns if they are equivalent. More...

virtual cms::Message *	clone () const
	Clone this message exactly, returns a new instance that the caller is required to delete. More...

virtual void	setObjectBytes (const std::vector< unsigned char > &bytes)
	Sets the payload bytes the represent the Object being transmitted. More...

virtual std::vector< unsigned char >	getObjectBytes () const
	Returns the byte array containing the serialized form of the transmitted Object. More...

Public Member Functions inherited from activemq::commands::ActiveMQMessageTemplate< cms::ObjectMessage >
	ActiveMQMessageTemplate ()

virtual	~ActiveMQMessageTemplate () throw ()

virtual void	acknowledge () const

virtual void	onSend ()
	Allows derived Message classes to perform tasks before a message is sent. More...

virtual void	clearBody ()

virtual void	clearProperties ()

virtual std::vector< std::string >	getPropertyNames () const

virtual bool	propertyExists (const std::string &name) const

virtual cms::Message::ValueType	getPropertyValueType (const std::string &name) const

virtual bool	getBooleanProperty (const std::string &name) const

virtual unsigned char	getByteProperty (const std::string &name) const

virtual double	getDoubleProperty (const std::string &name) const

virtual float	getFloatProperty (const std::string &name) const

virtual int	getIntProperty (const std::string &name) const

virtual long long	getLongProperty (const std::string &name) const

virtual short	getShortProperty (const std::string &name) const

virtual std::string	getStringProperty (const std::string &name) const

virtual void	setBooleanProperty (const std::string &name, bool value)

virtual void	setByteProperty (const std::string &name, unsigned char value)

virtual void	setDoubleProperty (const std::string &name, double value)

virtual void	setFloatProperty (const std::string &name, float value)

virtual void	setIntProperty (const std::string &name, int value)

virtual void	setLongProperty (const std::string &name, long long value)

virtual void	setShortProperty (const std::string &name, short value)

virtual void	setStringProperty (const std::string &name, const std::string &value)

virtual std::string	getCMSCorrelationID () const

virtual void	setCMSCorrelationID (const std::string &correlationId)

virtual int	getCMSDeliveryMode () const

virtual void	setCMSDeliveryMode (int mode)

virtual const cms::Destination *	getCMSDestination () const

virtual void	setCMSDestination (const cms::Destination *destination)

virtual long long	getCMSExpiration () const

virtual void	setCMSExpiration (long long expireTime)

virtual std::string	getCMSMessageID () const

virtual void	setCMSMessageID (const std::string &value)

virtual int	getCMSPriority () const

virtual void	setCMSPriority (int priority)

virtual bool	getCMSRedelivered () const

virtual void	setCMSRedelivered (bool redelivered AMQCPP_UNUSED)

virtual const cms::Destination *	getCMSReplyTo () const

virtual void	setCMSReplyTo (const cms::Destination *destination)

virtual long long	getCMSTimestamp () const

virtual void	setCMSTimestamp (long long timeStamp)

virtual std::string	getCMSType () const

virtual void	setCMSType (const std::string &type)

Public Member Functions inherited from cms::ObjectMessage
virtual	~ObjectMessage ()

Public Member Functions inherited from cms::Message
virtual	~Message ()

Public Member Functions inherited from activemq::commands::Message
	Message ()

virtual	~Message ()

Pointer< Message >	copy () const
	Create a Pointer based copy of this message. More...

virtual void	beforeMarshal (wireformat::WireFormat *wireFormat AMQCPP_UNUSED)
	Handles the marshaling of the objects properties into the internal byte array before the object is marshaled to the wire. More...

virtual void	afterUnmarshal (wireformat::WireFormat *wireFormat AMQCPP_UNUSED)
	Called after unmarshaling is started to cleanup the object being unmarshaled. More...

virtual bool	isMarshalAware () const
	Indicates that this command is aware of Marshaling, and needs to have its Marshaling methods invoked. More...

virtual void	setAckHandler (const Pointer< core::ActiveMQAckHandler > &handler)
	Sets the Acknowledgment Handler that this Message will use when the Acknowledge method is called. More...

virtual Pointer < core::ActiveMQAckHandler >	getAckHandler () const
	Gets the Acknowledgment Handler that this Message will use when the Acknowledge method is called. More...

void	setConnection (core::ActiveMQConnection *connection)
	Sets the ActiveMQConnection instance that this Command was created from when the session create methods are called to create a Message. More...

core::ActiveMQConnection *	getConnection () const
	Gets the ActiveMQConnection instance that this Command was created from when the session create methods are called to create a Message. More...

virtual unsigned int	getSize () const
	Returns the Size of this message in Bytes. More...

virtual bool	isExpired () const
	Returns if this message has expired, meaning that its Expiration time has elapsed. More...

util::PrimitiveMap &	getMessageProperties ()
	Gets a reference to the Message's Properties object, allows the derived classes to get and set their own specific properties. More...

const util::PrimitiveMap &	getMessageProperties () const

bool	isReadOnlyProperties () const
	Returns if the Message Properties Are Read Only. More...

void	setReadOnlyProperties (bool value)
	Set the Read Only State of the Message Properties. More...

bool	isReadOnlyBody () const
	Returns if the Message Body is Read Only. More...

void	setReadOnlyBody (bool value)
	Set the Read Only State of the Message Content. More...

virtual const Pointer < ProducerId > &	getProducerId () const

virtual Pointer< ProducerId > &	getProducerId ()

virtual void	setProducerId (const Pointer< ProducerId > &producerId)

virtual const Pointer < ActiveMQDestination > &	getDestination () const

virtual Pointer < ActiveMQDestination > &	getDestination ()

virtual void	setDestination (const Pointer< ActiveMQDestination > &destination)

virtual const Pointer < TransactionId > &	getTransactionId () const

virtual Pointer< TransactionId > &	getTransactionId ()

virtual void	setTransactionId (const Pointer< TransactionId > &transactionId)

virtual const Pointer < ActiveMQDestination > &	getOriginalDestination () const

virtual Pointer < ActiveMQDestination > &	getOriginalDestination ()

virtual void	setOriginalDestination (const Pointer< ActiveMQDestination > &originalDestination)

virtual const Pointer < MessageId > &	getMessageId () const

virtual Pointer< MessageId > &	getMessageId ()

virtual void	setMessageId (const Pointer< MessageId > &messageId)

virtual const Pointer < TransactionId > &	getOriginalTransactionId () const

virtual Pointer< TransactionId > &	getOriginalTransactionId ()

virtual void	setOriginalTransactionId (const Pointer< TransactionId > &originalTransactionId)

virtual const std::string &	getGroupID () const

virtual std::string &	getGroupID ()

virtual void	setGroupID (const std::string &groupID)

virtual int	getGroupSequence () const

virtual void	setGroupSequence (int groupSequence)

virtual const std::string &	getCorrelationId () const

virtual std::string &	getCorrelationId ()

virtual void	setCorrelationId (const std::string &correlationId)

virtual bool	isPersistent () const

virtual void	setPersistent (bool persistent)

virtual long long	getExpiration () const

virtual void	setExpiration (long long expiration)

virtual unsigned char	getPriority () const

virtual void	setPriority (unsigned char priority)

virtual const Pointer < ActiveMQDestination > &	getReplyTo () const

virtual Pointer < ActiveMQDestination > &	getReplyTo ()

virtual void	setReplyTo (const Pointer< ActiveMQDestination > &replyTo)

virtual long long	getTimestamp () const

virtual void	setTimestamp (long long timestamp)

virtual const std::string &	getType () const

virtual std::string &	getType ()

virtual void	setType (const std::string &type)

virtual const std::vector < unsigned char > &	getContent () const

virtual std::vector< unsigned char > &	getContent ()

virtual void	setContent (const std::vector< unsigned char > &content)

virtual const std::vector < unsigned char > &	getMarshalledProperties () const

virtual std::vector< unsigned char > &	getMarshalledProperties ()

virtual void	setMarshalledProperties (const std::vector< unsigned char > &marshalledProperties)

virtual const Pointer < DataStructure > &	getDataStructure () const

virtual Pointer< DataStructure > &	getDataStructure ()

virtual void	setDataStructure (const Pointer< DataStructure > &dataStructure)

virtual const Pointer < ConsumerId > &	getTargetConsumerId () const

virtual Pointer< ConsumerId > &	getTargetConsumerId ()

virtual void	setTargetConsumerId (const Pointer< ConsumerId > &targetConsumerId)

virtual bool	isCompressed () const

virtual void	setCompressed (bool compressed)

virtual int	getRedeliveryCounter () const

virtual void	setRedeliveryCounter (int redeliveryCounter)

virtual const std::vector < decaf::lang::Pointer < BrokerId > > &	getBrokerPath () const

virtual std::vector < decaf::lang::Pointer < BrokerId > > &	getBrokerPath ()

virtual void	setBrokerPath (const std::vector< decaf::lang::Pointer< BrokerId > > &brokerPath)

virtual long long	getArrival () const

virtual void	setArrival (long long arrival)

virtual const std::string &	getUserID () const

virtual std::string &	getUserID ()

virtual void	setUserID (const std::string &userID)

virtual bool	isRecievedByDFBridge () const

virtual void	setRecievedByDFBridge (bool recievedByDFBridge)

virtual bool	isDroppable () const

virtual void	setDroppable (bool droppable)

virtual const std::vector < decaf::lang::Pointer < BrokerId > > &	getCluster () const

virtual std::vector < decaf::lang::Pointer < BrokerId > > &	getCluster ()

virtual void	setCluster (const std::vector< decaf::lang::Pointer< BrokerId > > &cluster)

virtual long long	getBrokerInTime () const

virtual void	setBrokerInTime (long long brokerInTime)

virtual long long	getBrokerOutTime () const

virtual void	setBrokerOutTime (long long brokerOutTime)

virtual bool	isJMSXGroupFirstForConsumer () const

virtual void	setJMSXGroupFirstForConsumer (bool jMSXGroupFirstForConsumer)

virtual bool	isMessage () const

virtual Pointer< Command >	visit (activemq::state::CommandVisitor *visitor)
	Allows a Visitor to visit this command and return a response to the command based on the command type being visited. More...

Public Member Functions inherited from activemq::commands::BaseCommand
	BaseCommand ()

virtual	~BaseCommand ()

virtual void	setCommandId (int id)
	Sets the Command Id of this Message. More...

virtual int	getCommandId () const
	Gets the Command Id of this Message. More...

virtual void	setResponseRequired (const bool required)
	Set if this Message requires a Response. More...

virtual bool	isResponseRequired () const
	Is a Response required for this Command. More...

virtual bool	isBrokerInfo () const

virtual bool	isControlCommand () const

virtual bool	isConnectionControl () const

virtual bool	isConnectionError () const

virtual bool	isConnectionInfo () const

virtual bool	isConsumerInfo () const

virtual bool	isConsumerControl () const

virtual bool	isDestinationInfo () const

virtual bool	isFlushCommand () const

virtual bool	isMessageAck () const

virtual bool	isMessagePull () const

virtual bool	isKeepAliveInfo () const

virtual bool	isMessageDispatch () const

virtual bool	isMessageDispatchNotification () const

virtual bool	isProducerAck () const

virtual bool	isProducerInfo () const

virtual bool	isResponse () const

virtual bool	isRemoveInfo () const

virtual bool	isRemoveSubscriptionInfo () const

virtual bool	isReplayCommand () const

virtual bool	isSessionInfo () const

virtual bool	isShutdownInfo () const

virtual bool	isTransactionInfo () const

virtual bool	isWireFormatInfo () const

Public Member Functions inherited from activemq::commands::Command
virtual	~Command ()

Public Member Functions inherited from activemq::commands::BaseDataStructure
virtual	~BaseDataStructure ()

virtual void	afterMarshal (wireformat::WireFormat *wireFormat AMQCPP_UNUSED)

virtual void	beforeUnmarshal (wireformat::WireFormat *wireFormat AMQCPP_UNUSED)

virtual void	setMarshaledForm (wireformat::WireFormat *wireFormat AMQCPP_UNUSED, const std::vector< char > &data AMQCPP_UNUSED)

virtual std::vector< unsigned char >	getMarshaledForm (wireformat::WireFormat *wireFormat AMQCPP_UNUSED)

virtual void	copyDataStructure (const DataStructure *src AMQCPP_UNUSED)

virtual bool	equals (const DataStructure *value AMQCPP_UNUSED) const

Public Member Functions inherited from activemq::commands::DataStructure
virtual	~DataStructure ()

Public Member Functions inherited from activemq::wireformat::MarshalAware
virtual	~MarshalAware ()

virtual void	beforeMarshal (WireFormat *wireFormat)=0
	Called before marshaling is started to prepare the object to be marshaled. More...

virtual void	afterMarshal (WireFormat *wireFormat)=0
	Called after marshaling is started to cleanup the object being marshaled. More...

virtual void	beforeUnmarshal (WireFormat *wireFormat)=0
	Called before unmarshaling is started to prepare the object to be unmarshaled. More...

virtual void	afterUnmarshal (WireFormat *wireFormat)=0
	Called after unmarshaling is started to cleanup the object being unmarshaled. More...

virtual void	setMarshaledForm (WireFormat *wireFormat, const std::vector< char > &data)=0
	Called to set the data to this object that will contain the objects marshaled form. More...

virtual std::vector< unsigned char >	getMarshaledForm (WireFormat *wireFormat)=0
	Called to get the data to this object that will contain the objects marshaled form. More...

Static Public Attributes
static const unsigned char	ID_ACTIVEMQOBJECTMESSAGE

Static Public Attributes inherited from cms::Message
static const int	DEFAULT_DELIVERY_MODE
	The Default delivery mode for Message Producers is PERSISTENT. More...

static const int	DEFAULT_MSG_PRIORITY
	The Default priority assigned to a Message is 4. More...

static const long long	DEFAULT_TIME_TO_LIVE
	The Default Time to Live for a Message Producer is unlimited, the message will never expire. More...

Static Public Attributes inherited from activemq::commands::Message
static const unsigned char	ID_MESSAGE = 0

Additional Inherited Members
Public Types inherited from cms::Message
enum	ValueType { NULL_TYPE = 0, BOOLEAN_TYPE = 1, BYTE_TYPE = 2, CHAR_TYPE = 3, SHORT_TYPE = 4, INTEGER_TYPE = 5, LONG_TYPE = 6, DOUBLE_TYPE = 7, FLOAT_TYPE = 8, STRING_TYPE = 9, BYTE_ARRAY_TYPE = 10, UNKNOWN_TYPE = 11 }
	Defines the Type Identifiers used to identify the type contained within a specific Message property or MapMessage keyed value. More...

Protected Member Functions inherited from activemq::commands::ActiveMQMessageTemplate< cms::ObjectMessage >
void	failIfWriteOnlyBody () const

void	failIfReadOnlyBody () const

void	failIfReadOnlyProperties () const

Protected Attributes inherited from activemq::commands::Message
Pointer< ProducerId >	producerId

Pointer< ActiveMQDestination >	destination

Pointer< TransactionId >	transactionId

Pointer< ActiveMQDestination >	originalDestination

Pointer< MessageId >	messageId

Pointer< TransactionId >	originalTransactionId

std::string	groupID

int	groupSequence

std::string	correlationId

bool	persistent

long long	expiration

unsigned char	priority

Pointer< ActiveMQDestination >	replyTo

long long	timestamp

std::string	type

std::vector< unsigned char >	content

std::vector< unsigned char >	marshalledProperties

Pointer< DataStructure >	dataStructure

Pointer< ConsumerId >	targetConsumerId

bool	compressed

int	redeliveryCounter

std::vector < decaf::lang::Pointer < BrokerId > >	brokerPath

long long	arrival

std::string	userID

bool	recievedByDFBridge

bool	droppable

std::vector < decaf::lang::Pointer < BrokerId > >	cluster

long long	brokerInTime

long long	brokerOutTime

bool	jMSXGroupFirstForConsumer

core::ActiveMQConnection *	connection

Static Protected Attributes inherited from activemq::commands::Message
static const unsigned int	DEFAULT_MESSAGE_SIZE = 1024

Constructor & Destructor Documentation

activemq::commands::ActiveMQObjectMessage::ActiveMQObjectMessage ( )

virtual activemq::commands::ActiveMQObjectMessage::~ActiveMQObjectMessage	(	)
throw	(
	)

inlinevirtual

Member Function Documentation

virtual cms::Message* activemq::commands::ActiveMQObjectMessage::clone ( ) const

virtual

Clone this message exactly, returns a new instance that the caller is required to delete.

Returns: new copy of this message

Implements cms::Message.

virtual ActiveMQObjectMessage* activemq::commands::ActiveMQObjectMessage::cloneDataStructure ( ) const

virtual

Clone this obbject and return a new instance that the caller now owns, this will be an exact copy of this one.

Returns: new copy of this object.

Reimplemented from activemq::commands::Message.

virtual void activemq::commands::ActiveMQObjectMessage::copyDataStructure ( const DataStructure * src )

virtual

Copy the contents of the passed object into this objects members, overwriting any existing data.

Returns: src - Source Object

Reimplemented from activemq::commands::Message.

virtual bool activemq::commands::ActiveMQObjectMessage::equals ( const DataStructure * value ) const

virtual

Compares the DataStructure passed in to this one, and returns if they are equivalent.

Equivalent here means that they are of the same type, and that each element of the objects are the same.

Returns: true if DataStructure's are Equal.

Reimplemented from activemq::commands::ActiveMQMessageTemplate< cms::ObjectMessage >.

virtual unsigned char activemq::commands::ActiveMQObjectMessage::getDataStructureType ( ) const

virtual

Get the DataStructure Type as defined in CommandTypes.h.

Returns: The type of the data structure

Reimplemented from activemq::commands::Message.

virtual std::vector<unsigned char> activemq::commands::ActiveMQObjectMessage::getObjectBytes ( ) const

virtual

Returns the byte array containing the serialized form of the transmitted Object.

Returns: a byte vector containing the serialized Object.

Exceptions

CMSException	- if the operation fails due to an internal error.
MessageNotReadableException	- if the message is in write only mode.

Implements cms::ObjectMessage.

virtual void activemq::commands::ActiveMQObjectMessage::setObjectBytes ( const std::vector< unsigned char > & bytes )

virtual

Sets the payload bytes the represent the Object being transmitted.

Parameters

bytes The byte array that contains the serialized object.

Exceptions

CMSException	- if the operation fails due to an internal error.
MessageNotWriteableException	- if the Message is in Read-only Mode.

Implements cms::ObjectMessage.

virtual std::string activemq::commands::ActiveMQObjectMessage::toString ( ) const

virtual

Returns a string containing the information for this DataStructure such as its type and value of its elements.

Returns: formatted string useful for debugging.

Reimplemented from activemq::commands::Message.

Field Documentation

const unsigned char activemq::commands::ActiveMQObjectMessage::ID_ACTIVEMQOBJECTMESSAGE

static

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

src/main/activemq/commands/ActiveMQObjectMessage.h

Public Member Functions

Static Public Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation