org.opendaylight.controller.config.yang.shutdown.impl

Class AbstractShutdownModule

java.lang.Object

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

org.opendaylight.controller.config.yang.shutdown.impl.AbstractShutdownModule

All Implemented Interfaces:

AbstractServiceInterface, RuntimeBeanRegistratorAwareModule, Module, ShutdownModuleMXBean, ShutdownServiceServiceInterface, org.opendaylight.yangtools.concepts.Identifiable<ModuleIdentifier>

Direct Known Subclasses:

ShutdownModule

public abstract class AbstractShutdownModule
extends AbstractModule<AbstractShutdownModule>
implements ShutdownModuleMXBean, ShutdownServiceServiceInterface, RuntimeBeanRegistratorAwareModule

Field Summary

Fields

Modifier and Type	Field and Description
static JmxAttribute	secretJmxAttribute

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

dependencyResolver, identifier

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	canReuseInstance(AbstractShutdownModule 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()
ShutdownRuntimeRegistrator	getRootRuntimeBeanRegistratorWrapper()
String	getSecret()
int	hashCode()
boolean	isSame(AbstractShutdownModule 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	setRuntimeBeanRegistrator(RootRuntimeBeanRegistrator rootRuntimeRegistrator) Configuration framework will call this setter on all modules implementing this interface.
void	setSecret(String secret)
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

secretJmxAttribute

public static final JmxAttribute secretJmxAttribute

Constructor Detail

AbstractShutdownModule

public AbstractShutdownModule(ModuleIdentifier identifier,
                              DependencyResolver dependencyResolver)

AbstractShutdownModule

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

Method Detail

getRootRuntimeBeanRegistratorWrapper

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

resolveDependencies

protected final void resolveDependencies()

Description copied from class: AbstractModule

Inject all the dependencies using dependency resolver instance.

Specified by:

resolveDependencies in class AbstractModule<AbstractShutdownModule>

canReuseInstance

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

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

Parameters:

oldInstance - old instance of a class wrapped by the module

Returns:

reused instance

isSame

public boolean isSame(AbstractShutdownModule other)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getSecret

public String getSecret()

Specified by:

getSecret in interface ShutdownModuleMXBean

setSecret

public void setSecret(String secret)

Specified by:

setSecret in interface ShutdownModuleMXBean

getLogger

public org.slf4j.Logger getLogger()