modules/zookeeper/src/main/java/org/apache/ignite/spi/discovery/zk/ZookeeperDiscoverySpiMBean.java

/*
 * 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.ignite.spi.discovery.zk;

import org.apache.ignite.mxbean.MXBeanDescription;
import org.apache.ignite.spi.IgniteSpiManagementMBean;
import org.apache.ignite.spi.discovery.DiscoverySpiMBean;

/**
 * Management bean for {@link ZookeeperDiscoverySpi}.
 */
@MXBeanDescription("MBean provide access to Zookeeper-based discovery SPI.")
public interface ZookeeperDiscoverySpiMBean extends IgniteSpiManagementMBean, DiscoverySpiMBean {
    /**
     * Gets node join order.
     *
     * @return Node Join Order.
     */
    @MXBeanDescription("Node Join Order.")
    public long getNodeOrder();

    /**
     * Gets connection string used to connect to ZooKeeper cluster.
     *
     * @return Zk Connection String.
     */
    @MXBeanDescription("Zk Connection String.")
    public String getZkConnectionString();

    /**
     * Gets session timeout used by Zk client of local Ignite node.
     *
     * @return Zk Session Timeout.
     */
    @MXBeanDescription("Zk Session Timeout (milliseconds).")
    public long getZkSessionTimeout();

    /**
     * Gets session id of Zk client established with ZooKeeper cluster.
     *
     * @return Zk Session Id.
     */
    @MXBeanDescription("Zk Session Id.")
    public String getZkSessionId();

    /**
     * Gets number of communication resolver called.
     *
     * @return Number of communication resolved oparations.
     */
    @MXBeanDescription("Communication error resolver call count.")
    public long getCommErrorProcNum();

    /**
     * Gets root path in ZooKeeper cluster Zk client uses to put data to.
     *
     * @return Zk Root Path.
     */
    @MXBeanDescription("Zk Root Path.")
    public String getZkRootPath();
}