semaine::cms::receiver::XMLReceiver Class Reference

#include <XMLReceiver.h>

Inheritance diagram for semaine::cms::receiver::XMLReceiver:

List of all members.

Public Member Functions
	XMLReceiver (const std::string &topicName) throw (CMSException)
	XMLReceiver (const std::string &topicName, const std::string &messageSelector) throw (CMSException)
	XMLReceiver (const std::string &cmsUrl, const std::string &cmsUser, const std::string &cmsPassword, const std::string &topicName) throw (CMSException)
	XMLReceiver (const std::string &cmsUrl, const std::string &cmsUser, const std::string &cmsPassword, const std::string &topicName, const std::string &messageSelector) throw (CMSException)
Protected Member Functions
virtual SEMAINEMessage *	createSEMAINEMessage (const Message *message) throw (semaine::cms::exceptions::MessageFormatException)

---

Detailed Description

An abstraction of the Receiver for XML.

Author:

marc

---

Constructor & Destructor Documentation

semaine::cms::receiver::XMLReceiver::XMLReceiver

(

const std::string &

topicName

)

throw (CMSException) [inline]

Create a receiver that will listen for all messages in the given Topic on the default JMS server. The default JMS server is determined as follows:

• jms URL: default value tcp://localhost:61616;
• jms User: default value empty;
• jms Password: default value empty.

Parameters:

topic

the name of the CMS Topic to listen to.

semaine::cms::receiver::XMLReceiver::XMLReceiver	(	const std::string &	topicName,
		const std::string &	messageSelector
	)			throw (CMSException) [inline]

Create a receiver that will listen only to the messages in the given Topic that will pass the given messageSelector, on the default JMS server. The default JMS server is determined as follows:

• jms URL: default value tcp://localhost:61616;
• jms User: default value empty;
• jms Password: default value empty.

Parameters:

	topicName	the name of the JMS Topic to listen to.
	messageSelector	a message selector expression, see e.g. http://java.sun.com/javaee/5/docs/api/javax/jms/Message.html for the detailed description.

semaine::cms::receiver::XMLReceiver::XMLReceiver	(	const std::string &	cmsUrl,
		const std::string &	cmsUser,
		const std::string &	cmsPassword,
		const std::string &	topicName
	)			throw (CMSException) [inline]

Create a receiver that will listen for all messages in the given Topic on the given JMS server.

Parameters:

	cmsUrl	the url where to contact the JMS server
	cmsUser	the username to use (can be an empty string)
	cmsPassword	the password to use (can be an empty string)
	topic	the name of the CMS Topic to listen to.

semaine::cms::receiver::XMLReceiver::XMLReceiver	(	const std::string &	cmsUrl,
		const std::string &	cmsUser,
		const std::string &	cmsPassword,
		const std::string &	topicName,
		const std::string &	messageSelector
	)			throw (CMSException) [inline]

Create a receiver that will listen only to the messages in the given Topic that will pass the given messageSelector, on the given JMS server.

Parameters:

	cmsUrl	the url where to contact the JMS server
	cmsUser	the username to use (can be an empty string)
	cmsPassword	the password to use (can be an empty string)
	topicName	the name of the JMS Topic to listen to.
	messageSelector	a message selector expression, see e.g. http://java.sun.com/javaee/5/docs/api/javax/jms/Message.html for the detailed description.

---

Member Function Documentation

virtual SEMAINEMessage* semaine::cms::receiver::XMLReceiver::createSEMAINEMessage

(

const Message *

message

)

throw (semaine::cms::exceptions::MessageFormatException) [inline, protected, virtual]

Create a SEMAINE message from the given CMS message. Subclasses may want to override this in order to provide subclasses of SEMAINEMessage for their data.

Parameters:

message

the CMS method to convert into a SEMAINE message.

Exceptions:

	MessageFormatException	if the message format is problematic
	NullPointerException	if message is null.

Reimplemented from semaine::cms::receiver::Receiver.

Reimplemented in semaine::cms::receiver::EmmaReceiver, and semaine::cms::receiver::StateReceiver.

---

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

• src/semaine/cms/receiver/XMLReceiver.h