Migrate OSGI compendium reference

[controller.git] / opendaylight / md-sal / sal-binding-api / src / main / java / org / opendaylight / controller / sal / binding / api / BindingAwareBroker.java

diff --git a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/BindingAwareBroker.java b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/BindingAwareBroker.java
index b934800d98f2db8ae4c753c52a3b88e3ae8d6b43..32984ef3345c04aea17add5706013846219b7d1e 100644 (file)
--- a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/BindingAwareBroker.java
+++ b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/BindingAwareBroker.java
@@ -17,17 +17,18 @@ import org.osgi.framework.BundleContext;
 /**
  * Binding-aware core of the SAL layer responsible for wiring the SAL consumers.
  *
+ * <p>
  * The responsibility of the broker is to maintain registration of SAL
  * functionality Consumers and Providers, store provider and
  * consumer specific context and functionality registration via
  * {@link ConsumerContext} and provide access to infrastructure services, which
  * removes direct dependencies between providers and consumers.
  *
+ * <p>
  * The Binding-aware broker is also responsible for translation from Java
  * classes modeling the functionality and data to binding-independent form which
  * is used in SAL Core.
  *
- *
  * <h3>Infrastructure services</h3> Some examples of infrastructure services:
  *
  * <ul>
@@ -35,25 +36,23 @@ import org.osgi.framework.BundleContext;
  * {@link ProviderContext}
  * <li>Notification Service - see {@link NotificationService} and
  * {@link NotificationProviderService}
- * <li>Functionality and Data model
- * <li>Data Store access and modification - see {@link org.opendaylight.controller.sal.binding.api.data.DataBrokerService} and
- * {@link org.opendaylight.controller.sal.binding.api.data.DataProviderService}
  * </ul>
  *
+ * <p>
  * The services are exposed via session.
  *
  * <h3>Session-based access</h3>
  *
+ * <p>
  * The providers and consumers needs to register in order to use the
  * binding-independent SAL layer and to expose functionality via SAL layer.
  *
+ * <p>
  * For more information about session-based access see {@link ConsumerContext}
  * and {@link ProviderContext}
  */
+@Deprecated(forRemoval = true)
 public interface BindingAwareBroker {
-    /*
-     * @deprecated Use registerConsumer(BindingAwareConsumer cons) instead (BundleContext is no longer used)
-     */
     @Deprecated
     ConsumerContext registerConsumer(BindingAwareConsumer consumer, BundleContext ctx);
 
@@ -78,6 +77,7 @@ public interface BindingAwareBroker {
      * @throws IllegalStateException
      *             If the consumer is already registered.
      */
+    @Deprecated
     ConsumerContext registerConsumer(BindingAwareConsumer consumer);
 
     /*
@@ -114,6 +114,7 @@ public interface BindingAwareBroker {
      * @throws IllegalStateException
      *             If the consumer is already registered.
      */
+    @Deprecated
     ProviderContext registerProvider(BindingAwareProvider provider);
 
     /**
@@ -129,11 +130,11 @@ public interface BindingAwareBroker {
      * infrastructure services and other functionality provided by
      * {@link BindingAwareProvider}s.
      */
+    @Deprecated
     interface ConsumerContext extends RpcConsumerRegistry {
 
         /**
-         * Returns a session specific instance (implementation) of requested
-         * binding-aware infrastructural service
+         * Returns a session specific instance (implementation) of requested binding-aware infrastructure service.
          *
          * @param service
          *            Broker service
@@ -158,6 +159,7 @@ public interface BindingAwareBroker {
      * functionality provided by other {@link BindingAwareConsumer}s.
      *
      */
+    @Deprecated
     interface ProviderContext extends ConsumerContext, RpcProviderRegistry {
 
     }
@@ -189,25 +191,17 @@ public interface BindingAwareBroker {
             RoutedRegistration<Class<? extends BaseIdentity>, InstanceIdentifier<?>, T> {
 
         /**
-         * Register particular instance identifier to be processed by this
-         * RpcService
+         * Register particular instance identifier to be processed by this RpcService.
          *
-         * Deprecated in favor of RoutedRegistration#registerPath(Object, Object).
-         *
-         * @param context
-         * @param instance
+         * @deprecated in favor of RoutedRegistration#registerPath(Object, Object).
          */
         @Deprecated
         void registerInstance(Class<? extends BaseIdentity> context, InstanceIdentifier<?> instance);
 
         /**
-         * Unregister particular instance identifier to be processed by this
-         * RpcService
-         *
-         * Deprecated in favor of RoutedRegistration#unregisterPath(Class, InstanceIdentifier).
+         * Unregister particular instance identifier to be processed by this RpcService.
          *
-         * @param context
-         * @param instance
+         * @deprecated in favor of RoutedRegistration#unregisterPath(Class, InstanceIdentifier).
          */
         @Deprecated
         void unregisterInstance(Class<? extends BaseIdentity> context, InstanceIdentifier<?> instance);