org.opendaylight.controller.config.spi

Interface ModuleFactory

public interface ModuleFactory

Factory which creates Module instances. An instance of this interface needs to be exported into the OSGi Service Registry. Such an instance provides metadata describing services which can be published from it. Each {@link Module } can optionally be instantiated with a {@link DynamicMBean} which represents the configuration of the currently running instance.

Method Summary

Modifier and Type	Method and Description
Module	createModule(String instanceName, DependencyResolver dependencyResolver, org.osgi.framework.BundleContext bundleContext) Create a new Module instance.
Module	createModule(String instanceName, DependencyResolver dependencyResolver, DynamicMBeanWithInstance old, org.osgi.framework.BundleContext bundleContext) Create a new Module instance.
Set<? extends Module>	getDefaultModules(DependencyResolverFactory dependencyResolverFactory, org.osgi.framework.BundleContext bundleContext) Called when ModuleFactory is registered to config manager.
String	getImplementationName() Returns the human-friendly implementation name.
Set<Class<? extends AbstractServiceInterface>>	getImplementedServiceIntefaces()
boolean	isModuleImplementingServiceInterface(Class<? extends AbstractServiceInterface> serviceInterface)

Method Detail

getImplementationName

String getImplementationName()

Returns the human-friendly implementation name. This value needs to be unique within all implementations of all interfaces returned by getImplementedInterfaces().

Returns:

human-friendly implementation name

createModule

Module createModule(String instanceName,
                    DependencyResolver dependencyResolver,
                    org.osgi.framework.BundleContext bundleContext)

Create a new Module instance. The returned object is expected to use the dependencyResolver provided when resolving ObjectNames to actual Module instances.

Parameters:

dependencyResolver - This resolver will return actual config mbean based on its ObjectName.

bundleContext - Reference to OSGi bundleContext that can be used to acquire OSGi services, startup configuration and other OSGi related information.

Returns:

newly created module

createModule

Module createModule(String instanceName,
                    DependencyResolver dependencyResolver,
                    DynamicMBeanWithInstance old,
                    org.osgi.framework.BundleContext bundleContext)
             throws Exception

Create a new Module instance. The returned object is expected to use the dependencyResolver provided when resolving ObjectNames to actual Module instances. A reference to an abstract view of the previous configuration is also provided in the form of a DynamicMBean. Implementations should use the MBeanInfo interface to understand the structure of the configuration information. Structural information impacts hot-swap operations in that in order to perform such a swap the newly loaded code needs to understand the previously-running instance configuration layout and how to map it onto itself.

Parameters:

dependencyResolver - This resolver will return actual config mbean based on its ObjectName.

old - existing module from platform MBeanServer that is being reconfigured. Implementations should inspect its attributes using DynamicMBean#getAttribute(String) and set those attributes on newly created module. If reconfiguration of live instances is supported, this live instance can be retreived using DynamicMBeanWithInstance.getInstance() . It is possible that casting this old instance throws ClassCastException when OSGi bundle is being updated. In this case, implementation should revert to creating new instance.

bundleContext - Reference to OSGi bundleContext that can be used to acquire OSGi services, startup configuration and other OSGi related information.

Returns:

newly created module

Throws:

Exception - if it is not possible to recover configuration from old. This leaves server in a running state but no configuration transaction can be created.

isModuleImplementingServiceInterface

boolean isModuleImplementingServiceInterface(Class<? extends AbstractServiceInterface> serviceInterface)

getImplementedServiceIntefaces

Set<Class<? extends AbstractServiceInterface>> getImplementedServiceIntefaces()

getDefaultModules

Set<? extends Module> getDefaultModules(DependencyResolverFactory dependencyResolverFactory,
                                        org.osgi.framework.BundleContext bundleContext)

Called when ModuleFactory is registered to config manager. Useful for populating the registry with pre-existing state. Since the method is called for each ModuleFactory separately and transaction is committed automatically, returned modules MUST be valid and commitable without any manual intervention.

Parameters:

dependencyResolverFactory - factory for getting dependency resolvers for each module.

bundleContext - Reference to OSGi bundleContext that can be used to acquire OSGi services, startup configuration and other OSGi related information.

Returns:

set of default modules. Null is not allowed.