org.opendaylight.controller.config.util

Class ConfigTransactionJMXClient

java.lang.Object

org.opendaylight.controller.config.util.ConfigTransactionJMXClient

All Implemented Interfaces:

ConfigTransactionController, ConfigTransactionControllerMXBean, LookupRegistry, ServiceReferenceReadableRegistry, ServiceReferenceWritableRegistry, BeanReader, ConfigTransactionClient

public class ConfigTransactionJMXClient
extends Object
implements ConfigTransactionClient

Constructor Summary

Constructors

Constructor and Description
ConfigTransactionJMXClient(ConfigRegistryMXBean configRegistryMXBeanProxy, ObjectName configTransactionControllerON, MBeanServer configMBeanServer)

Method Summary

Modifier and Type	Method and Description
void	abortConfig() Destroy current transaction.
void	assertVersion(int expectedParentVersion, int expectedCurrentVersion)
void	checkConfigBeanExists(ObjectName objectName) Check that object name corresponds with existing module.
void	checkServiceReferenceExists(ObjectName objectName)
CommitStatus	commit()
ObjectName	createModule(String moduleName, String instanceName) Create new configuration bean.
void	destroyConfigBean(String moduleName, String instanceName) Deprecated.
void	destroyModule(ObjectName objectName) Destroy existing module.
void	destroyModule(String moduleName, String instanceName)
Attribute	getAttribute(ObjectName on, String attrName)
Object	getAttributeCurrentValue(ObjectName on, String attrName)
Set<String>	getAvailableModuleFactoryQNames() Get the qNames of all ModuleFactory instances in the system.
Set<String>	getAvailableModuleNames() Get the names of all available modules.
ObjectName	getObjectName()
long	getParentVersion()
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.
String	getTransactionName() Get the name of the transaction.
long	getVersion()
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.
<T> T	newMBeanProxy(ObjectName on, Class<T> clazz) Deprecated.
<T> T	newMXBeanProxy(ObjectName on, Class<T> clazz)
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.
void	setAttribute(ObjectName on, String attrName, Attribute attribute)
void	validateBean(ObjectName configBeanON)
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, toString, wait, wait, wait

Constructor Detail

ConfigTransactionJMXClient

public ConfigTransactionJMXClient(ConfigRegistryMXBean configRegistryMXBeanProxy,
                                  ObjectName configTransactionControllerON,
                                  MBeanServer configMBeanServer)

Method Detail

newMXBeanProxy

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

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.

commit

public CommitStatus commit()
                    throws ConflictingVersionException,
                           ValidationException

Specified by:

commit in interface ConfigTransactionClient

Throws:

ConflictingVersionException

ValidationException

assertVersion

public void assertVersion(int expectedParentVersion,
                          int expectedCurrentVersion)

Specified by:

assertVersion in interface ConfigTransactionClient

createModule

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

Description copied from interface: ConfigTransactionController

Create new configuration bean.

Specified by:

createModule in interface ConfigTransactionController

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

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

destroyConfigBean

@Deprecated
public void destroyConfigBean(String moduleName,
                                          String instanceName)
                                   throws InstanceNotFoundException

Deprecated.

Specified by:

destroyConfigBean in interface ConfigTransactionClient

Throws:

InstanceNotFoundException

destroyModule

public void destroyModule(String moduleName,
                          String instanceName)
                   throws InstanceNotFoundException

Specified by:

destroyModule in interface ConfigTransactionClient

Throws:

InstanceNotFoundException

abortConfig

public void abortConfig()

Description copied from interface: ConfigTransactionController

Destroy current transaction.

Specified by:

abortConfig in interface ConfigTransactionController

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

getParentVersion

public long getParentVersion()

Specified by:

getParentVersion in interface ConfigTransactionClient

getVersion

public long getVersion()

Specified by:

getVersion in interface ConfigTransactionClient

getTransactionName

public String getTransactionName()

Description copied from interface: ConfigTransactionController

Get the name of the transaction.

Specified by:

getTransactionName in interface ConfigTransactionController

Returns:

transactionName

getAvailableModuleNames

public Set<String> getAvailableModuleNames()

Description copied from interface: ConfigTransactionController

Get the names of all available modules.

Specified by:

getAvailableModuleNames in interface ConfigTransactionController

Returns:

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

getObjectName

public ObjectName getObjectName()

Specified by:

getObjectName in interface ConfigTransactionClient

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

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

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

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

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

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.

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

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

getAttribute

public Attribute getAttribute(ObjectName on,
                              String attrName)

Specified by:

getAttribute in interface ConfigTransactionClient

getAttributeCurrentValue

public Object getAttributeCurrentValue(ObjectName on,
                                       String attrName)

Specified by:

getAttributeCurrentValue in interface BeanReader

validateBean

public void validateBean(ObjectName configBeanON)
                  throws ValidationException

Specified by:

validateBean in interface ConfigTransactionClient

Throws:

ValidationException

setAttribute

public void setAttribute(ObjectName on,
                         String attrName,
                         Attribute attribute)

Specified by:

setAttribute in interface ConfigTransactionClient

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

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 moduleName,
                                          String instanceName)

Description copied from interface: LookupRegistry

Find all runtime of specified module.

Specified by:

lookupRuntimeBeans in interface LookupRegistry

Parameters:

moduleName - of bean

instanceName - of bean

Returns:

objectNames