X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-dom-api%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fsal%2Fcore%2Fapi%2FConsumer.java;h=a5ab8ac911b20fc703b96185af66e9bb60c170d7;hb=33c9769f6dd0dadd68e460c8f6d76a06b43bf146;hp=0006953542bb698cff7bd06fe4c85133012da047;hpb=2887eded48bd70a9e332e98530f23304ce153bc7;p=controller.git 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 0006953542..a5ab8ac911 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 @@ -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 faciliates the SAL and SAL + * + * 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 getConsumerFunctionality() { + * return Collections.emptySet(); + * } + * } */ + @Deprecated public Collection getConsumerFunctionality(); /** - * The marker interface for the interfaces describing the consumer - * functionality contracts. - * - * + * @deprecated - no longer used or needed */ + @Deprecated public interface ConsumerFunctionality { }