org.opendaylight.controller.config.api

Interface ServiceReferenceWritableRegistry

All Superinterfaces:

ServiceReferenceReadableRegistry

All Known Subinterfaces:

ConfigTransactionClient, ConfigTransactionController, ConfigTransactionControllerImplMXBean, ConfigTransactionControllerMXBean, SearchableServiceReferenceWritableRegistry

All Known Implementing Classes:

ConfigTransactionControllerImpl, ConfigTransactionJMXClient, ServiceReferenceRegistryImpl

public interface ServiceReferenceWritableRegistry
extends ServiceReferenceReadableRegistry

Method Summary

Modifier and Type	Method and Description
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.

Methods inherited from interface org.opendaylight.controller.config.api.ServiceReferenceReadableRegistry

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

Method Detail

saveServiceReference

ObjectName saveServiceReference(String serviceInterfaceName,
                                String refName,
                                ObjectName moduleON)
                         throws InstanceNotFoundException

Create or update reference name to objectName. Reference name is unique per service interface name.

Returns:

created or updated object name containing service name and reference name

Throws:

IllegalArgumentException - if there is a mismatch between serviceInterfaceName and objectName

InstanceNotFoundException - if search did not find exactly one instance

removeServiceReference

void removeServiceReference(String serviceInterfaceName,
                            String refName)
                     throws InstanceNotFoundException

Remove service reference.

Throws:

IllegalArgumentException - if service interface name is not advertised by any module

InstanceNotFoundException

removeAllServiceReferences

void removeAllServiceReferences()

Remove all service references.

removeServiceReferences

boolean removeServiceReferences(ObjectName objectName)
                         throws InstanceNotFoundException

Remove all service references attached to given module.

Returns:

true iif at least one reference was removed

Throws:

InstanceNotFoundException