org.opendaylight.controller.config.manager.impl

Class ConfigTransactionControllerImpl

java.lang.Object

org.opendaylight.controller.config.manager.impl.ConfigTransactionControllerImpl

All Implemented Interfaces:

ConfigTransactionController, LookupRegistry, ServiceReferenceReadableRegistry, ServiceReferenceWritableRegistry, ConfigTransactionControllerImplMXBean, org.opendaylight.yangtools.concepts.Identifiable<TransactionIdentifier>

public class ConfigTransactionControllerImpl
extends Object
implements ConfigTransactionControllerImplMXBean, org.opendaylight.yangtools.concepts.Identifiable<TransactionIdentifier>

This is a JMX bean representing current transaction. It contains transaction identifier, unique version and parent version for optimistic locking.

Constructor Summary

Constructors

Constructor and Description

ConfigTransactionControllerImpl(org.opendaylight.controller.config.manager.impl.ConfigTransactionLookupRegistry txLookupRegistry, long parentVersion, BindingContextProvider bindingContextProvider, long currentVersion, Map<String,Map.Entry<ModuleFactory,org.osgi.framework.BundleContext>> currentlyRegisteredFactories, MBeanServer transactionsMBeanServer, MBeanServer configMBeanServer, boolean blankTransaction, SearchableServiceReferenceWritableRegistry writableSRRegistry)

Method Summary

Modifier and Type	Method and Description
void	abortConfig() Destroy current transaction.
void	checkConfigBeanExists(ObjectName objectName) Check that object name corresponds with existing module.
void	checkServiceReferenceExists(ObjectName objectName)
void	close()
void	copyExistingModulesAndProcessFactoryDiff(Collection<ModuleInternalInfo> existingModules, List<ModuleFactory> lastListOfFactories) 1, Copy already committed modules to current transaction.
ObjectName	createModule(String factoryName, String instanceName) Create new configuration bean.
void	destroyModule(ObjectName objectName) Destroy existing module.
Set<String>	getAvailableModuleFactoryQNames() Get the qNames of all ModuleFactory instances in the system.
Set<String>	getAvailableModuleNames() Get the names of all available modules.
ObjectName	getControllerObjectName() Gets the objectName of this transaction controller.
List<ModuleFactory>	getCurrentlyRegisteredFactories()
TransactionIdentifier	getIdentifier()
org.osgi.framework.BundleContext	getModuleFactoryBundleContext(String factoryName)
TransactionIdentifier	getName()
long	getParentVersion() Get version of config registry when this transaction was created.
String	getServiceInterfaceName(String namespace, String localName) Get the name of the service interface.
Map<String,Map<String,ObjectName>>	getServiceMapping() Get mapping of services to reference names and module object names.
ObjectName	getServiceReference(String serviceInterfaceQName, String refName) Get the reference to that service.
TransactionIdentifier	getTransactionIdentifier()
String	getTransactionName() Get the name of the transaction.
long	getVersion() Get version of current transaction.
SearchableServiceReferenceWritableRegistry	getWritableRegistry()
boolean	isClosed() Check if the transaction was committed or aborted.
ObjectName	lookupConfigBean(String moduleName, String instanceName) Find read module.
ObjectName	lookupConfigBeanByServiceInterfaceName(String serviceInterfaceQName, String refName) Lookup object name by fully qualified service interface name and service reference name.
Set<ObjectName>	lookupConfigBeans() Find all modules.
Set<ObjectName>	lookupConfigBeans(String moduleName) Find modules with given module name.
Set<ObjectName>	lookupConfigBeans(String moduleName, String instanceName) Find read modules.
Set<ObjectName>	lookupRuntimeBeans() Find all runtime beans.
Set<ObjectName>	lookupRuntimeBeans(String moduleName, String instanceName) Find all runtime of specified module.
Set<String>	lookupServiceInterfaceNames(ObjectName objectName) Find all available service interface names of a module.
Map<String,ObjectName>	lookupServiceReferencesByServiceInterfaceName(String serviceInterfaceQName) Get current mapping between reference names and module object names for given service interface name.
void	reCreateModule(ObjectName objectName) Re-creates an existing module configuration bean.
void	removeAllServiceReferences() Remove all service references.
void	removeServiceReference(String serviceInterfaceName, String refName) Remove service reference.
boolean	removeServiceReferences(ObjectName objectName) Remove all service references attached to given module.
ObjectName	saveServiceReference(String serviceInterfaceName, String refName, ObjectName moduleON) Create or update reference name to objectName.
List<ModuleIdentifier>	secondPhaseCommit() Call Module.getInstance() on all beans in transaction.
String	toString()
CommitInfo	validateBeforeCommitAndLockTransaction() If this method passes validation, it will grab TransactionStatus.secondPhaseCommitStarted lock.
void	validateConfig() This method can be called multiple times, has no side effects.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigTransactionControllerImpl

public ConfigTransactionControllerImpl(org.opendaylight.controller.config.manager.impl.ConfigTransactionLookupRegistry txLookupRegistry,
                                       long parentVersion,
                                       BindingContextProvider bindingContextProvider,
                                       long currentVersion,
                                       Map<String,Map.Entry<ModuleFactory,org.osgi.framework.BundleContext>> currentlyRegisteredFactories,
                                       MBeanServer transactionsMBeanServer,
                                       MBeanServer configMBeanServer,
                                       boolean blankTransaction,
                                       SearchableServiceReferenceWritableRegistry writableSRRegistry)

Method Detail

copyExistingModulesAndProcessFactoryDiff

public void copyExistingModulesAndProcessFactoryDiff(Collection<ModuleInternalInfo> existingModules,
                                                     List<ModuleFactory> lastListOfFactories)

1, Copy already committed modules to current transaction. 2, Diff: compute added and removed factories from last run, then create new modules using .ModuleFactory#getDefaultModules(org.opendaylight.controller .config .api.DependencyResolverFactory, BundleContext) and remove modules belonging to removed factories.

Parameters:

existingModules - entries

lastListOfFactories - list of factories

createModule

public ObjectName createModule(String factoryName,
                               String instanceName)
                        throws InstanceAlreadyExistsException

Description copied from interface: ConfigTransactionController

Create new configuration bean.

Specified by:

createModule in interface ConfigTransactionController

Parameters:

factoryName - name of the module

instanceName - name of the instance

Returns:

ObjectName of newly created module

Throws:

InstanceAlreadyExistsException - if given ifcName and instanceName is already registered

reCreateModule

public void reCreateModule(ObjectName objectName)
                    throws InstanceNotFoundException

Description copied from interface: ConfigTransactionController

Re-creates an existing module configuration bean.

Specified by:

reCreateModule in interface ConfigTransactionController

Parameters:

objectName - can be either read-only module name that can be obtained using LookupRegistry.lookupConfigBean(String, String) or writable module name that must contain current transaction name.

Throws:

InstanceNotFoundException - if module is not found

destroyModule

public void destroyModule(ObjectName objectName)
                   throws InstanceNotFoundException

Description copied from interface: ConfigTransactionController

Destroy existing module.

Specified by:

destroyModule in interface ConfigTransactionController

Parameters:

objectName - can be either read-only module name that can be obtained using LookupRegistry.lookupConfigBean(String, String) or writable module name that must contain current transaction name.

Throws:

InstanceNotFoundException - if module is not found

getParentVersion

public long getParentVersion()

Description copied from interface: ConfigTransactionControllerImplMXBean

Get version of config registry when this transaction was created.

Specified by:

getParentVersion in interface ConfigTransactionControllerImplMXBean

Returns:

parent version

getVersion

public long getVersion()

Description copied from interface: ConfigTransactionControllerImplMXBean

Get version of current transaction.

Specified by:

getVersion in interface ConfigTransactionControllerImplMXBean

Returns:

version

validateConfig

public void validateConfig()
                    throws ValidationException

Description copied from interface: ConfigTransactionController

This method can be called multiple times, has no side effects.

Specified by:

validateConfig in interface ConfigTransactionController

Throws:

ValidationException - if validation fails

validateBeforeCommitAndLockTransaction

public CommitInfo validateBeforeCommitAndLockTransaction()
                                                  throws ValidationException

If this method passes validation, it will grab TransactionStatus.secondPhaseCommitStarted lock. This lock will prevent calling @{link #validateBeforeCommitAndLockTransaction}, effectively only allowing to call secondPhaseCommit() after successful return of this method.

Returns:

CommitInfo commit info

Throws:

ValidationException

secondPhaseCommit

public List<ModuleIdentifier> secondPhaseCommit()

Call Module.getInstance() on all beans in transaction. This method can be only called once.

Returns:

ordered list of module identifiers that respects dependency order

abortConfig

public void abortConfig()

Description copied from interface: ConfigTransactionController

Destroy current transaction.

Specified by:

abortConfig in interface ConfigTransactionController

close

public void close()

getControllerObjectName

public ObjectName getControllerObjectName()

Gets the objectName of this transaction controller.

Returns:

ObjectName

getTransactionName

public String getTransactionName()

Description copied from interface: ConfigTransactionController

Get the name of the transaction.

Specified by:

getTransactionName in interface ConfigTransactionController

Returns:

transactionName

lookupConfigBeans

public Set<ObjectName> lookupConfigBeans()

Find all modules. Same Module can be registered multiple times.

Specified by:

lookupConfigBeans in interface LookupRegistry

Returns:

objectNames

lookupConfigBeans

public Set<ObjectName> lookupConfigBeans(String moduleName)

Find modules with given module name.

Specified by:

lookupConfigBeans in interface LookupRegistry

Parameters:

moduleName - name of module

Returns:

objectNames

lookupConfigBeans

public Set<ObjectName> lookupConfigBeans(String moduleName,
                                         String instanceName)

Find read modules.

Specified by:

lookupConfigBeans in interface LookupRegistry

Parameters:

moduleName - exact match for searched module name, can contain '*' to match all values.

instanceName - exact match for searched instance name, can contain '*' to match all values.

Returns:

objectNames

lookupConfigBean

public ObjectName lookupConfigBean(String moduleName,
                                   String instanceName)
                            throws InstanceNotFoundException

Find read module.

Specified by:

lookupConfigBean in interface LookupRegistry

Parameters:

moduleName - exact match for searched module name, can contain '*' to match all values.

instanceName - exact match for searched instance name, can contain '*' to match all values.

Returns:

objectNames

Throws:

InstanceNotFoundException - if search did not find exactly one instance

checkConfigBeanExists

public void checkConfigBeanExists(ObjectName objectName)
                           throws InstanceNotFoundException

Check that object name corresponds with existing module.

Specified by:

checkConfigBeanExists in interface LookupRegistry

Throws:

InstanceNotFoundException - if search did not find exactly one instance

lookupRuntimeBeans

public Set<ObjectName> lookupRuntimeBeans()

Find all runtime beans.

Specified by:

lookupRuntimeBeans in interface LookupRegistry

Returns:

objectNames

lookupRuntimeBeans

public Set<ObjectName> lookupRuntimeBeans(String moduleName,
                                          String instanceName)

Find all runtime of specified module.

Specified by:

lookupRuntimeBeans in interface LookupRegistry

Parameters:

moduleName - of bean

instanceName - of bean

Returns:

objectNames

getAvailableModuleNames

public Set<String> getAvailableModuleNames()

Get the names of all available modules.

Specified by:

getAvailableModuleNames in interface ConfigTransactionController

Returns:

all known module factory names as reported by ModuleFactory.getImplementationName()

isClosed

public boolean isClosed()

Check if the transaction was committed or aborted.

Returns:

result of transaction

toString

public String toString()

Overrides:

toString in class Object

getName

public TransactionIdentifier getName()

getCurrentlyRegisteredFactories

public List<ModuleFactory> getCurrentlyRegisteredFactories()

getIdentifier

public TransactionIdentifier getIdentifier()

Specified by:

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

getModuleFactoryBundleContext

public org.osgi.framework.BundleContext getModuleFactoryBundleContext(String factoryName)

lookupConfigBeanByServiceInterfaceName

public ObjectName lookupConfigBeanByServiceInterfaceName(String serviceInterfaceQName,
                                                         String refName)

Description copied from interface: ServiceReferenceReadableRegistry

Lookup object name by fully qualified service interface name and service reference name.

Specified by:

lookupConfigBeanByServiceInterfaceName in interface ServiceReferenceReadableRegistry

Parameters:

serviceInterfaceQName - service interface name

refName - service reference name supplied in .api .ConfigTransactionController#saveServiceReference(String, String, javax.management.ObjectName)

getServiceMapping

public Map<String,Map<String,ObjectName>> getServiceMapping()

Description copied from interface: ServiceReferenceReadableRegistry

Get mapping of services to reference names and module object names.

Specified by:

getServiceMapping in interface ServiceReferenceReadableRegistry

lookupServiceReferencesByServiceInterfaceName

public Map<String,ObjectName> lookupServiceReferencesByServiceInterfaceName(String serviceInterfaceQName)

Description copied from interface: ServiceReferenceReadableRegistry

Get current mapping between reference names and module object names for given service interface name.

Specified by:

lookupServiceReferencesByServiceInterfaceName in interface ServiceReferenceReadableRegistry

Parameters:

serviceInterfaceQName - service interface name

lookupServiceInterfaceNames

public Set<String> lookupServiceInterfaceNames(ObjectName objectName)
                                        throws InstanceNotFoundException

Description copied from interface: ServiceReferenceReadableRegistry

Find all available service interface names of a module.

Specified by:

lookupServiceInterfaceNames in interface ServiceReferenceReadableRegistry

Parameters:

objectName - module object name

Throws:

InstanceNotFoundException - if search did not find exactly one instance

getServiceInterfaceName

public String getServiceInterfaceName(String namespace,
                                      String localName)

Description copied from interface: ServiceReferenceReadableRegistry

Get the name of the service interface.

Specified by:

getServiceInterfaceName in interface ServiceReferenceReadableRegistry

Parameters:

namespace - service interface namespace

localName - service interface local name

Returns:

fully qualified name needed by all other service reference mapping methods.

saveServiceReference

public ObjectName saveServiceReference(String serviceInterfaceName,
                                       String refName,
                                       ObjectName moduleON)
                                throws InstanceNotFoundException

Description copied from interface: ServiceReferenceWritableRegistry

Create or update reference name to objectName. Reference name is unique per service interface name.

Specified by:

saveServiceReference in interface ServiceReferenceWritableRegistry

Returns:

created or updated object name containing service name and reference name

Throws:

InstanceNotFoundException - if search did not find exactly one instance

removeServiceReference

public void removeServiceReference(String serviceInterfaceName,
                                   String refName)
                            throws InstanceNotFoundException

Description copied from interface: ServiceReferenceWritableRegistry

Remove service reference.

Specified by:

removeServiceReference in interface ServiceReferenceWritableRegistry

Throws:

InstanceNotFoundException

removeAllServiceReferences

public void removeAllServiceReferences()

Description copied from interface: ServiceReferenceWritableRegistry

Remove all service references.

Specified by:

removeAllServiceReferences in interface ServiceReferenceWritableRegistry

removeServiceReferences

public boolean removeServiceReferences(ObjectName objectName)
                                throws InstanceNotFoundException

Description copied from interface: ServiceReferenceWritableRegistry

Remove all service references attached to given module.

Specified by:

removeServiceReferences in interface ServiceReferenceWritableRegistry

Returns:

true iif at least one reference was removed

Throws:

InstanceNotFoundException

getWritableRegistry

public SearchableServiceReferenceWritableRegistry getWritableRegistry()

getTransactionIdentifier

public TransactionIdentifier getTransactionIdentifier()

getAvailableModuleFactoryQNames

public Set<String> getAvailableModuleFactoryQNames()

Description copied from interface: LookupRegistry

Get the qNames of all ModuleFactory instances in the system.

Specified by:

getAvailableModuleFactoryQNames in interface LookupRegistry

Returns:

qNames of all ModuleFactory instances in the system

checkServiceReferenceExists

public void checkServiceReferenceExists(ObjectName objectName)
                                 throws InstanceNotFoundException

Specified by:

checkServiceReferenceExists in interface ServiceReferenceReadableRegistry

Throws:

InstanceNotFoundException

getServiceReference

public ObjectName getServiceReference(String serviceInterfaceQName,
                                      String refName)
                               throws InstanceNotFoundException

Description copied from interface: ServiceReferenceReadableRegistry

Get the reference to that service.

Specified by:

getServiceReference in interface ServiceReferenceReadableRegistry

Returns:

ObjectName with type=Service that was created using .config .api.ServiceReferenceWritableRegistry#saveServiceReference(String, String, javax.management.ObjectName)

Throws:

InstanceNotFoundException