org.opendaylight.controller.config.api

Interface ConfigTransactionController

All Superinterfaces:

LookupRegistry, ServiceReferenceReadableRegistry, ServiceReferenceWritableRegistry

All Known Subinterfaces:

ConfigTransactionClient, ConfigTransactionControllerImplMXBean, ConfigTransactionControllerMXBean

All Known Implementing Classes:

ConfigTransactionControllerImpl, ConfigTransactionJMXClient

public interface ConfigTransactionController
extends LookupRegistry, ServiceReferenceWritableRegistry

Represents functionality provided by configuration transaction.

Method Summary

Modifier and Type	Method and Description
void	abortConfig() Destroy current transaction.
ObjectName	createModule(String moduleName, String instanceName) Create new configuration bean.
void	destroyModule(ObjectName objectName) Destroy existing module.
Set<String>	getAvailableModuleNames() Get the names of all available modules.
String	getTransactionName() Get the name of the transaction.
void	reCreateModule(ObjectName objectName) Re-creates an existing module configuration bean.
void	validateConfig() This method can be called multiple times, has no side effects.

Methods inherited from interface org.opendaylight.controller.config.api.LookupRegistry

checkConfigBeanExists, getAvailableModuleFactoryQNames, lookupConfigBean, lookupConfigBeans, lookupConfigBeans, lookupConfigBeans, lookupRuntimeBeans, lookupRuntimeBeans

Methods inherited from interface org.opendaylight.controller.config.api.ServiceReferenceWritableRegistry

removeAllServiceReferences, removeServiceReference, removeServiceReferences, saveServiceReference

Methods inherited from interface org.opendaylight.controller.config.api.ServiceReferenceReadableRegistry

checkServiceReferenceExists, getServiceInterfaceName, getServiceMapping, getServiceReference, lookupConfigBeanByServiceInterfaceName, lookupServiceInterfaceNames, lookupServiceReferencesByServiceInterfaceName

Method Detail

createModule

ObjectName createModule(String moduleName,
                        String instanceName)
                 throws InstanceAlreadyExistsException

Create new configuration bean.

Parameters:

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

void reCreateModule(ObjectName objectName)
             throws InstanceNotFoundException

Re-creates an existing module configuration bean.

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

IllegalArgumentException - if object name contains wrong transaction name or domain

destroyModule

void destroyModule(ObjectName objectName)
            throws InstanceNotFoundException

Destroy existing module.

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

IllegalArgumentException - if object name contains wrong transaction name or domain

abortConfig

void abortConfig()

Destroy current transaction.

validateConfig

void validateConfig()
             throws ValidationException

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

Throws:

ValidationException - if validation fails

getTransactionName

String getTransactionName()

Get the name of the transaction.

Returns:

transactionName

getAvailableModuleNames

Set<String> getAvailableModuleNames()

Get the names of all available modules.

Returns:

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