Deprecate Broker and related APIs
[controller.git] / opendaylight / md-sal / sal-dom-api / src / main / java / org / opendaylight / controller / sal / core / api / Broker.java
index 500dce3cfab2badfff3b1db381448a3ca460f61b..ce64e8e7c07a4a9f47fe57edf87c64f332cfec73 100644 (file)
@@ -12,26 +12,29 @@ import org.osgi.framework.BundleContext;
 /**
  * Core component of the SAL layer responsible for wiring the SAL consumers.
  *
+ * <p>
  * The responsibility of the broker is to maintain registration of SAL
  * functionality {@link Consumer}s and {@link Provider}s, store provider and
  * consumer specific context and functionality registration via
  * {@link ConsumerSession} and provide access to infrastructure services, which
  * removes direct dependencies between providers and consumers.
  *
- *
+ * <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 ConsumerSession}
  * and {@link ProviderSession}
  *
- *
- *
+ * @deprecated Use blueprint instead for code wiring.
  */
+@Deprecated
 public interface Broker {
 
     /**
@@ -77,6 +80,7 @@ public interface Broker {
      * from consumer, using the {@link Provider#getProviderFunctionality()}, and
      * register that functionality into system and concrete infrastructure
      * services.
+     *
      * <p>
      * The consumer is <b>required to use</b> returned session for all
      * communication with broker or one of the broker services. The session is
@@ -116,13 +120,12 @@ public interface Broker {
      *
      *
      */
-    public interface ConsumerSession {
+    interface ConsumerSession {
 
         boolean isClosed();
 
         /**
-         * Returns a session specific instance (implementation) of requested
-         * service
+         * Returns a session specific instance (implementation) of requested service.
          *
          * @param service
          *            Broker service
@@ -156,7 +159,7 @@ public interface Broker {
      * functionality provided by other {@link Provider}s.
      *
      */
-    public interface ProviderSession extends ConsumerSession {
+    interface ProviderSession extends ConsumerSession {
         /**
          * Closes a session between provider and SAL.
          *