/* * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Public License v1.0 which accompanies this distribution, * and is available at http://www.eclipse.org/legal/epl-v10.html */ package org.opendaylight.controller.sal.core.api; import org.osgi.framework.BundleContext; /** * Core component of the SAL layer responsible for wiring the SAL consumers. * *
* The responsibility of the broker is to maintain registration of SAL * functionality {@link Consumer}s and {@link Provider}s, store provider and * consumer specific context and functionality registration via * {@link ConsumerSession} and provide access to infrastructure services, which * removes direct dependencies between providers and consumers. * *
* The services are exposed via session. * *
* 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 {@link ConsumerSession} * and {@link ProviderSession} * * @deprecated Use blueprint instead for code wiring. */ @Deprecated public interface Broker { /** * Registers the {@link Consumer}, which will use the SAL layer. * *
* During the registration, the broker obtains the initial functionality * from consumer, using the {@link 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
* {@link Consumer#onSessionInitiated(ConsumerSession)}.
*
* @param cons
* Consumer to be registered.
* @return a session specific to consumer registration
* @throws IllegalArgumentException
* If the consumer is null
.
* @throws IllegalStateException
* If the consumer is already registered.
*/
ConsumerSession registerConsumer(Consumer cons);
/*
* @deprecated Use registerConsumer(Consumer cons) instead (BundleContext is no longer used)
*/
@Deprecated
ConsumerSession registerConsumer(Consumer cons, BundleContext context);
/**
* Registers the {@link Provider}, which will use the SAL layer.
*
*
* During the registration, the broker obtains the initial functionality * from consumer, using the {@link 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
* {@link Provider#onSessionInitiated(ProviderSession)}.
*
*
* @param prov
* Provider to be registered.
* @return a session unique to the provider registration.
* @throws IllegalArgumentException
* If the provider is null
.
* @throws IllegalStateException
* If the consumer is already registered.
*/
ProviderSession registerProvider(Provider prov);
/*
* @deprecated Use registerProvider(Provider cons) instead (BundleContext is no longer used)
*/
@Deprecated
ProviderSession registerProvider(Provider prov, BundleContext context);
/**
* {@link Consumer} specific access to the SAL functionality.
*
*
* ConsumerSession is {@link Consumer}-specific access to the SAL * functionality and infrastructure services. * *
* The session serves to store SAL context (e.g. registration of
* functionality) for the consumer and provides access to the SAL
* infrastructure services and other functionality provided by
* {@link Provider}s.
*
*
*
*/
interface ConsumerSession {
boolean isClosed();
/**
* Returns a session specific instance (implementation) of requested service.
*
* @param service
* Broker service
* @return Session specific implementation of service
*/
* The close operation unregisters a consumer and remove all registered
* functionality of the consumer from the system.
*
*/
void close();
}
/**
* {@link Provider} specific access to the SAL functionality.
*
*
* ProviderSession is {@link Provider}-specific access to the SAL
* functionality and infrastructure services, which also allows for exposing
* the provider's functionality to the other {@link Consumer}s.
*
*
* The session serves to store SAL context (e.g. registration of
* functionality) for the providers and exposes access to the SAL
* infrastructure services, dynamic functionality registration and any other
* functionality provided by other {@link Provider}s.
*
*/
interface ProviderSession extends ConsumerSession {
/**
* Closes a session between provider and SAL.
*
*
* The close operation unregisters a provider and remove all registered
* functionality of the provider from the system.
*/
@Override
void close();
@Override
boolean isClosed();
}
}