src/main/cms/Message.h

Go to the documentation of this file.

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef _CMS_MESSAGE_H_
#define _CMS_MESSAGE_H_

#include <cms/Config.h>
#include <cms/Destination.h>
#include <cms/DeliveryMode.h>

#include <cms/CMSException.h>
#include <cms/IllegalStateException.h>
#include <cms/MessageFormatException.h>
#include <cms/MessageNotWriteableException.h>

namespace cms{

    class CMS_API Message {
    public:

        static const int DEFAULT_DELIVERY_MODE;

        static const int DEFAULT_MSG_PRIORITY;

        static const long long DEFAULT_TIME_TO_LIVE;

    public:

        virtual ~Message();

        virtual Message* clone() const = 0;

        virtual void acknowledge() const = 0;

        virtual void clearBody() = 0;

        virtual void clearProperties() = 0;

        virtual std::vector<std::string> getPropertyNames() const = 0;

        virtual bool propertyExists( const std::string& name ) const = 0;

        virtual bool getBooleanProperty( const std::string& name ) const = 0;

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

        virtual double getDoubleProperty( const std::string& name ) const = 0;

        virtual float getFloatProperty( const std::string& name ) const = 0;

        virtual int getIntProperty( const std::string& name ) const = 0;

        virtual long long getLongProperty( const std::string& name ) const = 0;

        virtual short getShortProperty( const std::string& name ) const = 0;

        virtual std::string getStringProperty( const std::string& name ) const = 0;

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

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

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

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

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

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

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

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

        virtual std::string getCMSCorrelationID() const = 0;

        virtual void setCMSCorrelationID( const std::string& correlationId ) = 0;

        virtual int getCMSDeliveryMode() const = 0;

        virtual void setCMSDeliveryMode( int mode ) = 0;

        virtual const Destination* getCMSDestination() const = 0;

        virtual void setCMSDestination( const Destination* destination ) = 0;

        virtual long long getCMSExpiration() const = 0;

        virtual void setCMSExpiration( long long expireTime ) = 0;

        virtual std::string getCMSMessageID() const = 0;

        virtual void setCMSMessageID( const std::string& id ) = 0;

        virtual int getCMSPriority() const = 0;

        virtual void setCMSPriority( int priority ) = 0;

        virtual bool getCMSRedelivered() const = 0;

        virtual void setCMSRedelivered( bool redelivered ) = 0;

        virtual const cms::Destination* getCMSReplyTo() const = 0;

        virtual void setCMSReplyTo( const cms::Destination* destination ) = 0;

        virtual long long getCMSTimestamp() const = 0;

        virtual void setCMSTimestamp( long long timeStamp ) = 0;

        virtual std::string getCMSType() const = 0;

        virtual void setCMSType( const std::string& type ) = 0;

    };
}

#endif /*_CMS_MESSAGE_H_*/