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 | |
| 3 | /** |
| 4 | * Broker used for registering/unregistering information providers with the core. |
| 5 | * |
tom | 64b7aac | 2014-08-26 00:18:21 -0700 | [diff] [blame] | 6 | * @param <P> type of the information provider |
tom | 0eb04ca | 2014-08-25 14:34:51 -0700 | [diff] [blame] | 7 | * @param <S> type of the provider service |
| 8 | */ |
tom | 64b7aac | 2014-08-26 00:18:21 -0700 | [diff] [blame] | 9 | public interface ProviderBroker<P extends Provider, S extends ProviderService<P>> { |
tom | 0eb04ca | 2014-08-25 14:34:51 -0700 | [diff] [blame] | 10 | |
| 11 | /** |
| 12 | * Registers the supplied provider with the core. |
| 13 | * |
| 14 | * @param provider provider to be registered |
| 15 | * @return provider service for injecting information into core |
tom | b1260e4 | 2014-08-26 18:39:57 -0700 | [diff] [blame^] | 16 | * @throws java.lang.IllegalArgumentException if the provider is registered already |
tom | 0eb04ca | 2014-08-25 14:34:51 -0700 | [diff] [blame] | 17 | */ |
tom | 64b7aac | 2014-08-26 00:18:21 -0700 | [diff] [blame] | 18 | S register(P provider); |
tom | 0eb04ca | 2014-08-25 14:34:51 -0700 | [diff] [blame] | 19 | |
| 20 | /** |
| 21 | * Unregisters the supplied provider. As a result the previously issued |
tom | 64b7aac | 2014-08-26 00:18:21 -0700 | [diff] [blame] | 22 | * provider service will be invalidated and any subsequent invocations |
| 23 | * of its methods may throw {@link java.lang.IllegalStateException}. |
tom | b1260e4 | 2014-08-26 18:39:57 -0700 | [diff] [blame^] | 24 | * <p/> |
| 25 | * Unregistering a provider that has not been previously registered results |
| 26 | * in a no-op. |
tom | 0eb04ca | 2014-08-25 14:34:51 -0700 | [diff] [blame] | 27 | * |
| 28 | * @param provider provider to be unregistered |
| 29 | */ |
tom | 64b7aac | 2014-08-26 00:18:21 -0700 | [diff] [blame] | 30 | void unregister(P provider); |
tom | 0eb04ca | 2014-08-25 14:34:51 -0700 | [diff] [blame] | 31 | |
| 32 | } |