tom | c1a38d3 | 2014-08-25 23:01:32 -0700 | [diff] [blame] | 1 | package org.onlab.onos.net.provider; |
tom | 0eb04ca | 2014-08-25 14:34:51 -0700 | [diff] [blame] | 2 | |
tom | 132b58a | 2014-08-28 16:11:28 -0700 | [diff] [blame] | 3 | import java.util.Set; |
| 4 | |
tom | 0eb04ca | 2014-08-25 14:34:51 -0700 | [diff] [blame] | 5 | /** |
tom | 96dfcab | 2014-08-28 09:26:03 -0700 | [diff] [blame] | 6 | * Registry for tracking information providers with the core. |
tom | 0eb04ca | 2014-08-25 14:34:51 -0700 | [diff] [blame] | 7 | * |
tom | 64b7aac | 2014-08-26 00:18:21 -0700 | [diff] [blame] | 8 | * @param <P> type of the information provider |
tom | 0eb04ca | 2014-08-25 14:34:51 -0700 | [diff] [blame] | 9 | * @param <S> type of the provider service |
| 10 | */ |
tom | 96dfcab | 2014-08-28 09:26:03 -0700 | [diff] [blame] | 11 | public interface ProviderRegistry<P extends Provider, S extends ProviderService<P>> { |
tom | 0eb04ca | 2014-08-25 14:34:51 -0700 | [diff] [blame] | 12 | |
| 13 | /** |
| 14 | * Registers the supplied provider with the core. |
| 15 | * |
| 16 | * @param provider provider to be registered |
| 17 | * @return provider service for injecting information into core |
tom | b1260e4 | 2014-08-26 18:39:57 -0700 | [diff] [blame] | 18 | * @throws java.lang.IllegalArgumentException if the provider is registered already |
tom | 0eb04ca | 2014-08-25 14:34:51 -0700 | [diff] [blame] | 19 | */ |
tom | 64b7aac | 2014-08-26 00:18:21 -0700 | [diff] [blame] | 20 | S register(P provider); |
tom | 0eb04ca | 2014-08-25 14:34:51 -0700 | [diff] [blame] | 21 | |
| 22 | /** |
| 23 | * Unregisters the supplied provider. As a result the previously issued |
tom | 64b7aac | 2014-08-26 00:18:21 -0700 | [diff] [blame] | 24 | * provider service will be invalidated and any subsequent invocations |
| 25 | * of its methods may throw {@link java.lang.IllegalStateException}. |
tom | b1260e4 | 2014-08-26 18:39:57 -0700 | [diff] [blame] | 26 | * <p/> |
| 27 | * Unregistering a provider that has not been previously registered results |
| 28 | * in a no-op. |
tom | 0eb04ca | 2014-08-25 14:34:51 -0700 | [diff] [blame] | 29 | * |
| 30 | * @param provider provider to be unregistered |
| 31 | */ |
tom | 64b7aac | 2014-08-26 00:18:21 -0700 | [diff] [blame] | 32 | void unregister(P provider); |
tom | 0eb04ca | 2014-08-25 14:34:51 -0700 | [diff] [blame] | 33 | |
tom | 132b58a | 2014-08-28 16:11:28 -0700 | [diff] [blame] | 34 | /** |
| 35 | * Returns a set of currently registered provider identities. |
| 36 | * |
| 37 | * @return set of provider identifiers |
| 38 | */ |
| 39 | Set<ProviderId> getProviders(); |
| 40 | |
tom | 0eb04ca | 2014-08-25 14:34:51 -0700 | [diff] [blame] | 41 | } |