org.opendaylight.controller.config.manager.impl

Class ServiceReferenceRegistryImpl

java.lang.Object

org.opendaylight.controller.config.manager.impl.ServiceReferenceRegistryImpl

All Implemented Interfaces:

AutoCloseable, ServiceReferenceReadableRegistry, ServiceReferenceWritableRegistry, CloseableServiceReferenceReadableRegistry, SearchableServiceReferenceWritableRegistry

public final class ServiceReferenceRegistryImpl
extends Object
implements CloseableServiceReferenceReadableRegistry, SearchableServiceReferenceWritableRegistry

Method Summary

Modifier and Type	Method and Description
void	checkServiceReferenceExists(ObjectName objectName)
void	close()
static CloseableServiceReferenceReadableRegistry	createInitialSRLookupRegistry() Static constructor for config registry.
static CloseableServiceReferenceReadableRegistry	createSRReadableRegistry(ServiceReferenceWritableRegistry oldWritableRegistry, LookupRegistry lookupRegistry, BaseJMXRegistrator baseJMXRegistrator) Copy back state to config registry after commit.
static SearchableServiceReferenceWritableRegistry	createSRWritableRegistry(ServiceReferenceReadableRegistry oldReadableRegistry, org.opendaylight.controller.config.manager.impl.ConfigTransactionLookupRegistry txLookupRegistry, Map<String,Map.Entry<ModuleFactory,org.osgi.framework.BundleContext>> currentlyRegisteredFactories)
Map<ServiceInterfaceAnnotation,String>	findServiceInterfaces(ModuleIdentifier moduleIdentifier) Return mapping between service ref names and service interface annotation for given module.
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.
void	removeAllServiceReferences() Remove all service references.
void	removeServiceReference(String serviceInterfaceName, String refName) Remove service reference.
boolean	removeServiceReferences(ObjectName moduleObjectName) Remove all service references attached to given module.
ObjectName	saveServiceReference(String serviceInterfaceName, String refName, ObjectName moduleON) Create or update reference name to objectName.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

createInitialSRLookupRegistry

public static CloseableServiceReferenceReadableRegistry createInitialSRLookupRegistry()

Static constructor for config registry. Since only transaction can write to this registry, it will return blank state.

Returns:

service reference registry

createSRWritableRegistry

public static SearchableServiceReferenceWritableRegistry createSRWritableRegistry(ServiceReferenceReadableRegistry oldReadableRegistry,
                                                                                  org.opendaylight.controller.config.manager.impl.ConfigTransactionLookupRegistry txLookupRegistry,
                                                                                  Map<String,Map.Entry<ModuleFactory,org.osgi.framework.BundleContext>> currentlyRegisteredFactories)

createSRReadableRegistry

public static CloseableServiceReferenceReadableRegistry createSRReadableRegistry(ServiceReferenceWritableRegistry oldWritableRegistry,
                                                                                 LookupRegistry lookupRegistry,
                                                                                 BaseJMXRegistrator baseJMXRegistrator)

Copy back state to config registry after commit.

Parameters:

oldWritableRegistry - old registry

lookupRegistry - lookup registry

baseJMXRegistrator - JMX registrator

Returns:

service reference

findServiceInterfaces

public Map<ServiceInterfaceAnnotation,String> findServiceInterfaces(ModuleIdentifier moduleIdentifier)

Description copied from interface: SearchableServiceReferenceWritableRegistry

Return mapping between service ref names and service interface annotation for given module.

Specified by:

findServiceInterfaces in interface SearchableServiceReferenceWritableRegistry

Parameters:

moduleIdentifier - module id

Returns:

map

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.

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

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)

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

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

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

removeServiceReferences

public boolean removeServiceReferences(ObjectName moduleObjectName)
                                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

toString

public String toString()

Overrides:

toString in class Object

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface CloseableServiceReferenceReadableRegistry