org.opendaylight.controller.sal.core.api

Interface Broker

All Known Implementing Classes:

BrokerImpl

public interface Broker

Core component of the SAL layer responsible for wiring the SAL consumers. The responsibility of the broker is to maintain registration of SAL functionality Consumers and Providers, store provider and consumer specific context and functionality registration via Broker.ConsumerSession and provide access to infrastructure services, which removes direct dependencies between providers and consumers. The services are exposed via session.

Session-based access

The providers and consumers needs to register in order to use the binding-independent SAL layer and to expose functionality via SAL layer. For more information about session-based access see Broker.ConsumerSession and Broker.ProviderSession

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Broker.ConsumerSession Consumer specific access to the SAL functionality.
static interface	Broker.ProviderSession Provider specific access to the SAL functionality.

Method Summary

Modifier and Type	Method and Description
Broker.ConsumerSession	registerConsumer(Consumer cons) Registers the Consumer, which will use the SAL layer.
Broker.ConsumerSession	registerConsumer(Consumer cons, org.osgi.framework.BundleContext context) Deprecated.
Broker.ProviderSession	registerProvider(Provider prov) Registers the Provider, which will use the SAL layer.
Broker.ProviderSession	registerProvider(Provider prov, org.osgi.framework.BundleContext context) Deprecated.

Method Detail

registerConsumer

Broker.ConsumerSession registerConsumer(Consumer cons)

Registers the Consumer, which will use the SAL layer.

During the registration, the broker obtains the initial functionality from consumer, using the Consumer.getConsumerFunctionality(), and register that functionality into system and concrete infrastructure services.

Note that consumer could register additional functionality at later point by using service and functionality specific APIs.

The consumer is required to use returned session for all communication with broker or one of the broker services. The session is announced to the consumer by invoking Consumer#onSessionInitiated(ConsumerSession).

Parameters:

cons - Consumer to be registered.

Returns:

a session specific to consumer registration

Throws:

IllegalArgumentException - If the consumer is null.

IllegalStateException - If the consumer is already registered.

registerConsumer

@Deprecated
Broker.ConsumerSession registerConsumer(Consumer cons,
                                                    org.osgi.framework.BundleContext context)

Deprecated.

registerProvider

Broker.ProviderSession registerProvider(Provider prov)

Registers the Provider, which will use the SAL layer.

During the registration, the broker obtains the initial functionality from consumer, using the Provider.getProviderFunctionality(), and register that functionality into system and concrete infrastructure services.

The consumer is required to use returned session for all communication with broker or one of the broker services. The session is announced to the consumer by invoking Provider#onSessionInitiated(ProviderSession).

Parameters:

prov - Provider to be registered.

Returns:

a session unique to the provider registration.

Throws:

IllegalArgumentException - If the provider is null.

IllegalStateException - If the consumer is already registered.

registerProvider

@Deprecated
Broker.ProviderSession registerProvider(Provider prov,
                                                    org.osgi.framework.BundleContext context)

Deprecated.