Fix checkstyle issues to enforce it
[controller.git] / opendaylight / config / config-api / src / main / java / org / opendaylight / controller / config / api / LookupRegistry.java
1 /*
2  * Copyright (c) 2013, 2017 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.util.Set;
11 import javax.management.InstanceNotFoundException;
12 import javax.management.ObjectName;
13
14 public interface LookupRegistry {
15
16     /**
17      * Find all modules. Same Module can be registered multiple times.
18      *
19      * @return objectNames
20      */
21     Set<ObjectName> lookupConfigBeans();
22
23     /**
24      * Find modules with given module name.
25      *
26      * @param moduleName
27      *            name of module
28      * @return objectNames
29      */
30     Set<ObjectName> lookupConfigBeans(String moduleName);
31
32     /**
33      * Find read modules.
34      *
35      * @param moduleName
36      *            exact match for searched module name, can contain '*' to match all
37      *            values.
38      * @param instanceName
39      *            exact match for searched instance name, can contain '*' to match
40      *            all values.
41      * @return objectNames
42      */
43     Set<ObjectName> lookupConfigBeans(String moduleName, String instanceName);
44
45     /**
46      * Find read module.
47      *
48      * @param moduleName
49      *            exact match for searched module name, can contain '*' to match all
50      *            values.
51      * @param instanceName
52      *            exact match for searched instance name, can contain '*' to match
53      *            all values.
54      * @return objectNames
55      * @throws InstanceNotFoundException
56      *             if search did not find exactly one instance
57      */
58     ObjectName lookupConfigBean(String moduleName, String instanceName) throws InstanceNotFoundException;
59
60     /**
61      * Check that object name corresponds with existing module.
62      *
63      * @throws InstanceNotFoundException
64      *             if search did not find exactly one instance
65      */
66     void checkConfigBeanExists(ObjectName objectName) throws InstanceNotFoundException;
67
68     /**
69      * Get the qNames  of all ModuleFactory instances in the system.
70      *
71      * @return qNames of all ModuleFactory instances in the system
72      */
73     Set<String> getAvailableModuleFactoryQNames();
74
75     /**
76      * Find all runtime beans.
77      *
78      * @return objectNames
79      */
80     Set<ObjectName> lookupRuntimeBeans();
81
82     /**
83      * Find all runtime of specified module.
84      *
85      * @param moduleName
86      *            of bean
87      * @param instanceName
88      *            of bean
89      * @return objectNames
90      */
91     Set<ObjectName> lookupRuntimeBeans(String moduleName, String instanceName);
92 }

©2013 OpenDaylight, A Linux Foundation Collaborative Project. All Rights Reserved.
OpenDaylight is a registered trademark of The OpenDaylight Project, Inc.
Linux Foundation and OpenDaylight are registered trademarks of the Linux Foundation.
Linux is a registered trademark of Linus Torvalds.