org.opendaylight.controller.sal.core.api

Interface Consumer

All Known Implementing Classes:

AbstractConsumer

public interface Consumer

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.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Consumer.ConsumerFunctionality Deprecated. - no longer used or needed

Method Summary

Modifier and Type	Method and Description
Collection<Consumer.ConsumerFunctionality>	getConsumerFunctionality() Deprecated. - no longer used or needed * Suggested implementation until removed: public Collection<ConsumerFunctionality> getConsumerFunctionality() { return Collections.emptySet(); }
void	onSessionInitiated(Broker.ConsumerSession session) Callback signaling initialization of the consumer session to the SAL.

Method Detail

onSessionInitiated

void onSessionInitiated(Broker.ConsumerSession session)

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 Broker.registerConsumer(Consumer)

Parameters:

session - Unique session between consumer and SAL.

getConsumerFunctionality

@Deprecated
Collection<Consumer.ConsumerFunctionality> getConsumerFunctionality()

Deprecated. - no longer used or needed * Suggested implementation until removed: public Collection<ConsumerFunctionality> getConsumerFunctionality() { return Collections.emptySet(); }