blob: d4bd3da926cbb82ce071d27c98bc762252e1d795 [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
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* See the License for the specific language governing permissions and
* limitations under the License.
#include <activemq/util/Config.h>
#include <string>
#include <vector>
#include <activemq/wireformat/WireFormatFactory.h>
#include <decaf/util/StlMap.h>
#include <decaf/util/NoSuchElementException.h>
#include <decaf/lang/exceptions/NullPointerException.h>
#include <decaf/lang/exceptions/IllegalArgumentException.h>
namespace activemq {
namespace library {
class ActiveMQCPP;
namespace wireformat {
* Registry of all WireFormat Factories that are available to the client
* at runtime. New WireFormat's must have a factory registered here before
* a connection attempt is made.
* @since 3.0
class AMQCPP_API WireFormatRegistry {
decaf::util::StlMap<std::string, WireFormatFactory*> registry;
// Hidden Constructor, prevents instantiation
// Hidden Copy Constructor
WireFormatRegistry( const WireFormatRegistry& registry );
// Hidden Assignment operator
WireFormatRegistry& operator=( const WireFormatRegistry& registry );
virtual ~WireFormatRegistry();
* Gets a Registered WireFormatFactory from the Registry and returns it
* if there is not a registered format factory with the given name an exception
* is thrown.
* @param name
* The name of the Factory to find in the Registry.
* @return the Factory registered under the given name.
* @throws NoSuchElementException if no factory is registered with that name.
WireFormatFactory* findFactory( const std::string& name ) const;
* Registers a new WireFormatFactory with this Registry. If a Factory with the
* given name is already registered it is overwritten with the new one. Once a
* factory is added to the Registry its lifetime is controlled by the Registry, it
* will be deleted once the Registry has been deleted.
* @param name
* The name of the new Factory to register.
* @param factory
* The new Factory to add to the Registry.
* @throws IllegalArgumentException is name is the empty string.
* @throws NullPointerException if the Factory is Null.
void registerFactory( const std::string& name, WireFormatFactory* factory );
* Unregisters the Factory with the given name and deletes that instance of the
* Factory.
* @param name
* Name of the Factory to unregister and destroy
void unregisterFactory( const std::string& name );
* Removes all Factories and deletes the instances of the Factory objects.
void unregisterAllFactories();
* Retrieves a list of the names of all the Registered WireFormat's in this
* Registry.
* @return stl vector of strings with all the WireFormat names registered.
std::vector<std::string> getWireFormatNames() const;
* Gets the single instance of the WireFormatRegistry
* @return reference to the single instance of this Registry
static WireFormatRegistry& getInstance();
static void initialize();
static void shutdown();
friend class activemq::library::ActiveMQCPP;