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.conf;
019
020import org.apache.yetus.audience.InterfaceAudience;
021
022/**
023 * This extension to ConfigurationObserver allows the configuration to propagate to the children of
024 * the current {@link ConfigurationObserver}. This is the preferred way to make a class online
025 * configurable because it allows the user to configure the children in a recursive manner
026 * automatically.
027 */
028@InterfaceAudience.Private
029public interface PropagatingConfigurationObserver extends ConfigurationObserver {
030
031  /**
032   * Needs to be called to register the children to the manager.
033   * @param manager : to register to
034   */
035  void registerChildren(ConfigurationManager manager);
036
037  /**
038   * Needs to be called to deregister the children from the manager.
039   * @param manager : to deregister from
040   */
041  void deregisterChildren(ConfigurationManager manager);
042}