#include <AmqHelper.h>

Inheritance diagram for FinTP::AmqHelper:

Public Member Functions
	AmqHelper (const std::string &connectionstring="")

	~AmqHelper ()

void	connect (const string &queueManagerName="", const string &transportUri="", bool force=false)

void	connect (const string &queueManagerName, const string &transportUri, const string &keyRepository, const string &sslCypherSpec, const string &sslPeerName, bool force=false)

void	openQueue (bool syncpoint, const std::string &queueName="")

void	openQueue (const std::string &queueName="")

void	openBackoutQueue (const std::string &queueName)

void	setBackupQueue (const std::string &queueName)

long	getQueueDepth (const std::string &queueName="")
	Works only for small queues. More...

long	peek (const std::string &queueName="", bool first=true)

void	setTimeout (int millisecs)

long	getOne (bool getForClean=false)

long	doGetOne (ManagedBuffer *buffer, bool getForClean, bool syncpoint=true)
	Get one message from the current queue and store it in a ManagedBuffer. More...

long	getOne (unsigned char *buffer, size_t maxSize, bool syncpoint=true)

long	getGroupMessage (ManagedBuffer *groupMessageBuffer, const string &groupId, bool &isCleaningUp)

void	putGroupMessage (ManagedBuffer *buffer, const string &batchId, long messageSequence, bool isLast)

void	putOne (const ManagedBuffer &buffer, bool syncpoint=true)

void	putOne (unsigned char *buffer, size_t bufferSize, bool syncpoint=true)

void	putOne (unsigned char *buffer, size_t bufferSize, cms::Message &msg)

void	putOne (cms::Message &msg, bool syncpoint=true)

void	putOneRequest (unsigned char *buffer, size_t bufferSize, const std::string &rtqName, const std::string &rtbName, TransportReplyOptions &replyOptions)

void	putOneReply (unsigned char *buffer, size_t bufferSize, long feedback, TRANSPORT_MESSAGE_TYPE messageType=TMT_REPLY)

void	putOneReply (const ManagedBuffer &buffer, long feedback)

void	putToDeadLetterQueue (cms::Message &msg, bool syncpoint=true)

cms::Message *	createMsg ()

void	clearMessages ()
	Clears all messages in the current queue. More...

void	setApplicationName (const std::string &applicationName)

void	setMessageId (const std::string &messageId)

void	setCorrelationId (const std::string &correlId)

void	setGroupId (const std::string &groupId)

void	setMessageFormat (const string &format)

string	getLastMessageFormat () const

time_t	getMessagePutTime ()

std::string	getLastReplyBrokerURI () const

TRANSPORT_MESSAGE_TYPE	getLastMessageType ()

int	getLastSequenceId () const

void	setSequenceId (int sequenceId)

void	clearSSLOptions ()

void	reconnect ()

void	disconnect ()

bool	commit ()
	Commits the current session. More...

bool	rollback ()
	Rollbacks the current session. More...

TransportReplyOptions	getLastReplyOptions () const
	TODO getLastReplyOptions to return ReplyOptions type. More...

string	getApplicationName () const
	Set message header value when message end up in Dead.letter.queue. More...

std::string	getLastReplyQueueManager () const

long	getOne (ManagedBuffer *buffer, bool syncpoint=true, bool keepJMSHeader=true)
	Pull one message from MQ Server and return it in 'ManagedBuffer* buffer'. More...

Public Member Functions inherited from FinTP::TransportHelper
virtual	~TransportHelper ()

virtual void	putSAAmessage (const TransportReplyOptions &replyOptions, const string &replyQueue, ManagedBuffer *buffer, const string &batchId, long messageSequence, bool isLast)

virtual void	putOneRequest (unsigned char *buffer, size_t bufferSize, const string &rtqName, const string &rtqmName, TransportReplyOptions &replyOptions)=0

virtual long	peek (const string &queue="", bool first=true)=0

virtual long	getQueueDepth (const string &queueName)=0

virtual void	setApplicationName (const string &applicationName)=0

string	getLastReplyQueue () const

	DEPRECATED (virtual void openQueue(const string &queueName))
	Common interface. More...

	DEPRECATED (virtual void closeQueue())

virtual long	getOne (ManagedBuffer *buffer)

string	getLastMessageId () const

virtual void	setMessageId (const string &messageId)

string	getLastCorrelId () const

virtual void	setCorrelationId (const string &correlId)

string	getLastGroupId () const

virtual void	setGroupId (const string &groupId)

int	getLastGroupSequence () const

void	setReplyUserData (const string &usrData)

string	getReplyUserData () const

time_t	getMessagePutTime ()

unsigned long	getLastMessageLength () const

long long	getLastFeedback () const

bool	isLastInGroup () const

virtual void	setAutoAbandon (const int retries)

virtual void	setBackupQueue (const string &queueName)

long	getQueueDepth ()

Private Member Functions
int	noMessage ()

void	resetUsePassedIds ()

void	updateSelector (string &selector)

void	writeToBuffer (ManagedBuffer &buffer, const unsigned char *rawBuffer)

void	doConnect (const string &brokerURIName, bool force)

bool	send (const string &queueName, cms::Message &msg, bool syncpoint=true)

void	setConnectionBrokerURI ()

void	setLastMessageIds (const cms::Message &msg)
	Saves the message id, correlation id, group id, group sequence number, type and timestamp. More...

void	setLastMessageReplyData (const cms::Message &msg)

int	setLastMessageInfo (cms::Message msg, ManagedBuffer buffer, bool browse=false, bool get=true, bool syncpoint=true)

TRANSPORT_MESSAGE_TYPE	ToTransportMessageType (const string &messageType)

std::string	ToString (TRANSPORT_MESSAGE_TYPE messageType)

void	closeQueue ()

Private Attributes
activemq::core::ActiveMQConnection *	m_Connection

cms::Session *	m_Session

cms::Session *	m_AutoAcknowledgeSession

cms::MessageConsumer *	m_Consumer

cms::MessageConsumer *	m_AutoAcknowledgeConsumer

cms::QueueBrowser *	m_QueueBrowser

cms::MessageProducer *	m_Producer

cms::MessageProducer *	m_AutoAcknowledgeProducer

string	m_ReplyBrokerURI

string	m_BackoutQueueName

string	m_ConnectionString

string	m_Selector

TRANSPORT_MESSAGE_TYPE	m_MessageType

long	m_ReplyOptions

int	m_Timeout

int	m_BrokerURIOpenRefCount

long long	m_MessageCMSTimestamp

const string *	m_MessageFormatPointer

map< string, int >	m_GroupLogicOrder

Static Private Attributes
static const string	FINTPGROUPID = "FinTPGroupId"

static const string	FINTPGROUPSEQ = "FinTPGroupSeq"

static const string	FINTPLASTINGROUP = "FinTPLastInGroup"

Additional Inherited Members
Public Types inherited from FinTP::TransportHelper
enum	TRANSPORT_HELPER_TYPE { WMQ = 1, AMQ = 2, AQ = 3, NONE = 0 }

enum	TRANSPORT_MESSAGE_TYPE { TMT_DATAGRAM = 0, TMT_REPLY = 1, TMT_REQUEST = 2, TMT_REPORT = 3 }

Static Public Member Functions inherited from FinTP::TransportHelper
static TransportHelper *	CreateHelper (const TransportHelper::TRANSPORT_HELPER_TYPE &helperType)
	Factory method used to instantiate propper TransportHelper. More...

static TRANSPORT_HELPER_TYPE	parseTransportType (const string &transportType)

static AbstractLogPublisher *	createMqLogPublisher (const NameValueCollection &propSettings, bool &isDefault)

Static Public Attributes inherited from FinTP::TransportHelper
static const string	TMT_STRING = "TMT_STRING"

static const string	TMT_RF_HEADER_2 = "TMT_RF_HEADER_2"

static const string	TMT_NONE = ""

Protected Member Functions inherited from FinTP::TransportHelper
	TransportHelper (unsigned int messageIdLength)
	Private ctor. More...

Protected Attributes inherited from FinTP::TransportHelper
const unsigned int	m_MessageIdLength

string	m_QueueName

string	m_MessageId

string	m_CorrelationId

string	m_GroupId

int	m_GroupSequence

bool	m_UsePassedMessageId

bool	m_UsePassedCorrelId

bool	m_UsePassedGroupId

bool	m_UsePassedAppName

string	m_MessagePutDate

string	m_MessagePutTime

string	m_ReplyQueue

int	m_QueueOpenRefCount

long long	m_Feedback

bool	m_LastInGroup

string	m_ReplyUsrData

string	m_ApplicationName

string	m_SSLKeyRepository

string	m_SSLCypherSpec

string	m_SSLPeerName

unsigned int	m_MessageLength

int	m_AutoAbandon

string	m_BackupQueueName

bool	m_SaveBackup

Constructor & Destructor Documentation

AmqHelper::AmqHelper ( const std::string & connectionstring = "" )

explicit

AmqHelper::~AmqHelper ( )

Member Function Documentation

void AmqHelper::clearMessages ( )

virtual

Clears all messages in the current queue.

Implements FinTP::TransportHelper.

void AmqHelper::clearSSLOptions ( )

virtual

Implements FinTP::TransportHelper.

void AmqHelper::closeQueue ( )

private

bool AmqHelper::commit ( )

virtual

Commits the current session.

Implements FinTP::TransportHelper.

void AmqHelper::connect	(	const string &	queueManagerName = `""`,
		const string &	transportUri = `""`,
		bool	force = `false`
	)

virtual

Implements FinTP::TransportHelper.

void AmqHelper::connect	(	const string &	queueManagerName,
		const string &	transportUri,
		const string &	keyRepository,
		const string &	sslCypherSpec,
		const string &	sslPeerName,
		bool	force = `false`
	)

virtual

Reimplemented from FinTP::TransportHelper.

Message * AmqHelper::createMsg ( )

void AmqHelper::disconnect ( )

virtual

Implements FinTP::TransportHelper.

void AmqHelper::doConnect	(	const string &	brokerURIName,
		bool	force
	)

private

long AmqHelper::doGetOne	(	ManagedBuffer *	buffer,
		bool	getForClean,
		bool	syncpoint = `true`
	)

Get one message from the current queue and store it in a ManagedBuffer.

Parameters

buffer	Pointer to a ManagedBuffer used for storing the message data
getForClean	Bool - true if the message is to be discarded without affecting the Helper's state

Returns: 0 if succes, -1 if no message was retrieved and -2 if the message was moved to the dead letter queue

string FinTP::AmqHelper::getApplicationName ( ) const

inlinevirtual

Set message header value when message end up in Dead.letter.queue.

Implements FinTP::TransportHelper.

long AmqHelper::getGroupMessage	(	ManagedBuffer *	groupMessageBuffer,
		const string &	groupId,
		bool &	isCleaningUp
	)

virtual

Implements FinTP::TransportHelper.

string AmqHelper::getLastMessageFormat ( ) const

virtual

Implements FinTP::TransportHelper.

TRANSPORT_MESSAGE_TYPE FinTP::AmqHelper::getLastMessageType ( )

inlinevirtual

Implements FinTP::TransportHelper.

std::string FinTP::AmqHelper::getLastReplyBrokerURI ( ) const

inline

TransportReplyOptions AmqHelper::getLastReplyOptions ( ) const

virtual

TODO getLastReplyOptions to return ReplyOptions type.

Implements FinTP::TransportHelper.

std::string FinTP::AmqHelper::getLastReplyQueueManager ( ) const

inlinevirtual

Implements FinTP::TransportHelper.

int FinTP::AmqHelper::getLastSequenceId ( ) const

inline

time_t AmqHelper::getMessagePutTime ( )

long AmqHelper::getOne ( bool getForClean = false )

long AmqHelper::getOne	(	unsigned char *	buffer,
		size_t	maxSize,
		bool	syncpoint = `true`
	)

virtual

Implements FinTP::TransportHelper.

long FinTP::AmqHelper::getOne	(	ManagedBuffer *	buffer,
		bool	syncpoint = `true`,
		bool	keepJMSHeader = `true`
	)

inlinevirtual

Pull one message from MQ Server and return it in 'ManagedBuffer* buffer'.

Syncpoit participation is mandatory if transaction should be controlled by application Is method responsibility to set all ids for currently fetch message ( i.e m_MessageId, m_CorrelationId )

Parameters

ManagedBuffer*	buffer:returned MQ message
bool	syncpoint: true value, make the operation part of unit of work spanned over multiple operation
bool	keepJMSHeader: true value, make MQ header part of buffer

Implements FinTP::TransportHelper.

long AmqHelper::getQueueDepth ( const std::string & queueName = "" )

Works only for small queues.

For test purposes only.

Parameters

queueName String containing the queue's name

Returns: The current number of messages or -1 in case of error

int AmqHelper::noMessage ( )

private

void AmqHelper::openBackoutQueue ( const std::string & queueName )

void FinTP::AmqHelper::openQueue	(	bool	syncpoint,
		const std::string &	queueName = `""`
	)

void FinTP::AmqHelper::openQueue ( const std::string & queueName = "" )

long AmqHelper::peek	(	const std::string &	queueName = `""`,
		bool	first = `true`
	)

void AmqHelper::putGroupMessage	(	ManagedBuffer *	buffer,
		const string &	batchId,
		long	messageSequence,
		bool	isLast
	)

virtual

Implements FinTP::TransportHelper.

void AmqHelper::putOne	(	const ManagedBuffer &	buffer,
		bool	syncpoint = `true`
	)

void AmqHelper::putOne	(	unsigned char *	buffer,
		size_t	bufferSize,
		bool	syncpoint = `true`
	)

virtual

Implements FinTP::TransportHelper.

void FinTP::AmqHelper::putOne	(	unsigned char *	buffer,
		size_t	bufferSize,
		cms::Message &	msg
	)

void FinTP::AmqHelper::putOne	(	cms::Message &	msg,
		bool	syncpoint = `true`
	)

void AmqHelper::putOneReply	(	unsigned char *	buffer,
		size_t	bufferSize,
		long	feedback,
		TRANSPORT_MESSAGE_TYPE	messageType = `TMT_REPLY`
	)

virtual

Implements FinTP::TransportHelper.

void AmqHelper::putOneReply	(	const ManagedBuffer &	buffer,
		long	feedback
	)

void AmqHelper::putOneRequest	(	unsigned char *	buffer,
		size_t	bufferSize,
		const std::string &	rtqName,
		const std::string &	rtbName,
		TransportReplyOptions &	replyOptions
	)

void AmqHelper::putToDeadLetterQueue	(	cms::Message &	msg,
		bool	syncpoint = `true`
	)

void AmqHelper::reconnect ( )

void AmqHelper::resetUsePassedIds ( )

private

bool AmqHelper::rollback ( )

virtual

Rollbacks the current session.

Implements FinTP::TransportHelper.

bool AmqHelper::send	(	const string &	queueName,
		cms::Message &	msg,
		bool	syncpoint = `true`
	)

private

void AmqHelper::setApplicationName ( const std::string & applicationName )

void AmqHelper::setBackupQueue ( const std::string & queueName )

void AmqHelper::setConnectionBrokerURI ( )

inlineprivate

void AmqHelper::setCorrelationId ( const std::string & correlId )

void AmqHelper::setGroupId ( const std::string & groupId )

void AmqHelper::setLastMessageIds ( const cms::Message & msg )

private

Saves the message id, correlation id, group id, group sequence number, type and timestamp.

Parameters

msg	Reference to a CMS::Message

int AmqHelper::setLastMessageInfo	(	cms::Message *	msg,
		ManagedBuffer *	buffer,
		bool	browse = `false`,
		bool	get = `true`,
		bool	syncpoint = `true`
	)

private

void AmqHelper::setLastMessageReplyData ( const cms::Message & msg )

private

void AmqHelper::setMessageFormat ( const string & format )

virtual

Implements FinTP::TransportHelper.

void AmqHelper::setMessageId ( const std::string & messageId )

void FinTP::AmqHelper::setSequenceId ( int sequenceId )

void AmqHelper::setTimeout ( int millisecs )

string AmqHelper::ToString ( TransportHelper::TRANSPORT_MESSAGE_TYPE messageType )

private

TransportHelper::TRANSPORT_MESSAGE_TYPE AmqHelper::ToTransportMessageType ( const string & messageType )

private

void AmqHelper::updateSelector ( string & selector )

private

void AmqHelper::writeToBuffer	(	ManagedBuffer &	buffer,
		const unsigned char *	rawBuffer
	)

private

Member Data Documentation

const string AmqHelper::FINTPGROUPID = "FinTPGroupId"

staticprivate

const string AmqHelper::FINTPGROUPSEQ = "FinTPGroupSeq"

staticprivate

const string AmqHelper::FINTPLASTINGROUP = "FinTPLastInGroup"

staticprivate

cms::MessageConsumer * FinTP::AmqHelper::m_AutoAcknowledgeConsumer

private

cms::MessageProducer * FinTP::AmqHelper::m_AutoAcknowledgeProducer

private

cms::Session * FinTP::AmqHelper::m_AutoAcknowledgeSession

private

string FinTP::AmqHelper::m_BackoutQueueName

private

int FinTP::AmqHelper::m_BrokerURIOpenRefCount

private

activemq::core::ActiveMQConnection* FinTP::AmqHelper::m_Connection

private

string FinTP::AmqHelper::m_ConnectionString

private

cms::MessageConsumer* FinTP::AmqHelper::m_Consumer

private

map<string, int> FinTP::AmqHelper::m_GroupLogicOrder

private

long long FinTP::AmqHelper::m_MessageCMSTimestamp

private

const string* FinTP::AmqHelper::m_MessageFormatPointer

private

TRANSPORT_MESSAGE_TYPE FinTP::AmqHelper::m_MessageType

private

cms::MessageProducer* FinTP::AmqHelper::m_Producer

private

cms::QueueBrowser* FinTP::AmqHelper::m_QueueBrowser

private

string FinTP::AmqHelper::m_ReplyBrokerURI

private

long FinTP::AmqHelper::m_ReplyOptions

private

string FinTP::AmqHelper::m_Selector

private

cms::Session* FinTP::AmqHelper::m_Session

private

int FinTP::AmqHelper::m_Timeout

private

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

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation