/**
 * 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.
 */
package org.apache.activemq.broker.jmx;

import org.apache.activemq.Service;

public interface ConnectorViewMBean extends Service {

    @MBeanInfo("Connection count")
    int connectionCount();

    /**
     * Resets the statistics
     */
    @MBeanInfo("Resets the statistics")
    void resetStatistics();

    /**
     * enable statistics gathering
     */
    @MBeanInfo("Enables statistics gathering")
    void enableStatistics();

    /**
     * disable statistics gathering
     */
    @MBeanInfo("Disables statistics gathering")
    void disableStatistics();

    /**
     * Returns true if statistics is enabled
     *
     * @return true if statistics is enabled
     */
    @MBeanInfo("Statistics gathering enabled")
    boolean isStatisticsEnabled();

    /**
     * Returns true if link stealing is enabled on this Connector
     *
     * @return true if link stealing is enabled.
     */
    @MBeanInfo("Link Stealing enabled")
    boolean isAllowLinkStealingEnabled();

    /**
     * @return true if update client connections when brokers leave/join a cluster
     */
    @MBeanInfo("Update client URL's when brokers leave/join a custer enabled")
    boolean isUpdateClusterClients();

    /**
     * @return true if clients should be re-balanced across the cluster
     */
    @MBeanInfo("Rebalance clients across the broker cluster enabled")
    boolean isRebalanceClusterClients();

    /**
     * @return true if clients should be updated when
     * a broker is removed from a broker
     */
    @MBeanInfo("Update clients when a broker is removed from a network enabled.")
    boolean isUpdateClusterClientsOnRemove();

    /**
     * @return The comma separated string of regex patterns to match
     * broker names for cluster client updates
     */
    @MBeanInfo("Comma separated list of regex patterns to match broker names for cluster client updates.")
    String getUpdateClusterFilter();

    /**
     * @return The number of occurrences the max connection count
     * has been exceed
     */
    @MBeanInfo("Max connection exceeded count")
    long getMaxConnectionExceededCount();

    /**
     * @return true if transport connector is started
     */
    @MBeanInfo("Connector started")
    boolean isStarted();
}
