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;h=b9ac87ae1918bed202469899907057a0f11e68c2;hp=3127df521f72547a0567f00f60e07101c247f5dc;hb=7c1be1d20084ee053747d517d597f1a07df694bd;hpb=b772e3dc5c2043ab19994ece7a6738a4320d94f2 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 3127df521f..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,52 +8,54 @@ 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 * Unique session between consumer and SAL. */ - public void onSessionInitiated(ConsumerSession session); + 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. + * + * @deprecated - no longer used or needed. Suggested implementation until removed: + * {@code + * public Collection getConsumerFunctionality() { + * return Collections.emptySet(); + * } + * } */ - public Collection getConsumerFunctionality(); + @Deprecated + Collection getConsumerFunctionality(); /** - * The marker interface for the interfaces describing the consumer - * functionality contracts. - * - * + * Deprecated. + * + * @deprecated - no longer used or needed */ - public interface ConsumerFunctionality { + @Deprecated + interface ConsumerFunctionality { } }