org.opendaylight.controller.config.api

Interface LookupRegistry

All Known Subinterfaces:

ConfigRegistry, ConfigRegistryClient, ConfigRegistryImplMXBean, ConfigRegistryMXBean, ConfigTransactionClient, ConfigTransactionController, ConfigTransactionControllerImplMXBean, ConfigTransactionControllerMXBean

All Known Implementing Classes:

ConfigRegistryImpl, ConfigRegistryJMXClient, ConfigTransactionControllerImpl, ConfigTransactionJMXClient, JMXNotifierConfigRegistry

public interface LookupRegistry

Method Summary

Modifier and Type	Method and Description
void	checkConfigBeanExists(ObjectName objectName) Check that object name corresponds with existing module.
Set<String>	getAvailableModuleFactoryQNames() Get the qNames of all ModuleFactory instances in the system.
ObjectName	lookupConfigBean(String moduleName, String instanceName) Find read module.
Set<ObjectName>	lookupConfigBeans() Find all modules.
Set<ObjectName>	lookupConfigBeans(String moduleName) Find modules with given module name.
Set<ObjectName>	lookupConfigBeans(String moduleName, String instanceName) Find read modules.
Set<ObjectName>	lookupRuntimeBeans() Find all runtime beans.
Set<ObjectName>	lookupRuntimeBeans(String moduleName, String instanceName) Find all runtime of specified module.

Method Detail

lookupConfigBeans

Set<ObjectName> lookupConfigBeans()

Find all modules. Same Module can be registered multiple times.

Returns:

objectNames

lookupConfigBeans

Set<ObjectName> lookupConfigBeans(String moduleName)

Find modules with given module name.

Parameters:

moduleName - name of module

Returns:

objectNames

lookupConfigBeans

Set<ObjectName> lookupConfigBeans(String moduleName,
                                  String instanceName)

Find read modules.

Parameters:

moduleName - exact match for searched module name, can contain '*' to match all values.

instanceName - exact match for searched instance name, can contain '*' to match all values.

Returns:

objectNames

lookupConfigBean

ObjectName lookupConfigBean(String moduleName,
                            String instanceName)
                     throws InstanceNotFoundException

Find read module.

Parameters:

moduleName - exact match for searched module name, can contain '*' to match all values.

instanceName - exact match for searched instance name, can contain '*' to match all values.

Returns:

objectNames

Throws:

InstanceNotFoundException - if search did not find exactly one instance

checkConfigBeanExists

void checkConfigBeanExists(ObjectName objectName)
                    throws InstanceNotFoundException

Check that object name corresponds with existing module.

Throws:

InstanceNotFoundException - if search did not find exactly one instance

getAvailableModuleFactoryQNames

Set<String> getAvailableModuleFactoryQNames()

Get the qNames of all ModuleFactory instances in the system.

Returns:

qNames of all ModuleFactory instances in the system

lookupRuntimeBeans

Set<ObjectName> lookupRuntimeBeans()

Find all runtime beans.

Returns:

objectNames

lookupRuntimeBeans

Set<ObjectName> lookupRuntimeBeans(String moduleName,
                                   String instanceName)

Find all runtime of specified module.

Parameters:

moduleName - of bean

instanceName - of bean

Returns:

objectNames