001/**
002 *
003 * Licensed to the Apache Software Foundation (ASF) under one
004 * or more contributor license agreements.  See the NOTICE file
005 * distributed with this work for additional information
006 * regarding copyright ownership.  The ASF licenses this file
007 * to you under the Apache License, Version 2.0 (the
008 * "License"); you may not use this file except in compliance
009 * with the License.  You may obtain a copy of the License at
010 *
011 *     http://www.apache.org/licenses/LICENSE-2.0
012 *
013 * Unless required by applicable law or agreed to in writing, software
014 * distributed under the License is distributed on an "AS IS" BASIS,
015 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
016 * See the License for the specific language governing permissions and
017 * limitations under the License.
018 */
019package org.apache.hadoop.hbase.conf;
020
021import org.apache.yetus.audience.InterfaceAudience;
022
023/**
024 * This extension to ConfigurationObserver allows the configuration to propagate to the children of
025 * the current {@link ConfigurationObserver}. This is the preferred way to make a class online
026 * configurable because it allows the user to configure the children in a recursive manner
027 * automatically. 
028 */
029@InterfaceAudience.Private
030public interface PropagatingConfigurationObserver extends ConfigurationObserver {
031
032  /**
033   * Needs to be called to register the children to the manager. 
034   * @param manager : to register to
035   */
036  void registerChildren(ConfigurationManager manager);
037
038  /**
039   * Needs to be called to deregister the children from the manager. 
040   * @param manager : to deregister from
041   */
042  void deregisterChildren(ConfigurationManager manager);
043}