org.opendaylight.controller.config.spi

Class AbstractModule<M extends AbstractModule<M>>

java.lang.Object

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

Type Parameters:

M - Type of module implementation. Enables easier implementation for the isSame() method

All Implemented Interfaces:

Module, org.opendaylight.yangtools.concepts.Identifiable<ModuleIdentifier>

Direct Known Subclasses:

AbstractActorSystemProviderModule, AbstractBindingAsyncDataBrokerImplModule, AbstractBindingBrokerImplModule, AbstractBindingNotificationAdapterModule, AbstractBindingNotificationPublishAdapterModule, AbstractClusterSingletonServiceProviderModule, AbstractDepTestImplModule, AbstractDistributedConfigDataStoreProviderModule, AbstractDistributedOperationalDataStoreProviderModule, AbstractDomBrokerImplModule, AbstractDomConcurrentDataBrokerModule, AbstractDomInmemoryDataBrokerModule, AbstractGlobalEventExecutorModule, AbstractHashedWheelTimerModule, AbstractIdentityTestModule, AbstractImmediateEventExecutorModule, AbstractInMemoryConfigDataStoreProviderModule, AbstractInMemoryOperationalDataStoreProviderModule, AbstractLegacyEntityOwnershipServiceProviderModule, AbstractMessageBusAppImplModule, AbstractMultipleDependenciesModule, AbstractNetconfTestImplModule, AbstractNettyThreadgroupModule, AbstractNotificationBrokerImplModule, AbstractPingpongDataBrokerModule, AbstractRuntimeMappingModule, AbstractSchemaServiceImplSingletonModule, AbstractShutdownModule, AbstractTestImplModule

public abstract class AbstractModule<M extends AbstractModule<M>>
extends Object
implements Module

Base implementation of Module. This implementation contains base logic for Module reconfiguration with associated fields.

Field Summary

Fields

Modifier and Type	Field and Description
protected DependencyResolver	dependencyResolver
protected ModuleIdentifier	identifier

Constructor Summary

Constructors

Constructor and Description
AbstractModule(ModuleIdentifier identifier, DependencyResolver dependencyResolver) Called when module is configured.
AbstractModule(ModuleIdentifier identifier, DependencyResolver dependencyResolver, M oldModule, AutoCloseable oldInstance) Called when module is reconfigured.

Method Summary

Modifier and Type	Method and Description
boolean	canReuse(Module prevModule) Compare current module with oldModule and if the instance/live object produced by the old module can be reused in this module as well return true.
protected abstract boolean	canReuseInstance(M prevModule) Users are welcome to override this method to provide custom logic for advanced reusability detection.
protected abstract AutoCloseable	createInstance() Create instance.
ModuleIdentifier	getIdentifier()
AutoCloseable	getInstance() General algorithm for spawning/closing and reusing wrapped instances.
protected abstract void	resolveDependencies() Inject all the dependencies using dependency resolver instance.
protected AutoCloseable	reuseInstance(AutoCloseable prevInstance) 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	setCanReuseInstance(boolean canReuseInstance)

Methods inherited from class java.lang.Object

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

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

validate

Field Detail

dependencyResolver

protected final DependencyResolver dependencyResolver

identifier

protected final ModuleIdentifier identifier

Constructor Detail

AbstractModule

public AbstractModule(ModuleIdentifier identifier,
                      DependencyResolver dependencyResolver)

Called when module is configured.

Parameters:

identifier - id of current instance.

dependencyResolver - resolver used in dependency injection and validation.

AbstractModule

public AbstractModule(ModuleIdentifier identifier,
                      DependencyResolver dependencyResolver,
                      M oldModule,
                      AutoCloseable oldInstance)

Called when module is reconfigured.

Parameters:

identifier - id of current instance.

dependencyResolver - resolver used in dependency injection and validation.

oldModule - old instance of module that is being reconfigred(replaced) by current instance. The old instance can be examined for reuse.

oldInstance - old instance wrapped by the old module. This is the resource that is actually being reused if possible or closed otherwise.

Method Detail

getIdentifier

public ModuleIdentifier getIdentifier()

Specified by:

getIdentifier in interface org.opendaylight.yangtools.concepts.Identifiable<ModuleIdentifier>

setCanReuseInstance

public final void setCanReuseInstance(boolean canReuseInstance)

getInstance

public final AutoCloseable getInstance()

General algorithm for spawning/closing and reusing wrapped instances.

Specified by:

getInstance in interface Module

Returns:

current instance of wrapped resource either by reusing the old one (if present) or constructing a brand new.

createInstance

protected abstract AutoCloseable createInstance()

Create instance.

Returns:

Brand new instance of wrapped class in case no previous instance is present or reconfiguration is impossible.

canReuse

public final boolean canReuse(Module prevModule)

Description copied from interface: Module

Compare current module with oldModule and if the instance/live object produced by the old module can be reused in this module as well return true. Typically true should be returned if the old module had the same configuration.

Specified by:

canReuse in interface Module

Parameters:

prevModule - old instance of Module

Returns:

true if the instance produced by oldModule can be reused with current instance as well.

canReuseInstance

protected abstract boolean canReuseInstance(M prevModule)

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

Parameters:

prevModule - old instance of a Module

Returns:

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

reuseInstance

protected AutoCloseable reuseInstance(AutoCloseable prevInstance)

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.

Parameters:

prevInstance - old instance of a class wrapped by the module

Returns:

reused instance

resolveDependencies

protected abstract void resolveDependencies()

Inject all the dependencies using dependency resolver instance.