org.opendaylight.controller.config.spi

Interface Module

All Superinterfaces:

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

All Known Subinterfaces:

RuntimeBeanRegistratorAwareModule

All Known Implementing Classes:

AbstractActorSystemProviderModule, AbstractBindingAsyncDataBrokerImplModule, AbstractBindingBrokerImplModule, AbstractBindingNotificationAdapterModule, AbstractBindingNotificationPublishAdapterModule, AbstractClusterSingletonServiceProviderModule, AbstractDepTestImplModule, AbstractDistributedConfigDataStoreProviderModule, AbstractDistributedOperationalDataStoreProviderModule, AbstractDomBrokerImplModule, AbstractDomConcurrentDataBrokerModule, AbstractDomInmemoryDataBrokerModule, AbstractGlobalEventExecutorModule, AbstractHashedWheelTimerModule, AbstractIdentityTestModule, AbstractImmediateEventExecutorModule, AbstractInMemoryConfigDataStoreProviderModule, AbstractInMemoryOperationalDataStoreProviderModule, AbstractLegacyEntityOwnershipServiceProviderModule, AbstractMessageBusAppImplModule, AbstractModule, AbstractMultipleDependenciesModule, AbstractNetconfTestImplModule, AbstractNettyThreadgroupModule, AbstractNotificationBrokerImplModule, AbstractPingpongDataBrokerModule, AbstractRuntimeMappingModule, AbstractSchemaServiceImplSingletonModule, AbstractShutdownModule, AbstractTestImplModule, ActorSystemProviderModule, BindingAsyncDataBrokerImplModule, BindingBrokerImplModule, BindingNotificationAdapterModule, BindingNotificationPublishAdapterModule, ClusterSingletonServiceProviderModule, DepTestImplModule, DistributedConfigDataStoreProviderModule, DistributedOperationalDataStoreProviderModule, DomBrokerImplModule, DomConcurrentDataBrokerModule, DomInmemoryDataBrokerModule, GlobalEventExecutorModule, HashedWheelTimerModule, IdentityTestModule, ImmediateEventExecutorModule, InMemoryConfigDataStoreProviderModule, InMemoryOperationalDataStoreProviderModule, LegacyEntityOwnershipServiceProviderModule, MessageBusAppImplModule, MultipleDependenciesModule, NetconfTestImplModule, NettyThreadgroupModule, NotificationBrokerImplModule, PingpongDataBrokerModule, RuntimeMappingModule, SchemaServiceImplSingletonModule, ShutdownModule, TestImplModule

@NotThreadSafe
public interface Module
extends org.opendaylight.yangtools.concepts.Identifiable<ModuleIdentifier>

Represents one service that is to be configured. These methods need to be implemented in addition to the usual attribute getters/setters. Dependencies should always be injected as ObjectName references to the corresponding ConfigBeans.

In order to guide dependency resolution, the setter method should be annotated with RequireInterface.

Thread safety note: implementations of this interface are not required to be thread safe as thread safety is enforced by configuration manager.

Method Summary

Modifier and Type	Method and Description
boolean	canReuse(Module oldModule) 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.
AutoCloseable	getInstance() Returns 'live' object that was configured using this object.
void	validate() This method will be called as first phase in two phase commit.

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

getIdentifier

Method Detail

validate

void validate()

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 getInstance() on dependent Module because it would destroy separation between validation and commit phase.

getInstance

AutoCloseable getInstance()

Returns 'live' object that was configured using this object. It is allowed to call this method only after all ConfigBeans were validated. In this method new resources might be opened or old instance might be modified. This method must be implemented so that it returns same result for a single transaction. Since Module is created per transaction this means that it must be safe to cache result of first call.

Returns:

closeable instance: After bundle update the factory might be able to copy old configuration into new one without being able to cast Module or the instance. Thus to clean up old instance, it will call close().

canReuse

boolean canReuse(Module oldModule)

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.

Parameters:

oldModule - old instance of Module

Returns:

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