src/qpid/ha/BrokerReplicator.h

#ifndef QPID_HA_REPLICATOR_H
#define QPID_HA_REPLICATOR_H

/*
 *
 * 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.
 *
 */

#include "types.h"
#include "ReplicationTest.h"
#include "AlternateExchangeSetter.h"
#include "qpid/Address.h"
#include "qpid/broker/Exchange.h"
#include "qpid/broker/ConnectionObserver.h"
#include "qpid/types/Variant.h"
#include "qpid/management/ManagementObject.h"
#include "qpid/sys/unordered_map.h"
#include <boost/shared_ptr.hpp>
#include <boost/enable_shared_from_this.hpp>
#include <set>

namespace qpid {

namespace broker {
class Broker;
class Link;
class Bridge;
class SessionHandler;
class Connection;
class QueueRegistry;
class ExchangeRegistry;
}

namespace framing {
class FieldTable;
}

namespace ha {
class LogPrefix;
class HaBroker;
class QueueReplicator;

/**
 * Replicate configuration on a backup broker.
 *
 * Implemented as an exchange that subscribes to receive QMF
 * configuration events from the primary. It configures local queues
 * exchanges and bindings to replicate the primary.
 * It also creates QueueReplicators for newly replicated queues.
 *
 * THREAD UNSAFE:
 * All members except shutdown are only called in the Link's connection thread context.
 * shutdown() does not use any mutable state.
 *
 */
class BrokerReplicator : public broker::Exchange,
                         public boost::enable_shared_from_this<BrokerReplicator>,
                         public broker::ConnectionObserver
{
  public:
    typedef boost::shared_ptr<QueueReplicator> QueueReplicatorPtr;

    static boost::shared_ptr<BrokerReplicator> create(
        HaBroker&, const boost::shared_ptr<broker::Link>&);

    ~BrokerReplicator();

    void shutdown();

    // Exchange methods
    std::string getType() const;
    bool bind(boost::shared_ptr<broker::Queue>, const std::string&, const framing::FieldTable*);
    bool unbind(boost::shared_ptr<broker::Queue>, const std::string&, const framing::FieldTable*);
    void route(broker::Deliverable&);
    bool isBound(boost::shared_ptr<broker::Queue>, const std::string* const, const framing::FieldTable* const);
    bool hasBindings();

    // ConnectionObserver methods
    void connection(broker::Connection&);
    void opened(broker::Connection&);
    void closed(broker::Connection&);
    void forced(broker::Connection&, const std::string& /*message*/);

    QueueReplicatorPtr findQueueReplicator(const std::string& qname);

  private:
    BrokerReplicator(HaBroker&, const boost::shared_ptr<broker::Link>&);
    void initialize();          // Called in create()

    typedef std::pair<boost::shared_ptr<broker::Queue>, bool> CreateQueueResult;
    typedef std::pair<boost::shared_ptr<broker::Exchange>, bool> CreateExchangeResult;

    typedef void (BrokerReplicator::*DispatchFunction)(types::Variant::Map&);
    typedef qpid::sys::unordered_map<std::string, DispatchFunction> EventDispatchMap;

    class UpdateTracker;
    class ErrorListener;

    void connected(broker::Bridge&, broker::SessionHandler&);
    void existingQueue(const boost::shared_ptr<broker::Queue>&);
    void existingExchange(const boost::shared_ptr<broker::Exchange>&);

    void doEventQueueDeclare(types::Variant::Map& values);
    void doEventQueueDelete(types::Variant::Map& values);
    void doEventExchangeDeclare(types::Variant::Map& values);
    void doEventExchangeDelete(types::Variant::Map& values);
    void doEventBind(types::Variant::Map&);
    void doEventUnbind(types::Variant::Map&);
    void doEventMembersUpdate(types::Variant::Map&);
    void doEventSubscribe(types::Variant::Map&);

    void doResponseQueue(types::Variant::Map& values);
    void doResponseExchange(types::Variant::Map& values);
    void doResponseBind(types::Variant::Map& values);
    void doResponseHaBroker(types::Variant::Map& values);

    QueueReplicatorPtr startQueueReplicator(const boost::shared_ptr<broker::Queue>&);

    QueueReplicatorPtr replicateQueue(
        const std::string& name,
        bool durable,
        bool autodelete,
        const qpid::framing::FieldTable& arguments,
        const std::string& alternateExchange);

    CreateExchangeResult createExchange(
        const std::string& name,
        const std::string& type,
        bool durable,
        bool autodelete,
        const qpid::framing::FieldTable& args,
        const std::string& alternateExchange);

    bool deactivate(boost::shared_ptr<broker::Exchange> ex, bool destroy);
    void deleteQueue(const std::string& name, bool purge=true);
    void deleteExchange(const std::string& name);

    void disconnectedQueueReplicator(const boost::shared_ptr<QueueReplicator>&);
    void disconnected();

    void setMembership(const types::Variant::List&); // Set membership from list.

    const LogPrefix& logPrefix;
    ReplicationTest replicationTest;
    std::string userId, remoteHost;
    HaBroker& haBroker;
    broker::Broker& broker;
    broker::ExchangeRegistry& exchanges;
    broker::QueueRegistry& queues;
    boost::shared_ptr<broker::Link> link;
    bool initialized;
    AlternateExchangeSetter alternates;
    qpid::Address primary;
    broker::Connection* connect;
    EventDispatchMap dispatch;
    std::auto_ptr<UpdateTracker> queueTracker;
    std::auto_ptr<UpdateTracker> exchangeTracker;
};
}} // namespace qpid::broker

#endif  /*!QPID_HA_REPLICATOR_H*/