X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-binding-api%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fsal%2Fbinding%2Fapi%2FBindingAwareBroker.java;h=a41186dae11eda694687e7698663dffbc3364c26;hp=87008cd14b9e8780f4185d155a675c921467faf3;hb=d04e0863b86415749a8437241c57df0d32a3b133;hpb=fe024ad74b8656c3ee61b9ddff6009a779aa2189 diff --git a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/BindingAwareBroker.java b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/BindingAwareBroker.java index 87008cd14b..a41186dae1 100644 --- a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/BindingAwareBroker.java +++ b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/BindingAwareBroker.java @@ -7,64 +7,64 @@ */ package org.opendaylight.controller.sal.binding.api; -import org.opendaylight.controller.sal.binding.api.data.DataBrokerService; -import org.opendaylight.controller.sal.binding.api.data.DataProviderService; +import org.opendaylight.controller.md.sal.common.api.routing.RoutedRegistration; +import org.opendaylight.controller.sal.binding.api.BindingAwareProvider.ProviderFunctionality; +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 {@link Consumer}s and {@link Provider}s, 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-indpenedent form which + * classes modeling the functionality and data to binding-independent form which * is used in SAL Core. - * - * + * + * *

Infrastructure services

Some examples of infrastructure services: - * + * * - * + * * 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 {@link ConsumerContext} * and {@link ProviderContext} - * - * - * */ public interface BindingAwareBroker { /** * 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 Consumer#onSessionInitiated(ConsumerContext)}. - * + * * @param cons * Consumer to be registered. * @return a session specific to consumer registration @@ -77,24 +77,24 @@ public interface BindingAwareBroker { /** * Registers the {@link BindingAwareProvider}, which will use the SAL layer. - * + * *

* During the registration, the broker obtains the initial functionality * from consumer, using the * {@link 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 prov * Provider to be registered. * @return a session unique to the provider registration. @@ -107,68 +107,100 @@ public interface BindingAwareBroker { /** * {@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 Provider}s. - * - * - * */ - public interface ConsumerContext { + public interface ConsumerContext extends RpcConsumerRegistry { /** * Returns a session specific instance (implementation) of requested * binding-aware infrastructural service - * + * * @param service * Broker service * @return Session specific implementation of service */ T getSALService(Class service); - - /** - * Returns a session specific instance (implementation) of requested - * YANG module implentation / service provided by consumer. - * - * @param service - * Broker service - * @return Session specific implementation of service - */ - T getRpcService(Class module); } /** * {@link BindingAwareProvider} specific access to the SAL functionality. - * + * *

* 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. - * + * */ - public interface ProviderContext extends ConsumerContext { + public interface ProviderContext extends ConsumerContext, RpcProviderRegistry { + + @Deprecated + void registerFunctionality(ProviderFunctionality functionality); - RpcServiceRegistration addRpcImplementation(Class type, T implementation); + @Deprecated + void unregisterFunctionality(ProviderFunctionality functionality); } - public interface RpcServiceRegistration { + /** + * Represents an RPC implementation registration. Users should call the + * {@link ObjectRegistration#close close} method when the registration is no longer needed. + * + * @param the implemented RPC service interface + */ + public interface RpcRegistration extends ObjectRegistration { - T getService(); + /** + * Returns the implemented RPC service interface. + */ + Class getServiceType(); + } - void unregister(); + /** + * Represents a routed RPC implementation registration. Users should call the + * {@link RoutedRegistration#close close} method when the registration is no longer needed. + * + * @param the implemented RPC service interface + */ + public interface RoutedRpcRegistration extends RpcRegistration, + RoutedRegistration, InstanceIdentifier, T> { + + /** + * Register particular instance identifier to be processed by this + * RpcService + * + * Deprecated in favor of {@link RoutedRegistration#registerPath(Object, Object)}. + * + * @param context + * @param instance + */ + @Deprecated + void registerInstance(Class context, InstanceIdentifier instance); + + /** + * Unregister particular instance identifier to be processed by this + * RpcService + * + * Deprecated in favor of {@link RoutedRegistration#unregisterPath(Object, Object)}. + * + * @param context + * @param instance + */ + @Deprecated + void unregisterInstance(Class context, InstanceIdentifier instance); } }