Initial code drop of yang model driven configuration system
[controller.git] / opendaylight / config / config-api / src / main / java / org / opendaylight / controller / config / api / runtime / RootRuntimeBeanRegistrator.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.runtime;
9
10 import java.io.Closeable;
11
12 /**
13  * Entry point for runtime bean functionality. Allows for registering root
14  * runtime bean, returning an object that allows for hierarchical registrations.
15  */
16 public interface RootRuntimeBeanRegistrator extends Closeable {
17
18     HierarchicalRuntimeBeanRegistration registerRoot(RuntimeBean mxBean);
19
20     /**
21      * Close all runtime beans. This method is idempotent. It is allowed to use
22      * this instance to register root or create new child registrators
23      * afterwards, but it is not allowed to use closed registrations.
24      */
25     @Override
26     void close();
27
28 }