Deprecating unused get{Provider,Consumer} Functionality

[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 3127df521f72547a0567f00f60e07101c247f5dc..a5ab8ac911b20fc703b96185af66e9bb60c170d7 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
@@ -12,47 +12,48 @@ 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 facilitates the SAL and SAL
  * services to access infrastructure services or providers' functionality.
- * 
- * 
+ *
+ *
  */
 public interface Consumer {
 
     /**
      * Callback signaling initialization of the consumer session to the SAL.
-     * 
+     *
      * The consumer MUST use the session for all communication with SAL or
      * retrieving SAL infrastructure services.
-     * 
+     *
      * This method is invoked by {@link Broker#registerConsumer(Consumer)}
-     * 
+     *
      * @param session
      *            Unique session between consumer and SAL.
      */
     public 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 - no longer used or needed
+     * *
+     * Suggested implementation until removed:
+     * @code {
+     * public Collection<ConsumerFunctionality> getConsumerFunctionality() {
+     *    return Collections.emptySet();
+     * }
+     * }
      */
+    @Deprecated
     public Collection<ConsumerFunctionality> getConsumerFunctionality();
 
     /**
-     * The marker interface for the interfaces describing the consumer
-     * functionality contracts.
-     * 
-     * 
+     * @deprecated - no longer used or needed
      */
+    @Deprecated
     public interface ConsumerFunctionality {
 
     }