Initial code drop of yang model driven configuration system
[controller.git] / opendaylight / config / config-api / src / main / java / org / opendaylight / controller / config / api / RuntimeBeanRegistratorAwareModule.java
1 /*
2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
3  *
4  * This program and the accompanying materials are made available under the
5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6  * and is available at http://www.eclipse.org/legal/epl-v10.html
7  */
8 package org.opendaylight.controller.config.api;
9
10 import java.io.Closeable;
11
12 import org.opendaylight.controller.config.api.runtime.RootRuntimeBeanRegistrator;
13 import org.opendaylight.controller.config.spi.Module;
14
15 /**
16  * Module implementing this interface will receive
17  * {@link RootRuntimeBeanRegistrator} before getInstance() is invoked.
18  */
19 public interface RuntimeBeanRegistratorAwareModule extends Module {
20     /**
21      * Configuration framework will call this setter on all modules implementing
22      * this interface. It is responsibility of modules or rather their instances
23      * to close registrator in their {@link Closeable#close()} method. Same
24      * module will get the same registrator during reconfiguration.
25      *
26      * @param rootRuntimeBeanRegistrator
27      */
28     public void setRuntimeBeanRegistrator(
29             RootRuntimeBeanRegistrator rootRuntimeBeanRegistrator);
30
31 }