Open Source Repository

Home /spring/spring-context-3.0.5 | Repository Home



org/springframework/jmx/export/metadata/ManagedMetric.java
/*
 * Copyright 2002-2009 the original author or authors.
 *
 * 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.
 */

package org.springframework.jmx.export.metadata;

import org.springframework.jmx.support.MetricType;

/**
 * Metadata that indicates to expose a given bean property as a JMX attribute,
 * with additional descriptor properties that indicate that the attribute is a
 * metric. Only valid when used on a JavaBean getter.
 *
 @author Jennifer Hickey
 @since 3.0
 @see org.springframework.jmx.export.assembler.MetadataMBeanInfoAssembler
 */
public class ManagedMetric extends AbstractJmxAttribute {

  private String category = "";

  private String displayName = "";

  private MetricType metricType = MetricType.GAUGE;

  private int persistPeriod = -1;

  private String persistPolicy = "";

  private String unit = "";


  /**
   * The category of this metric (ex. throughput, performance, utilization).
   */
  public void setCategory(String category) {
    this.category = category;
  }

  /**
   * The category of this metric (ex. throughput, performance, utilization).
   */
  public String getCategory() {
    return this.category;
  }

  /**
   * A display name for this metric.
   */
  public void setDisplayName(String displayName) {
    this.displayName = displayName;
  }

  /**
   * A display name for this metric.
   */
  public String getDisplayName() {
    return this.displayName;
  }

  /**
   * A description of how this metric's values change over time.
   */
  public void setMetricType(MetricType metricType) {
    this.metricType = metricType;
  }

  /**
   * A description of how this metric's values change over time.
   */
  public MetricType getMetricType() {
    return this.metricType;
  }

  /**
   * The persist period for this metric.
   */
  public void setPersistPeriod(int persistPeriod) {
    this.persistPeriod = persistPeriod;
  }

  /**
   * The persist period for this metric.
   */
  public int getPersistPeriod() {
    return this.persistPeriod;
  }

  /**
   * The persist policy for this metric.
   */
  public void setPersistPolicy(String persistPolicy) {
    this.persistPolicy = persistPolicy;
  }

  /**
   * The persist policy for this metric.
   */
  public String getPersistPolicy() {
    return this.persistPolicy;
  }

  /**
   * The expected unit of measurement values.
   */
  public void setUnit(String unit) {
    this.unit = unit;
  }

  /**
   * The expected unit of measurement values.
   */
  public String getUnit() {
    return this.unit;
  }

}