org.opendaylight.controller.config.api

Interface ConfigRegistry

All Superinterfaces:

LookupRegistry, ServiceReferenceReadableRegistry

All Known Subinterfaces:

ConfigRegistryMXBean

public interface ConfigRegistry
extends LookupRegistry, ServiceReferenceReadableRegistry

Provides functionality for working with configuration registry - mainly creating and committing config transactions.

Field Summary

Fields

Modifier and Type	Field and Description
static ObjectName	OBJECT_NAME Only well-known ObjectName in configuration system, under which ConfigRegisry is registered.
static ObjectName	OBJECT_NAME_NO_NOTIFICATIONS

Method Summary

Modifier and Type	Method and Description
ObjectName	beginConfig() Opens new configuration transaction.
CommitStatus	commitConfig(ObjectName transactionControllerON) Verifies and commits transaction.
Set<String>	getAvailableModuleNames()
List<ObjectName>	getOpenConfigs()
boolean	isHealthy() Will return true unless there was a transaction that succeeded during validation but failed in second phase of commit.

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.ServiceReferenceReadableRegistry

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

Field Detail

OBJECT_NAME

static final ObjectName OBJECT_NAME

Only well-known ObjectName in configuration system, under which ConfigRegisry is registered.

OBJECT_NAME_NO_NOTIFICATIONS

static final ObjectName OBJECT_NAME_NO_NOTIFICATIONS

Method Detail

beginConfig

ObjectName beginConfig()

Opens new configuration transaction.

Returns:

ObjectName of ConfigTransactionControllerMXBean

commitConfig

CommitStatus commitConfig(ObjectName transactionControllerON)
                   throws ConflictingVersionException,
                          ValidationException

Verifies and commits transaction.

Parameters:

transactionControllerON - ObjectName of ConfigTransactionControllerMXBean that was received in beginConfig() method call.

Returns:

CommitStatus

Throws:

ValidationException - if validation fails

ConflictingVersionException - if configuration state was changed

getOpenConfigs

List<ObjectName> getOpenConfigs()

Returns:

list of open configuration transactions.

isHealthy

boolean isHealthy()

Will return true unless there was a transaction that succeeded during validation but failed in second phase of commit. In this case the server is unstable and its state is undefined.

getAvailableModuleNames

Set<String> getAvailableModuleNames()

Returns:

module factory names available in the system