org.onosproject.incubator.net.virtual.provider

Interface VirtualProviderRegistryService

public interface VirtualProviderRegistryService

Registry for tracking information providers with the core.

Method Summary

Modifier and Type	Method and Description
VirtualProvider	getProvider(DeviceId deviceId) Returns the virtual provider for the specified device ID based on URI scheme.
VirtualProvider	getProvider(ProviderId providerId) Returns the virtual provider registered with the specified provider ID or null if none is found for the given provider family and default fall-back is not supported.
VirtualProvider	getProvider(java.lang.String scheme) Returns the virtual provider registered with the specified scheme.
java.util.Set<ProviderId>	getProviders() Returns a set of currently registered virtual provider identities.
java.util.Set<ProviderId>	getProvidersByService(VirtualProviderService virtualProviderService) Returns a set of currently registered virtual provider identities corresponding to the requested providerService.
VirtualProviderService	getProviderService(NetworkId networkId, java.lang.Class<? extends VirtualProvider> providerClass) Returns a virtual provider service corresponding to the virtual network and provider class type.
void	registerProvider(VirtualProvider virtualProvider) Registers the supplied virtual provider.
void	registerProviderService(NetworkId networkId, VirtualProviderService virtualProviderService) Registers the supplied virtual provider.
void	unregisterProvider(VirtualProvider virtualProvider) Unregisters the supplied virtual provider.
void	unregisterProviderService(NetworkId networkId, VirtualProviderService virtualProviderService) Unregisters the supplied virtual provider service.

Method Detail

registerProvider

void registerProvider(VirtualProvider virtualProvider)

Registers the supplied virtual provider.

Parameters:

virtualProvider - a virtual provider to be registered

Throws:

java.lang.IllegalArgumentException - if the provider is registered already

unregisterProvider

void unregisterProvider(VirtualProvider virtualProvider)

Unregisters the supplied virtual provider. As a result the previously issued virtual provider service will be invalidated and any subsequent invocations of its methods may throw IllegalStateException.

Unregistering a virtual provider that has not been previously registered results in a no-op.

Parameters:

virtualProvider - a virtual provider to be unregistered

registerProviderService

void registerProviderService(NetworkId networkId,
                             VirtualProviderService virtualProviderService)

Registers the supplied virtual provider.

Parameters:

networkId - a virtual network identifier

virtualProviderService - a virtual provider service to be registered

unregisterProviderService

void unregisterProviderService(NetworkId networkId,
                               VirtualProviderService virtualProviderService)

Unregisters the supplied virtual provider service.

Parameters:

networkId - a virtual network identifier

virtualProviderService - a virtual provider service to be unregistered

getProviders

java.util.Set<ProviderId> getProviders()

Returns a set of currently registered virtual provider identities.

Returns:

set of virtual provider identifiers

getProvidersByService

java.util.Set<ProviderId> getProvidersByService(VirtualProviderService virtualProviderService)

Returns a set of currently registered virtual provider identities corresponding to the requested providerService.

Parameters:

virtualProviderService - a virtual provider service

Returns:

set of virtual provider identifiers

getProvider

VirtualProvider getProvider(ProviderId providerId)

Returns the virtual provider registered with the specified provider ID or null if none is found for the given provider family and default fall-back is not supported.

Parameters:

providerId - provider identifier

Returns:

provider

getProvider

VirtualProvider getProvider(DeviceId deviceId)

Returns the virtual provider for the specified device ID based on URI scheme.

Parameters:

deviceId - virtual device identifier

Returns:

provider bound to the URI scheme

getProvider

VirtualProvider getProvider(java.lang.String scheme)

Returns the virtual provider registered with the specified scheme.

Parameters:

scheme - provider scheme

Returns:

provider

getProviderService

VirtualProviderService getProviderService(NetworkId networkId,
                                          java.lang.Class<? extends VirtualProvider> providerClass)

Returns a virtual provider service corresponding to the virtual network and provider class type.

Parameters:

networkId - a virtual network identifier

providerClass - a type of virtual provider

Returns:

a virtual provider service