tom | 64b7aac | 2014-08-26 00:18:21 -0700 | [diff] [blame] | 1 | package org.onlab.onos.net.provider; |
| 2 | |
tom | 132b58a | 2014-08-28 16:11:28 -0700 | [diff] [blame] | 3 | import com.google.common.collect.ImmutableSet; |
tom | 7e02cda | 2014-09-18 12:05:46 -0700 | [diff] [blame] | 4 | import org.onlab.onos.net.DeviceId; |
tom | 132b58a | 2014-08-28 16:11:28 -0700 | [diff] [blame] | 5 | |
tom | 64b7aac | 2014-08-26 00:18:21 -0700 | [diff] [blame] | 6 | import java.util.HashMap; |
| 7 | import java.util.Map; |
tom | 132b58a | 2014-08-28 16:11:28 -0700 | [diff] [blame] | 8 | import java.util.Set; |
tom | 64b7aac | 2014-08-26 00:18:21 -0700 | [diff] [blame] | 9 | |
tom | 64b7aac | 2014-08-26 00:18:21 -0700 | [diff] [blame] | 10 | import static com.google.common.base.Preconditions.checkNotNull; |
tom | 132b58a | 2014-08-28 16:11:28 -0700 | [diff] [blame] | 11 | import static com.google.common.base.Preconditions.checkState; |
tom | 64b7aac | 2014-08-26 00:18:21 -0700 | [diff] [blame] | 12 | |
| 13 | /** |
tom | 96dfcab | 2014-08-28 09:26:03 -0700 | [diff] [blame] | 14 | * Base implementation of provider registry. |
tom | 64b7aac | 2014-08-26 00:18:21 -0700 | [diff] [blame] | 15 | * |
| 16 | * @param <P> type of the information provider |
| 17 | * @param <S> type of the provider service |
| 18 | */ |
tom | 96dfcab | 2014-08-28 09:26:03 -0700 | [diff] [blame] | 19 | public abstract class AbstractProviderRegistry<P extends Provider, S extends ProviderService<P>> |
| 20 | implements ProviderRegistry<P, S> { |
tom | 64b7aac | 2014-08-26 00:18:21 -0700 | [diff] [blame] | 21 | |
tom | e5ec3fd | 2014-09-04 15:18:06 -0700 | [diff] [blame] | 22 | private final Map<ProviderId, P> providers = new HashMap<>(); |
tom | 64b7aac | 2014-08-26 00:18:21 -0700 | [diff] [blame] | 23 | private final Map<ProviderId, S> services = new HashMap<>(); |
tom | 7e02cda | 2014-09-18 12:05:46 -0700 | [diff] [blame] | 24 | private final Map<String, P> providersByScheme = new HashMap<>(); |
tom | 64b7aac | 2014-08-26 00:18:21 -0700 | [diff] [blame] | 25 | |
| 26 | /** |
| 27 | * Creates a new provider service bound to the specified provider. |
| 28 | * |
| 29 | * @param provider provider |
| 30 | * @return provider service |
| 31 | */ |
| 32 | protected abstract S createProviderService(P provider); |
| 33 | |
| 34 | @Override |
| 35 | public synchronized S register(P provider) { |
| 36 | checkNotNull(provider, "Provider cannot be null"); |
tom | 132b58a | 2014-08-28 16:11:28 -0700 | [diff] [blame] | 37 | checkState(!services.containsKey(provider.id()), "Provider %s already registered", provider.id()); |
tom | a536886 | 2014-10-01 12:35:48 -0700 | [diff] [blame] | 38 | |
| 39 | // If the provider is a primary one, check for a conflict. |
| 40 | ProviderId pid = provider.id(); |
| 41 | checkState(pid.isAncillary() || !providersByScheme.containsKey(pid.scheme()), |
| 42 | "A primary provider with id %s is already registered", |
| 43 | providersByScheme.get(pid.scheme())); |
| 44 | |
tom | 64b7aac | 2014-08-26 00:18:21 -0700 | [diff] [blame] | 45 | S service = createProviderService(provider); |
| 46 | services.put(provider.id(), service); |
tom | e5ec3fd | 2014-09-04 15:18:06 -0700 | [diff] [blame] | 47 | providers.put(provider.id(), provider); |
tom | a536886 | 2014-10-01 12:35:48 -0700 | [diff] [blame] | 48 | |
| 49 | // Register the provider by URI scheme only if it is not ancillary. |
| 50 | if (!pid.isAncillary()) { |
| 51 | providersByScheme.put(pid.scheme(), provider); |
| 52 | } |
| 53 | |
tom | 64b7aac | 2014-08-26 00:18:21 -0700 | [diff] [blame] | 54 | return service; |
| 55 | } |
| 56 | |
| 57 | @Override |
| 58 | public synchronized void unregister(P provider) { |
| 59 | checkNotNull(provider, "Provider cannot be null"); |
tom | 132b58a | 2014-08-28 16:11:28 -0700 | [diff] [blame] | 60 | S service = services.get(provider.id()); |
tom | b1260e4 | 2014-08-26 18:39:57 -0700 | [diff] [blame] | 61 | if (service != null && service instanceof AbstractProviderService) { |
tom | 64b7aac | 2014-08-26 00:18:21 -0700 | [diff] [blame] | 62 | ((AbstractProviderService) service).invalidate(); |
tom | 132b58a | 2014-08-28 16:11:28 -0700 | [diff] [blame] | 63 | services.remove(provider.id()); |
tom | e5ec3fd | 2014-09-04 15:18:06 -0700 | [diff] [blame] | 64 | providers.remove(provider.id()); |
alshabib | 23022f7 | 2014-10-17 14:50:00 -0700 | [diff] [blame] | 65 | if (!provider.id().isAncillary()) { |
| 66 | providersByScheme.remove(provider.id().scheme()); |
| 67 | } |
tom | 64b7aac | 2014-08-26 00:18:21 -0700 | [diff] [blame] | 68 | } |
tom | 64b7aac | 2014-08-26 00:18:21 -0700 | [diff] [blame] | 69 | } |
tom | 132b58a | 2014-08-28 16:11:28 -0700 | [diff] [blame] | 70 | |
| 71 | @Override |
| 72 | public synchronized Set<ProviderId> getProviders() { |
| 73 | return ImmutableSet.copyOf(services.keySet()); |
| 74 | } |
| 75 | |
tom | e5ec3fd | 2014-09-04 15:18:06 -0700 | [diff] [blame] | 76 | /** |
| 77 | * Returns the provider registered with the specified provider ID. |
| 78 | * |
| 79 | * @param providerId provider identifier |
| 80 | * @return provider |
| 81 | */ |
| 82 | protected synchronized P getProvider(ProviderId providerId) { |
| 83 | return providers.get(providerId); |
| 84 | } |
| 85 | |
tom | 7e02cda | 2014-09-18 12:05:46 -0700 | [diff] [blame] | 86 | /** |
| 87 | * Returns the provider for the specified device ID based on URI scheme. |
| 88 | * |
| 89 | * @param deviceId device identifier |
| 90 | * @return provider bound to the URI scheme |
| 91 | */ |
| 92 | protected synchronized P getProvider(DeviceId deviceId) { |
| 93 | return providersByScheme.get(deviceId.uri().getScheme()); |
| 94 | } |
| 95 | |
tom | 64b7aac | 2014-08-26 00:18:21 -0700 | [diff] [blame] | 96 | } |