org.opendaylight.controller.config.yang.md.sal.binding.impl

Class AbstractNotificationBrokerImplModule

java.lang.Object

org.opendaylight.controller.config.spi.AbstractModule<AbstractNotificationBrokerImplModule>

org.opendaylight.controller.config.yang.md.sal.binding.impl.AbstractNotificationBrokerImplModule

All Implemented Interfaces:

AbstractServiceInterface, RuntimeBeanRegistratorAwareModule, Module, NotificationBrokerImplModuleMXBean, NotificationProviderServiceServiceInterface, NotificationServiceServiceInterface, org.opendaylight.yangtools.concepts.Identifiable<ModuleIdentifier>

Direct Known Subclasses:

NotificationBrokerImplModule

public abstract class AbstractNotificationBrokerImplModule
extends AbstractModule<AbstractNotificationBrokerImplModule>
implements NotificationBrokerImplModuleMXBean, NotificationServiceServiceInterface, NotificationProviderServiceServiceInterface, RuntimeBeanRegistratorAwareModule

Field Summary

Fields

Modifier and Type	Field and Description
static JmxAttribute	notificationAdapterJmxAttribute
static JmxAttribute	notificationPublishAdapterJmxAttribute

Fields inherited from class org.opendaylight.controller.config.spi.AbstractModule

dependencyResolver, identifier

Constructor Summary

Constructors

Constructor and Description
AbstractNotificationBrokerImplModule(ModuleIdentifier identifier, DependencyResolver dependencyResolver)
AbstractNotificationBrokerImplModule(ModuleIdentifier identifier, DependencyResolver dependencyResolver, AbstractNotificationBrokerImplModule oldModule, AutoCloseable oldInstance)

Method Summary

Modifier and Type	Method and Description
boolean	canReuseInstance(AbstractNotificationBrokerImplModule oldModule) Users are welcome to override this method to provide custom logic for advanced reusability detection.
protected void	customValidation()
boolean	equals(Object o)
org.slf4j.Logger	getLogger()
ObjectName	getNotificationAdapter()
protected NotificationService	getNotificationAdapterDependency()
ObjectName	getNotificationPublishAdapter()
protected NotificationPublishService	getNotificationPublishAdapterDependency()
NotificationBrokerImplRuntimeRegistrator	getRootRuntimeBeanRegistratorWrapper()
int	hashCode()
boolean	isSame(AbstractNotificationBrokerImplModule other)
protected void	resolveDependencies() Inject all the dependencies using dependency resolver instance.
AutoCloseable	reuseInstance(AutoCloseable oldInstance) By default the oldInstance is returned since this method is by default called only if the oldModule had the same configuration and dependencies configured.
void	setNotificationAdapter(ObjectName notificationAdapter)
void	setNotificationPublishAdapter(ObjectName notificationPublishAdapter)
void	setRuntimeBeanRegistrator(RootRuntimeBeanRegistrator rootRuntimeRegistrator) Configuration framework will call this setter on all modules implementing this interface.
void	validate() This method will be called as first phase in two phase commit.

Methods inherited from class org.opendaylight.controller.config.spi.AbstractModule

canReuse, createInstance, getIdentifier, getInstance, setCanReuseInstance

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opendaylight.controller.config.spi.Module

canReuse, getInstance

Methods inherited from interface org.opendaylight.yangtools.concepts.Identifiable

getIdentifier

Field Detail

notificationPublishAdapterJmxAttribute

public static final JmxAttribute notificationPublishAdapterJmxAttribute

notificationAdapterJmxAttribute

public static final JmxAttribute notificationAdapterJmxAttribute

Constructor Detail

AbstractNotificationBrokerImplModule

public AbstractNotificationBrokerImplModule(ModuleIdentifier identifier,
                                            DependencyResolver dependencyResolver)

AbstractNotificationBrokerImplModule

public AbstractNotificationBrokerImplModule(ModuleIdentifier identifier,
                                            DependencyResolver dependencyResolver,
                                            AbstractNotificationBrokerImplModule oldModule,
                                            AutoCloseable oldInstance)

Method Detail

getRootRuntimeBeanRegistratorWrapper

public NotificationBrokerImplRuntimeRegistrator getRootRuntimeBeanRegistratorWrapper()

setRuntimeBeanRegistrator

public void setRuntimeBeanRegistrator(RootRuntimeBeanRegistrator rootRuntimeRegistrator)

Description copied from interface: RuntimeBeanRegistratorAwareModule

Configuration framework will call this setter on all modules implementing this interface. It is responsibility of modules or rather their instances to close registrator in their Closeable.close() method. Same module will get the same registrator during reconfiguration.

Specified by:

setRuntimeBeanRegistrator in interface RuntimeBeanRegistratorAwareModule

Parameters:

rootRuntimeRegistrator - root bean

validate

public void validate()

Description copied from interface: Module

This method will be called as first phase in two phase commit. Instance can check attributes, but is not allowed to do any kind of work that could leave any resources open. It is prohibited to call Module.getInstance() on dependent Module because it would destroy separation between validation and commit phase.

Specified by:

validate in interface Module

customValidation

protected void customValidation()

getNotificationPublishAdapterDependency

protected final NotificationPublishService getNotificationPublishAdapterDependency()

getNotificationAdapterDependency

protected final NotificationService getNotificationAdapterDependency()

resolveDependencies

protected final void resolveDependencies()

Description copied from class: AbstractModule

Inject all the dependencies using dependency resolver instance.

Specified by:

resolveDependencies in class AbstractModule<AbstractNotificationBrokerImplModule>

canReuseInstance

public boolean canReuseInstance(AbstractNotificationBrokerImplModule oldModule)

Description copied from class: AbstractModule

Users are welcome to override this method to provide custom logic for advanced reusability detection.

Specified by:

canReuseInstance in class AbstractModule<AbstractNotificationBrokerImplModule>

Parameters:

oldModule - old instance of a Module

Returns:

true if the old instance is reusable false if a new one should be spawned

reuseInstance

public AutoCloseable reuseInstance(AutoCloseable oldInstance)

Description copied from class: AbstractModule

By default the oldInstance is returned since this method is by default called only if the oldModule had the same configuration and dependencies configured. Users are welcome to override this method to provide custom logic for advanced reusability.

Overrides:

reuseInstance in class AbstractModule<AbstractNotificationBrokerImplModule>

Parameters:

oldInstance - old instance of a class wrapped by the module

Returns:

reused instance

isSame

public boolean isSame(AbstractNotificationBrokerImplModule other)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getNotificationPublishAdapter

public ObjectName getNotificationPublishAdapter()

Specified by:

getNotificationPublishAdapter in interface NotificationBrokerImplModuleMXBean

setNotificationPublishAdapter

public void setNotificationPublishAdapter(ObjectName notificationPublishAdapter)

Specified by:

setNotificationPublishAdapter in interface NotificationBrokerImplModuleMXBean

getNotificationAdapter

public ObjectName getNotificationAdapter()

Specified by:

getNotificationAdapter in interface NotificationBrokerImplModuleMXBean

setNotificationAdapter

public void setNotificationAdapter(ObjectName notificationAdapter)

Specified by:

setNotificationAdapter in interface NotificationBrokerImplModuleMXBean

getLogger

public org.slf4j.Logger getLogger()