Deprecating unused get{Provider,Consumer} Functionality

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

diff --git a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/sal/core/api/Provider.java b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/sal/core/api/Provider.java
index e2df70baeac05a3a1fc113de6205a0ccc504206c..4f32983f84b7e7f5a0408e1b5dfcdf4f5a01b65c 100644 (file)
--- a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/sal/core/api/Provider.java
+++ b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/sal/core/api/Provider.java
@@ -12,57 +12,52 @@ import java.util.Collection;
 import org.opendaylight.controller.sal.core.api.Broker.ProviderSession;
 
 /**
- * 
+ *
  * Defines the component of controller and supplies additional metadata. A
  * component of the controller or application supplies a concrete implementation
  * of this interface.
- * 
+ *
  * <p>
- * A user-implemented component (application) which faciliates the SAL and SAL
+ * A user-implemented component (application) which facilitates the SAL and SAL
  * services to access infrastructure services and to provide functionality to
  * {@link Consumer}s and other providers.
- * 
- * 
+ *
+ *
  */
 public interface Provider {
 
     /**
      * Callback signaling initialization of the provider session to the SAL.
-     * 
+     *
      * <p>
      * The provider <b>MUST use the session</b> 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 provider and SAL.
      */
     public void onSessionInitiated(ProviderSession session);
 
     /**
-     * Gets a set of implementations of provider functionality to be registered
-     * into system during the provider registration to the SAL.
-     * 
-     * <p>
-     * This method is invoked by {@link Broker#registerProvider(Provider)} to
-     * learn the initial provided functionality
-     * 
-     * @return Set of provider's functionality.
+     * @deprecated - No longer used or needed
+     *
+     * Suggested implementation until removed:
+     * @code {
+     * public Collection<ProviderFunctionality> getProviderFunctionality() {
+     *  return Collections.emptySet();
+     * }
+     * }
      */
+    @Deprecated
     public Collection<ProviderFunctionality> getProviderFunctionality();
 
     /**
-     * Functionality provided by the {@link Provider}
-     * 
-     * <p>
-     * Marker interface used to mark the interfaces describing specific
-     * functionality which could be exposed by providers to other components.
-     * 
-
-     * 
+     * @deprecated - no longer used or needed
      */
+    @Deprecated
     public interface ProviderFunctionality {
 
     }