org.opendaylight.controller.config.util

Class ConfigRegistryJMXClient

java.lang.Object

org.opendaylight.controller.config.util.ConfigRegistryJMXClient

All Implemented Interfaces:

ConfigRegistry, ConfigRegistryMXBean, LookupRegistry, ServiceReferenceReadableRegistry, BeanReader, ConfigRegistryClient

public class ConfigRegistryJMXClient
extends Object
implements ConfigRegistryClient

Field Summary

Fields inherited from interface org.opendaylight.controller.config.api.ConfigRegistry

OBJECT_NAME, OBJECT_NAME_NO_NOTIFICATIONS

Constructor Summary

Constructors

Constructor and Description
ConfigRegistryJMXClient(MBeanServer configMBeanServer)

Method Summary

Modifier and Type	Method and Description
ObjectName	beginConfig() Opens new configuration transaction.
void	checkConfigBeanExists(ObjectName objectName) Check that object name corresponds with existing module.
void	checkServiceReferenceExists(ObjectName objectName)
CommitStatus	commitConfig(ObjectName transactionControllerON) Verifies and commits transaction.
ConfigTransactionJMXClient	createTransaction()
static ConfigRegistryJMXClient	createWithoutNotifications(MBeanServer configMBeanServer)
Object	getAttributeCurrentValue(ObjectName on, String attributeName)
Set<String>	getAvailableModuleFactoryQNames() Get the qNames of all ModuleFactory instances in the system.
Set<String>	getAvailableModuleNames() Get the module names available in the system.
ConfigTransactionJMXClient	getConfigTransactionClient(ObjectName objectName)
ConfigTransactionJMXClient	getConfigTransactionClient(String transactionName)
List<ObjectName>	getOpenConfigs() List of open configuration transactions.
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.
long	getVersion()
Object	invokeMethod(ObjectName on, String name, Object[] params, String[] signature)
boolean	isHealthy() Will return true unless there was a transaction that succeeded during validation but failed in second phase of commit.
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 ifcName, 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.
<T> T	newMBeanProxy(ObjectName on, Class<T> clazz) Deprecated.
<T> T	newMXBeanProxy(ObjectName on, Class<T> clazz)

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigRegistryJMXClient

public ConfigRegistryJMXClient(MBeanServer configMBeanServer)

Method Detail

createWithoutNotifications

public static ConfigRegistryJMXClient createWithoutNotifications(MBeanServer configMBeanServer)

createTransaction

public ConfigTransactionJMXClient createTransaction()

Specified by:

createTransaction in interface ConfigRegistryClient

getConfigTransactionClient

public ConfigTransactionJMXClient getConfigTransactionClient(String transactionName)

Specified by:

getConfigTransactionClient in interface ConfigRegistryClient

getConfigTransactionClient

public ConfigTransactionJMXClient getConfigTransactionClient(ObjectName objectName)

Specified by:

getConfigTransactionClient in interface ConfigRegistryClient

newMBeanProxy

@Deprecated
public <T> T newMBeanProxy(ObjectName on,
                                       Class<T> clazz)

Deprecated.

Usage of this method indicates error as config JMX uses solely MXBeans. Use newMXBeanProxy(javax.management.ObjectName, Class) or JMX.newMBeanProxy(javax.management.MBeanServerConnection, javax.management.ObjectName, Class) This method will be removed soon.

newMXBeanProxy

public <T> T newMXBeanProxy(ObjectName on,
                            Class<T> clazz)

beginConfig

public ObjectName beginConfig()

Description copied from interface: ConfigRegistry

Opens new configuration transaction.

Specified by:

beginConfig in interface ConfigRegistry

Returns:

ObjectName of ConfigTransactionControllerMXBean

commitConfig

public CommitStatus commitConfig(ObjectName transactionControllerON)
                          throws ConflictingVersionException,
                                 ValidationException

Description copied from interface: ConfigRegistry

Verifies and commits transaction.

Specified by:

commitConfig in interface ConfigRegistry

Parameters:

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

Returns:

CommitStatus

Throws:

ConflictingVersionException - if configuration state was changed

ValidationException - if validation fails

getOpenConfigs

public List<ObjectName> getOpenConfigs()

Description copied from interface: ConfigRegistry

List of open configuration transactions.

Specified by:

getOpenConfigs in interface ConfigRegistry

Returns:

list of open configuration transactions.

getVersion

public long getVersion()

Specified by:

getVersion in interface ConfigRegistryClient

getAvailableModuleNames

public Set<String> getAvailableModuleNames()

Description copied from interface: ConfigRegistry

Get the module names available in the system.

Specified by:

getAvailableModuleNames in interface ConfigRegistry

Returns:

module factory names available in the system

isHealthy

public boolean isHealthy()

Description copied from interface: ConfigRegistry

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.

Specified by:

isHealthy in interface ConfigRegistry

lookupConfigBeans

public Set<ObjectName> lookupConfigBeans()

Description copied from interface: LookupRegistry

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)

Description copied from interface: LookupRegistry

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)

Description copied from interface: LookupRegistry

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

Description copied from interface: LookupRegistry

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

lookupRuntimeBeans

public Set<ObjectName> lookupRuntimeBeans()

Description copied from interface: LookupRegistry

Find all runtime beans.

Specified by:

lookupRuntimeBeans in interface LookupRegistry

Returns:

objectNames

lookupRuntimeBeans

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

Description copied from interface: LookupRegistry

Find all runtime of specified module.

Specified by:

lookupRuntimeBeans in interface LookupRegistry

Parameters:

ifcName - of bean

instanceName - of bean

Returns:

objectNames

checkConfigBeanExists

public void checkConfigBeanExists(ObjectName objectName)
                           throws InstanceNotFoundException

Description copied from interface: LookupRegistry

Check that object name corresponds with existing module.

Specified by:

checkConfigBeanExists in interface LookupRegistry

Throws:

InstanceNotFoundException - if search did not find exactly one instance

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.

invokeMethod

public Object invokeMethod(ObjectName on,
                           String name,
                           Object[] params,
                           String[] signature)

Specified by:

invokeMethod in interface ConfigRegistryClient

getAttributeCurrentValue

public Object getAttributeCurrentValue(ObjectName on,
                                       String attributeName)

Specified by:

getAttributeCurrentValue in interface BeanReader

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

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

checkServiceReferenceExists

public void checkServiceReferenceExists(ObjectName objectName)
                                 throws InstanceNotFoundException

Specified by:

checkServiceReferenceExists in interface ServiceReferenceReadableRegistry

Throws:

InstanceNotFoundException