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

Class AbstractDomBrokerImplModule

java.lang.Object

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

org.opendaylight.controller.config.yang.md.sal.dom.impl.AbstractDomBrokerImplModule

All Implemented Interfaces:

AbstractServiceInterface, RuntimeBeanRegistratorAwareModule, Module, BrokerServiceInterface, DomBrokerImplModuleMXBean, org.opendaylight.yangtools.concepts.Identifiable<ModuleIdentifier>

Direct Known Subclasses:

DomBrokerImplModule

public abstract class AbstractDomBrokerImplModule
extends AbstractModule<AbstractDomBrokerImplModule>
implements DomBrokerImplModuleMXBean, BrokerServiceInterface, RuntimeBeanRegistratorAwareModule

Field Summary

Fields

Modifier and Type	Field and Description
static JmxAttribute	asyncDataBrokerJmxAttribute
static JmxAttribute	notificationQueueDepthJmxAttribute
static JmxAttribute	notificationQueueParkJmxAttribute
static JmxAttribute	notificationQueueSpinJmxAttribute
static JmxAttribute	rootSchemaServiceJmxAttribute

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

dependencyResolver, identifier

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	canReuseInstance(AbstractDomBrokerImplModule oldModule) Users are welcome to override this method to provide custom logic for advanced reusability detection.
protected void	customValidation()
boolean	equals(Object o)
ObjectName	getAsyncDataBroker()
protected DOMDataBroker	getAsyncDataBrokerDependency()
org.slf4j.Logger	getLogger()
MaxQueueDepth	getNotificationQueueDepth()
Integer	getNotificationQueuePark()
Integer	getNotificationQueueSpin()
DomBrokerImplRuntimeRegistrator	getRootRuntimeBeanRegistratorWrapper()
ObjectName	getRootSchemaService()
protected SchemaService	getRootSchemaServiceDependency()
int	hashCode()
boolean	isSame(AbstractDomBrokerImplModule 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	setAsyncDataBroker(ObjectName asyncDataBroker)
void	setNotificationQueueDepth(MaxQueueDepth notificationQueueDepth) Maximum number of elements in the notification queue, must be power-of-two.
void	setNotificationQueuePark(Integer notificationQueuePark) Number of milliseconds notification queue should park for new requests before blocking.
void	setNotificationQueueSpin(Integer notificationQueueSpin) Number of milliseconds notification queue should spin for new requests before parking.
void	setRootSchemaService(ObjectName rootSchemaService)
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

notificationQueueSpinJmxAttribute

public static final JmxAttribute notificationQueueSpinJmxAttribute

rootSchemaServiceJmxAttribute

public static final JmxAttribute rootSchemaServiceJmxAttribute

notificationQueueParkJmxAttribute

public static final JmxAttribute notificationQueueParkJmxAttribute

notificationQueueDepthJmxAttribute

public static final JmxAttribute notificationQueueDepthJmxAttribute

asyncDataBrokerJmxAttribute

public static final JmxAttribute asyncDataBrokerJmxAttribute

Constructor Detail

AbstractDomBrokerImplModule

public AbstractDomBrokerImplModule(ModuleIdentifier identifier,
                                   DependencyResolver dependencyResolver)

AbstractDomBrokerImplModule

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

Method Detail

getRootRuntimeBeanRegistratorWrapper

public DomBrokerImplRuntimeRegistrator 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()

getRootSchemaServiceDependency

protected final SchemaService getRootSchemaServiceDependency()

getAsyncDataBrokerDependency

protected final DOMDataBroker getAsyncDataBrokerDependency()

resolveDependencies

protected final void resolveDependencies()

Description copied from class: AbstractModule

Inject all the dependencies using dependency resolver instance.

Specified by:

resolveDependencies in class AbstractModule<AbstractDomBrokerImplModule>

canReuseInstance

public boolean canReuseInstance(AbstractDomBrokerImplModule 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<AbstractDomBrokerImplModule>

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<AbstractDomBrokerImplModule>

Parameters:

oldInstance - old instance of a class wrapped by the module

Returns:

reused instance

isSame

public boolean isSame(AbstractDomBrokerImplModule other)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getNotificationQueueSpin

public Integer getNotificationQueueSpin()

Specified by:

getNotificationQueueSpin in interface DomBrokerImplModuleMXBean

setNotificationQueueSpin

public void setNotificationQueueSpin(Integer notificationQueueSpin)

Number of milliseconds notification queue should spin for new requests before parking.

Specified by:

setNotificationQueueSpin in interface DomBrokerImplModuleMXBean

getRootSchemaService

public ObjectName getRootSchemaService()

Specified by:

getRootSchemaService in interface DomBrokerImplModuleMXBean

setRootSchemaService

public void setRootSchemaService(ObjectName rootSchemaService)

Specified by:

setRootSchemaService in interface DomBrokerImplModuleMXBean

getNotificationQueuePark

public Integer getNotificationQueuePark()

Specified by:

getNotificationQueuePark in interface DomBrokerImplModuleMXBean

setNotificationQueuePark

public void setNotificationQueuePark(Integer notificationQueuePark)

Number of milliseconds notification queue should park for new requests before blocking.

Specified by:

setNotificationQueuePark in interface DomBrokerImplModuleMXBean

getNotificationQueueDepth

public MaxQueueDepth getNotificationQueueDepth()

Specified by:

getNotificationQueueDepth in interface DomBrokerImplModuleMXBean

setNotificationQueueDepth

public void setNotificationQueueDepth(MaxQueueDepth notificationQueueDepth)

Maximum number of elements in the notification queue, must be power-of-two.

Specified by:

setNotificationQueueDepth in interface DomBrokerImplModuleMXBean

getAsyncDataBroker

public ObjectName getAsyncDataBroker()

Specified by:

getAsyncDataBroker in interface DomBrokerImplModuleMXBean

setAsyncDataBroker

public void setAsyncDataBroker(ObjectName asyncDataBroker)

Specified by:

setAsyncDataBroker in interface DomBrokerImplModuleMXBean

getLogger

public org.slf4j.Logger getLogger()