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

Class AbstractRuntimeMappingModule

java.lang.Object

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

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

All Implemented Interfaces:

AbstractServiceInterface, Module, BindingToNormalizedNodeCodecServiceInterface, RuntimeMappingModuleMXBean, BindingCodecTreeFactoryServiceInterface, BindingNormalizedNodeSerializerServiceInterface, org.opendaylight.yangtools.concepts.Identifiable<ModuleIdentifier>

Direct Known Subclasses:

RuntimeMappingModule

public abstract class AbstractRuntimeMappingModule
extends AbstractModule<AbstractRuntimeMappingModule>
implements RuntimeMappingModuleMXBean, BindingCodecTreeFactoryServiceInterface, BindingNormalizedNodeSerializerServiceInterface, BindingToNormalizedNodeCodecServiceInterface, BindingCodecTreeFactoryServiceInterface, BindingNormalizedNodeSerializerServiceInterface

Field Summary

Fields

Modifier and Type	Field and Description
static JmxAttribute	waitForSchemaJmxAttribute

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

dependencyResolver, identifier

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	canReuseInstance(AbstractRuntimeMappingModule 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()
Boolean	getWaitForSchema()
int	hashCode()
boolean	isSame(AbstractRuntimeMappingModule 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	setWaitForSchema(Boolean waitForSchema)
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

Field Detail

waitForSchemaJmxAttribute

public static final JmxAttribute waitForSchemaJmxAttribute

Constructor Detail

AbstractRuntimeMappingModule

public AbstractRuntimeMappingModule(ModuleIdentifier identifier,
                                    DependencyResolver dependencyResolver)

AbstractRuntimeMappingModule

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

Method Detail

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

resolveDependencies

protected final void resolveDependencies()

Description copied from class: AbstractModule

Inject all the dependencies using dependency resolver instance.

Specified by:

resolveDependencies in class AbstractModule<AbstractRuntimeMappingModule>

canReuseInstance

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

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

Parameters:

oldInstance - old instance of a class wrapped by the module

Returns:

reused instance

isSame

public boolean isSame(AbstractRuntimeMappingModule other)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getWaitForSchema

public Boolean getWaitForSchema()

Specified by:

getWaitForSchema in interface RuntimeMappingModuleMXBean

setWaitForSchema

public void setWaitForSchema(Boolean waitForSchema)

Specified by:

setWaitForSchema in interface RuntimeMappingModuleMXBean

getLogger

public org.slf4j.Logger getLogger()