Deprecate Broker and related APIs

[controller.git] / opendaylight / md-sal / sal-dom-api / src / main / java / org / opendaylight / controller / sal / core / api / Consumer.java

diff --git a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/sal/core/api/Consumer.java b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/sal/core/api/Consumer.java
index 0006953542bb698cff7bd06fe4c85133012da047..0e398e557827aac1c2a4a0f2c8253e0b9450258f 100644 (file)
--- a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/sal/core/api/Consumer.java
+++ b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/sal/core/api/Consumer.java
@@ -8,52 +8,57 @@
 package org.opendaylight.controller.sal.core.api;
 
 import java.util.Collection;
-
 import org.opendaylight.controller.sal.core.api.Broker.ConsumerSession;
 
 /**
- * 
  * Defines the component of controller and supplies additional metadata. A
  * component of the controller or application supplies a concrete implementation
  * of this interface.
- * 
- * A user-implemented component (application) which faciliates the SAL and SAL
+ *
+ * <p>
+ * A user-implemented component (application) which facilitates the SAL and SAL
  * services to access infrastructure services or providers' functionality.
- * 
- * 
+ *
+ * @deprecated Use blueprint instead for code wiring.
  */
+@Deprecated
 public interface Consumer {
 
     /**
      * Callback signaling initialization of the consumer session to the SAL.
-     * 
+     *
+     * <p>
      * The consumer MUST use the session for all communication with SAL or
      * retrieving SAL infrastructure services.
-     * 
+     *
+     * <p>
      * This method is invoked by {@link Broker#registerConsumer(Consumer)}
-     * 
+     *
      * @param session
      *            Unique session between consumer and SAL.
      */
-    public void onSessionInitiated(ConsumerSession session);
+    void onSessionInitiated(ConsumerSession session);
 
     /**
-     * Get a set of implementations of consumer functionality to be registered
-     * into system during the consumer registration to the SAL.
-     * 
-     * This method is invoked by {@link Broker#registerConsumer(Consumer)}.
-     * 
-     * @return Set of consumer functionality.
+     * Deprecated.
+     *
+     * @deprecated - no longer used or needed. Suggested implementation until removed:
+     *   {@code
+     *       public Collection<ConsumerFunctionality> getConsumerFunctionality() {
+     *           return Collections.emptySet();
+     *       }
+     *   }
      */
-    public Collection<ConsumerFunctionality> getConsumerFunctionality();
+    @Deprecated
+    Collection<ConsumerFunctionality> getConsumerFunctionality();
 
     /**
-     * The marker interface for the interfaces describing the consumer
-     * functionality contracts.
-     * 
-     * 
+     * Deprecated.
+     *
+     * @deprecated - no longer used or needed
      */
-    public interface ConsumerFunctionality {
+    @Deprecated
+    interface ConsumerFunctionality {
 
     }
 }