src/semaine/cms/sender/Sender.h

Go to the documentation of this file.

/*
 *  Sender.h
 *  semaine
 *
 *  Created by Marc Schröder on 11.09.08.
 *  Copyright 2008 DFKI GmbH. All rights reserved.
 *
 */

#ifndef SEMAINE_CMS_SENDER_SENDER_H
#define SEMAINE_CMS_SENDER_SENDER_H

#include <semaine/config.h>

#include <cms/MessageProducer.h>
#include <cms/Message.h>

#include <semaine/cms/IOBase.h>
#include <semaine/cms/message/SEMAINEMessage.h>
#include <semaine/cms/exceptions/SEMAINEException.h>
#include <semaine/cms/exceptions/SystemConfigurationException.h>

using namespace cms;
using namespace semaine::cms;
using namespace semaine::cms::message;
using namespace semaine::cms::exceptions;

namespace semaine {
namespace cms {
namespace sender {
class Sender : public IOBase
{
public:

        Sender(const std::string & topicName, const std::string & datatype, const std::string & source)
        throw (CMSException);

        Sender(const std::string & cmsUrl, const std::string & cmsUser, const std::string & cmsPassword,
                const std::string & topicName, const std::string & datatype, const std::string & source)
        throw (CMSException);


        const std::string getDatatype()
        {
                return datatype;
        }

        const std::string getSource()
        {
                return source;
        }

        void setPeriodic(int aPeriod) throw(SEMAINEException)
        {
                if (aPeriod <= 0)
                        throw SEMAINEException("Period must be positive");
                this->period = aPeriod;
        }

        void setEventBased()
        {
                this->period = 0;
        }

        bool isPeriodic()
        {
                return period != 0;
        }

        bool isEventBased()
        {
                return period == 0;
        }

        int getPeriod()
        {
                if (isEventBased())
                        throw SEMAINEException("Cannot report period for event-based Sender!");
                return period;
        }

        void setTimeToLive(long long aTimeToLive) throw(CMSException)
        {
                CMSLogger::getLog(getTopicName()+" Sender")->warn("Ignoring deprecated call to setTimeToLive");
                //producer->setTimeToLive(aTimeToLive);
        }

        long long getTimeToLive() throw(CMSException)
        {
                return producer->getTimeToLive();
        }

        void sendTextMessage(const std::string & text, long long usertime)
        throw(CMSException, SystemConfigurationException);

        void sendTextMessage(const std::string & text, long long usertime, const std::string & contentID,
                        long long contentCreationTime, const std::string & contentType = "")
        throw(CMSException, SystemConfigurationException);

        void sendTextMessage(const std::string & text, long long usertime, const std::string & eventType)
        throw(CMSException, SystemConfigurationException);

        void sendTextMessage(const std::string & text, long long usertime, const std::string & eventType, const std::string & contentID,
                        long long contentCreationTime, const std::string & contentType = "")
        throw(CMSException, SystemConfigurationException);



protected:
        MessageProducer * producer;
        const std::string datatype;
        const std::string source;
        int period;

        void initialise() throw (CMSException);

        virtual void fillMessageProperties(Message * message, long long usertime)
        throw(CMSException)
        {
                message->setStringProperty(SEMAINEMessage::DATATYPE, getDatatype());
                message->setStringProperty(SEMAINEMessage::SOURCE, getSource());
                message->setLongProperty(SEMAINEMessage::USERTIME, usertime);
        }

        void fillMessageProperties(Message * message, long long usertime, const std::string & contentID,
                        long long contentCreationTime, const std::string & contentType = "")
        throw(CMSException)
        {
                fillMessageProperties(message, usertime);

                if (contentID != "") {
                        message->setStringProperty(SEMAINEMessage::CONTENT_ID, contentID);
                }
                if (contentCreationTime >= 0) {
                        message->setLongProperty(SEMAINEMessage::CONTENT_CREATION_TIME, contentCreationTime);
                }
                if (contentType != "") {
                        message->setStringProperty(SEMAINEMessage::CONTENT_TYPE, contentType);
                }

        }


};

} // namespace sender
} // namespace cms
} // namespace semaine

#endif

---