blob: 0fc47c56ea5b71b437022ec53652310ff9ee9aae [file] [log] [blame]
/*
* 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_DESTINATION_H_
#define _CMS_DESTINATION_H_
#include <cms/CMSProperties.h>
#include <cms/Config.h>
#include <string>
namespace cms {
/**
* A Destination object encapsulates a provider-specific address.
* <p>
* There is no standard definition of a Destination address, each provider can
* provide its own definition and there can be configuration data attached to the
* Destination address.
* <p>
* All CMS Destination objects support concurrent use.
*
* @since 1.0
*/
class CMS_API Destination {
public:
enum DestinationType {
TOPIC,
QUEUE,
TEMPORARY_TOPIC,
TEMPORARY_QUEUE
};
public:
virtual ~Destination();
/**
* Retrieve the Destination Type for this Destination
*
* @return The Destination Type
*/
virtual DestinationType getDestinationType() const = 0;
/**
* Creates a new instance of this destination type that is a
* copy of this one, and returns it.
*
* @return cloned copy of this object
*/
virtual cms::Destination* clone() const = 0;
/**
* Copies the contents of the given Destination object to this one.
*
* @param source
* The source Destination object.
*/
virtual void copy(const cms::Destination& source) = 0;
/**
* Compares two Destination instances to determine if they represent the same
* logic Destination.
*
* @param other
* The other destination to compare this one to.
*
* @return true if the two destinations are the same.
*/
virtual bool equals(const cms::Destination& other) const = 0;
/**
* Retrieve any properties that might be part of the destination
* that was specified. This is a deviation from the JMS spec
* but necessary due to C++ restrictions.
*
* @return A {const} reference to a CMSProperties object.
*/
virtual const CMSProperties& getCMSProperties() const = 0;
};
}
#endif /*_CMS_DESTINATION_H_*/