gemfire-core/src/main/java/com/gemstone/gemfire/management/ServerLoadData.java

/*
 *  =========================================================================
 *  Copyright (c) 2002-2014 Pivotal Software, Inc. All Rights Reserved.
 * This product is protected by U.S. and international copyright
 * and intellectual property laws. Pivotal products are covered by
 * more patents listed at http://www.pivotal.io/patents.
 *  ========================================================================
 */
package com.gemstone.gemfire.management;

import java.beans.ConstructorProperties;

/**
 * Composite data type used to distribute server load information.
 * 
 * @author rishim
 * @since 7.0
 */
public class ServerLoadData {

  private float connectionLoad;
  private float subscriberLoad;
  private float loadPerConnection;
  private float loadPerSubscriber;

  /**
   * This constructor is to be used by internal JMX framework only. User
   * should not try to create an instance of this class.
   */
  @ConstructorProperties( { "connectionLoad", "subscriberLoad",
      "loadPerConnection", "loadPerSubscriber" })
  public ServerLoadData(float connectionLoad, float subscriberLoad,
      float loadPerConnection, float loadPerSubscriber) {
    this.connectionLoad = connectionLoad;
    this.subscriberLoad = subscriberLoad;
    this.loadPerConnection = loadPerConnection;
    this.loadPerSubscriber = loadPerSubscriber;

  }

  /**
   * Returns the load on the server due to client to server connections.
   */
  public float getConnectionLoad() {
    return connectionLoad;
  }

  /**
   * Returns the load on the server due to subscription connections.
   */
  public float getSubscriberLoad() {
    return subscriberLoad;
  }

  /**
   * Returns an estimate of how much load each new connection will add to this
   * server. The Locator use this information to estimate the load on the server
   * before it receives a new load snapshot.
   */
  public float getLoadPerConnection() {
    return loadPerConnection;
  }

  /**
   * Returns an estimate of the much load each new subscriber will add to this
   * server. The Locator uses this information to estimate the load on the
   * server before it receives a new load snapshot.
   */
  public float getLoadPerSubscriber() {
    return loadPerSubscriber;
  }

  /**
   * String representation of ServerLoadData
   */
  @Override
  public String toString() {

    return "{ServerLoad is : connectionLoad = " + connectionLoad
        + " subscriberLoad = " + subscriberLoad + " loadPerConnection = "
        + loadPerConnection + " loadPerSubscriber = " + loadPerSubscriber
        + " }";
  }

}