001/**
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.activemq.broker;
018
019import org.apache.activemq.Service;
020import org.apache.activemq.broker.region.ConnectorStatistics;
021import org.apache.activemq.command.BrokerInfo;
022
023/**
024 * A connector creates and manages client connections that talk to the Broker.
025 * 
026 * 
027 */
028public interface Connector extends Service {
029
030    /**
031     * @return brokerInfo
032     */
033    BrokerInfo getBrokerInfo();
034
035    /**
036     * @return the statistics for this connector
037     */
038    ConnectorStatistics getStatistics();
039    
040    /**
041     * @return true if update client connections when brokers leave/join a cluster
042     */
043    public boolean isUpdateClusterClients();
044
045    /**
046     * @return true if clients should be re-balanced across the cluster
047     */
048    public boolean isRebalanceClusterClients();
049    
050    /**
051     * Update all the connections with information
052     * about the connected brokers in the cluster
053     */
054    public void updateClientClusterInfo();
055    
056    /**
057     * @return true if clients should be updated when
058     * a broker is removed from a broker
059     */
060    public boolean  isUpdateClusterClientsOnRemove();
061
062    int connectionCount();
063}