/* * 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.binding.api; import org.opendaylight.controller.md.sal.common.api.routing.RoutedRegistration; import org.opendaylight.yangtools.concepts.ObjectRegistration; import org.opendaylight.yangtools.yang.binding.BaseIdentity; import org.opendaylight.yangtools.yang.binding.InstanceIdentifier; import org.opendaylight.yangtools.yang.binding.RpcService; import org.osgi.framework.BundleContext; /** * Binding-aware core 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 * {@link ConsumerContext} and provide access to infrastructure services, which * removes direct dependencies between providers and consumers. * *
* The Binding-aware broker is also responsible for translation from Java * classes modeling the functionality and data to binding-independent form which * is used in SAL Core. * *
* 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 ConsumerContext} * and {@link ProviderContext} */ public interface BindingAwareBroker { /* * @deprecated Use registerConsumer(BindingAwareConsumer cons) instead (BundleContext is no longer used) */ @Deprecated ConsumerContext registerConsumer(BindingAwareConsumer consumer, BundleContext ctx); /** * Registers the {@link BindingAwareConsumer}, which will use the SAL layer. * *
* 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 BindingAwareConsumer#onSessionInitialized(ConsumerContext)}.
*
* @param consumer
* 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.
*/
ConsumerContext registerConsumer(BindingAwareConsumer consumer);
/*
* @deprecated Use registerProvider(BindingAwareProvider prov) instead (BundleContext is no longer used)
*/
@Deprecated
ProviderContext registerProvider(BindingAwareProvider provider, BundleContext ctx);
/**
* Registers the {@link BindingAwareProvider}, which will use the SAL layer.
*
*
* During the registration, the broker obtains the initial functionality * from consumer, using the * BindingAwareProvider#getImplementations(), and register that * functionality into system and concrete infrastructure services. * *
* Note that provider 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 BindingAwareProvider#onSessionInitiated(ProviderContext)}.
*
*
* @param provider
* 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.
*/
ProviderContext registerProvider(BindingAwareProvider provider);
/**
* {@link BindingAwareConsumer} specific access to the SAL functionality.
*
*
* ConsumerSession is {@link BindingAwareConsumer}-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 BindingAwareProvider}s.
*/
interface ConsumerContext extends RpcConsumerRegistry {
/**
* Returns a session specific instance (implementation) of requested binding-aware infrastructure service.
*
* @param service
* Broker service
* @return Session specific implementation of service
*/
* ProviderSession is {@link BindingAwareProvider}-specific access to the
* SAL functionality and infrastructure services, which also allows for
* exposing the provider's functionality to the other
* {@link BindingAwareConsumer}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 BindingAwareConsumer}s.
*
*/
interface ProviderContext extends ConsumerContext, RpcProviderRegistry {
}
/**
* Represents an RPC implementation registration. Users should call the
* {@link ObjectRegistration#close close} method when the registration is no longer needed.
*
* @param