org.opendaylight.controller.config.api

Interface ServiceReferenceReadableRegistry

All Known Subinterfaces:

CloseableServiceReferenceReadableRegistry, ConfigRegistry, ConfigRegistryClient, ConfigRegistryImplMXBean, ConfigRegistryMXBean, ConfigTransactionClient, ConfigTransactionController, ConfigTransactionControllerImplMXBean, ConfigTransactionControllerMXBean, SearchableServiceReferenceWritableRegistry, ServiceReferenceWritableRegistry

All Known Implementing Classes:

ConfigRegistryImpl, ConfigRegistryJMXClient, ConfigTransactionControllerImpl, ConfigTransactionJMXClient, JMXNotifierConfigRegistry, ServiceReferenceRegistryImpl

public interface ServiceReferenceReadableRegistry

Method Summary

Modifier and Type	Method and Description
void	checkServiceReferenceExists(ObjectName objectName)
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.
ObjectName	lookupConfigBeanByServiceInterfaceName(String serviceInterfaceQName, String refName) Lookup object name by fully qualified service interface name and service reference name.
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.

Method Detail

lookupConfigBeanByServiceInterfaceName

ObjectName lookupConfigBeanByServiceInterfaceName(String serviceInterfaceQName,
                                                  String refName)

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

Parameters:

serviceInterfaceQName - service interface name

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

Throws:

IllegalArgumentException - if module not found

getServiceMapping

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

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

lookupServiceReferencesByServiceInterfaceName

Map<String,ObjectName> lookupServiceReferencesByServiceInterfaceName(String serviceInterfaceQName)

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

Parameters:

serviceInterfaceQName - service interface name

Throws:

IllegalArgumentException - if there is a mismatch between serviceInterfaceName and objectName

lookupServiceInterfaceNames

Set<String> lookupServiceInterfaceNames(ObjectName objectName)
                                 throws InstanceNotFoundException

Find all available service interface names of a module.

Parameters:

objectName - module object name

Throws:

InstanceNotFoundException - if search did not find exactly one instance

getServiceInterfaceName

String getServiceInterfaceName(String namespace,
                               String localName)

Get the name of the service interface.

Parameters:

namespace - service interface namespace

localName - service interface local name

Returns:

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

Throws:

IllegalArgumentException - if namespace or localName is not found

getServiceReference

ObjectName getServiceReference(String serviceInterfaceQName,
                               String refName)
                        throws InstanceNotFoundException

Get the reference to that service.

Returns:

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

Throws:

InstanceNotFoundException

checkServiceReferenceExists

void checkServiceReferenceExists(ObjectName objectName)
                          throws InstanceNotFoundException

Throws:

InstanceNotFoundException