View Javadoc

1   /**
2    *
3    * Licensed to the Apache Software Foundation (ASF) under one
4    * or more contributor license agreements.  See the NOTICE file
5    * distributed with this work for additional information
6    * regarding copyright ownership.  The ASF licenses this file
7    * to you under the Apache License, Version 2.0 (the
8    * "License"); you may not use this file except in compliance
9    * with the License.  You may obtain a copy of the License at
10   *
11   *     http://www.apache.org/licenses/LICENSE-2.0
12   *
13   * Unless required by applicable law or agreed to in writing, software
14   * distributed under the License is distributed on an "AS IS" BASIS,
15   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16   * See the License for the specific language governing permissions and
17   * limitations under the License.
18   */
19  package org.apache.hadoop.hbase.conf;
20  
21  import org.apache.hadoop.hbase.classification.InterfaceAudience;
22  
23  /**
24   * This extension to ConfigurationObserver allows the configuration to propagate to the children of
25   * the current {@link ConfigurationObserver}. This is the preferred way to make a class online
26   * configurable because it allows the user to configure the children in a recursive manner
27   * automatically. 
28   */
29  @InterfaceAudience.Private
30  public interface PropagatingConfigurationObserver extends ConfigurationObserver {
31  
32    /**
33     * Needs to be called to register the children to the manager. 
34     * @param manager : to register to
35     */
36    void registerChildren(ConfigurationManager manager);
37  
38    /**
39     * Needs to be called to deregister the children from the manager. 
40     * @param manager : to deregister from
41     */
42    void deregisterChildren(ConfigurationManager manager);
43  }