001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.apache.hadoop.hbase.metrics;
019
020import javax.management.ObjectName;
021import org.apache.yetus.audience.InterfaceAudience;
022
023/**
024 * Object that will register an mbean with the underlying metrics implementation.
025 */
026@InterfaceAudience.Private
027public interface MBeanSource {
028
029  /**
030   * Register an mbean with the underlying metrics system
031   * @param serviceName Metrics service/system name
032   * @param metricsName name of the metrics object to expose
033   * @param theMbean    the actual MBean
034   * @return ObjectName from jmx
035   */
036  ObjectName register(String serviceName, String metricsName, Object theMbean);
037
038}