DbusClusterInfo.java

package com.linkedin.databus.client.pub;
/*
 *
 * Copyright 2013 LinkedIn Corp. All rights reserved
 *
 * Licensed 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.
 *
*/


/**
 *
 * Databus client cluster info. Typical use is for client load-balancing.
 */
public class DbusClusterInfo
{
  private final String _name;
  private final long _totalPartitions;
  private final long _minActiveNodes;

  /**
   *
   * @param name Name of the cluster
   * @param totalPartitions Total number of partitions for this cluster
   * @param minActiveNodes Minimum number of nodes to become active before partition allocation starts.
   */
  public DbusClusterInfo( String name, long totalPartitions, long minActiveNodes)
  {
    _name = name;
    _totalPartitions = totalPartitions;
    _minActiveNodes = minActiveNodes;
  }


  /**  Name of the cluster that this registration wants to join */
  public String getName()
  {
    return _name;
  }

  /**
   * Total Number of partitions for the PEER cluster type.
   */
  public long getNumTotalPartitions()
  {
    return _totalPartitions;
  }


  /**
   * Minimum number of client nodes to be Alive before this node starts listening to active partitions.
   * At any time, if the number of nodes becomes less than this critical number, the nodes in the cluster will be suspended.
   */
  public long getMinimumActiveNodes()
  {
    return _minActiveNodes;
  }

  @Override
  public String toString()
  {
    return "DbusClusterInfo [name=" + _name +"; totalPartitions=" + _totalPartitions +
           "; minActiveNodes=" + _minActiveNodes + "]";
  }
}