X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-dom-api%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fsal%2Fcore%2Fapi%2FConsumer.java;fp=opendaylight%2Fmd-sal%2Fsal-dom-api%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fsal%2Fcore%2Fapi%2FConsumer.java;h=b9ac87ae1918bed202469899907057a0f11e68c2;hp=b5c39779ab6782566327368d0915a2ec3ca32d6c;hb=7c1be1d20084ee053747d517d597f1a07df694bd;hpb=db26fc0bc09a9e2c1190f03b159c87355d20bf8e 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 b5c39779ab..b9ac87ae19 100644 --- 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,28 +8,27 @@ 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 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 @@ -38,19 +37,21 @@ public interface Consumer { void onSessionInitiated(ConsumerSession session); /** - * @deprecated - no longer used or needed - * * - * Suggested implementation until removed: - * {@code - * public Collection getConsumerFunctionality() { - * return Collections.emptySet(); - * } - * } + * Deprecated. + * + * @deprecated - no longer used or needed. Suggested implementation until removed: + * {@code + * public Collection getConsumerFunctionality() { + * return Collections.emptySet(); + * } + * } */ @Deprecated Collection getConsumerFunctionality(); /** + * Deprecated. + * * @deprecated - no longer used or needed */ @Deprecated