org.opendaylight.controller.config.yang.netty.threadgroup

Class AbstractNettyThreadgroupModuleFactory

java.lang.Object

org.opendaylight.controller.config.yang.netty.threadgroup.AbstractNettyThreadgroupModuleFactory

All Implemented Interfaces:

ModuleFactory

Direct Known Subclasses:

NettyThreadgroupModuleFactory

public abstract class AbstractNettyThreadgroupModuleFactory
extends Object
implements ModuleFactory

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME

Constructor Summary

Constructors

Constructor and Description
AbstractNettyThreadgroupModuleFactory()

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<NettyThreadgroupModule>	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()
NettyThreadgroupModule	handleChangedClass(DependencyResolver dependencyResolver, DynamicMBeanWithInstance old, org.osgi.framework.BundleContext bundleContext)
NettyThreadgroupModule	handleChangedClass(DynamicMBeanWithInstance old) Deprecated.
NettyThreadgroupModule	instantiateModule(String instanceName, DependencyResolver dependencyResolver, org.osgi.framework.BundleContext bundleContext)
NettyThreadgroupModule	instantiateModule(String instanceName, DependencyResolver dependencyResolver, NettyThreadgroupModule oldModule, AutoCloseable oldInstance, org.osgi.framework.BundleContext bundleContext)
boolean	isModuleImplementingServiceInterface(Class<? extends AbstractServiceInterface> serviceInterface)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Detail

AbstractNettyThreadgroupModuleFactory

public AbstractNettyThreadgroupModuleFactory()

Method Detail

getImplementationName

public final String getImplementationName()

Description copied from interface: ModuleFactory

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

Specified by:

getImplementationName in interface ModuleFactory

Returns:

human-friendly implementation name

isModuleImplementingServiceInterface

public final boolean isModuleImplementingServiceInterface(Class<? extends AbstractServiceInterface> serviceInterface)

Specified by:

isModuleImplementingServiceInterface in interface ModuleFactory

getImplementedServiceIntefaces

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

Specified by:

getImplementedServiceIntefaces in interface ModuleFactory

createModule

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

Description copied from interface: ModuleFactory

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

Specified by:

createModule in interface ModuleFactory

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

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

Description copied from interface: ModuleFactory

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.

Specified by:

createModule in interface ModuleFactory

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.

instantiateModule

public NettyThreadgroupModule instantiateModule(String instanceName,
                                                DependencyResolver dependencyResolver,
                                                NettyThreadgroupModule oldModule,
                                                AutoCloseable oldInstance,
                                                org.osgi.framework.BundleContext bundleContext)

instantiateModule

public NettyThreadgroupModule instantiateModule(String instanceName,
                                                DependencyResolver dependencyResolver,
                                                org.osgi.framework.BundleContext bundleContext)

handleChangedClass

public NettyThreadgroupModule handleChangedClass(DependencyResolver dependencyResolver,
                                                 DynamicMBeanWithInstance old,
                                                 org.osgi.framework.BundleContext bundleContext)
                                          throws Exception

Throws:

Exception

handleChangedClass

@Deprecated
public NettyThreadgroupModule handleChangedClass(DynamicMBeanWithInstance old)
                                                      throws Exception

Deprecated.

Throws:

Exception

getDefaultModules

public Set<NettyThreadgroupModule> getDefaultModules(DependencyResolverFactory dependencyResolverFactory,
                                                     org.osgi.framework.BundleContext bundleContext)

Description copied from interface: ModuleFactory

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.

Specified by:

getDefaultModules in interface ModuleFactory

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.