MBeanSource.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.hadoop.hbase.metrics;

import javax.management.ObjectName;

/**
 *  Object that will register an mbean with the underlying metrics implementation.
 */
public interface MBeanSource  {

  /**
   * Register an mbean with the underlying metrics system
   * @param serviceName Metrics service/system name
   * @param metricsName name of the metrics object to expose
   * @param theMbean the actual MBean
   * @return ObjectName from jmx
   */
  ObjectName register(String serviceName, String metricsName,
                             Object theMbean);

}