--- /dev/null
+/*\r
+ * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.\r
+ *\r
+ * This program and the accompanying materials are made available under the\r
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,\r
+ * and is available at http://www.eclipse.org/legal/epl-v10.html\r
+ */\r
+package org.opendaylight.controller.sal.core.api;\r
+\r
+import java.util.concurrent.Future;\r
+\r
+import org.opendaylight.controller.sal.core.api.data.DataBrokerService;\r
+import org.opendaylight.controller.sal.core.api.data.DataProviderService;\r
+import org.opendaylight.controller.sal.core.api.notify.NotificationProviderService;\r
+import org.opendaylight.controller.sal.core.api.notify.NotificationService;\r
+import org.opendaylight.controller.yang.common.QName;\r
+import org.opendaylight.controller.yang.common.RpcResult;\r
+import org.opendaylight.controller.yang.data.api.CompositeNode;\r
+\r
+\r
+/**\r
+ * Core component of the SAL layer responsible for wiring the SAL consumers.\r
+ * \r
+ * The responsibility of the broker is to maintain registration of SAL\r
+ * functionality {@link Consumer}s and {@link Provider}s, store provider and\r
+ * consumer specific context and functionality registration via\r
+ * {@link ConsumerSession} and provide access to infrastructure services, which\r
+ * removes direct dependencies between providers and consumers.\r
+ * \r
+ * \r
+ * <h3>Infrastructure services</h3> Some examples of infrastructure services:\r
+ * \r
+ * <ul>\r
+ * <li>RPC Invocation - see {@link ConsumerSession#rpc(QName, CompositeNode)},\r
+ * {@link ProviderSession#addRpcImplementation(QName, RpcImplementation)} and\r
+ * {@link RpcImplementation}\r
+ * <li>Notification Service - see {@link NotificationService} and\r
+ * {@link NotificationProviderService}\r
+ * <li>Functionality and Data model\r
+ * <li>Data Store access and modification - see {@link DataBrokerService} and\r
+ * {@link DataProviderService}\r
+ * </ul>\r
+ * \r
+ * The services are exposed via session.\r
+ * \r
+ * <h3>Session-based access</h3>\r
+ * \r
+ * The providers and consumers needs to register in order to use the\r
+ * binding-independent SAL layer and to expose functionality via SAL layer.\r
+ * \r
+ * For more information about session-based access see {@link ConsumerSession}\r
+ * and {@link ProviderSession}\r
+ * \r
+ * \r
+ * \r
+ */\r
+public interface Broker {\r
+\r
+ /**\r
+ * Registers the {@link Consumer}, which will use the SAL layer.\r
+ * \r
+ * <p>\r
+ * During the registration, the broker obtains the initial functionality\r
+ * from consumer, using the {@link Consumer#getConsumerFunctionality()}, and\r
+ * register that functionality into system and concrete infrastructure\r
+ * services.\r
+ * \r
+ * <p>\r
+ * Note that consumer could register additional functionality at later point\r
+ * by using service and functionality specific APIs.\r
+ * \r
+ * <p>\r
+ * The consumer is required to use returned session for all communication\r
+ * with broker or one of the broker services. The session is announced to\r
+ * the consumer by invoking\r
+ * {@link Consumer#onSessionInitiated(ConsumerSession)}.\r
+ * \r
+ * @param cons\r
+ * Consumer to be registered.\r
+ * @return a session specific to consumer registration\r
+ * @throws IllegalArgumentException\r
+ * If the consumer is <code>null</code>.\r
+ * @throws IllegalStateException\r
+ * If the consumer is already registered.\r
+ */\r
+ ConsumerSession registerConsumer(Consumer cons);\r
+\r
+ /**\r
+ * Registers the {@link Provider}, which will use the SAL layer.\r
+ * \r
+ * <p>\r
+ * During the registration, the broker obtains the initial functionality\r
+ * from consumer, using the {@link Provider#getProviderFunctionality()}, and\r
+ * register that functionality into system and concrete infrastructure\r
+ * services.\r
+ * \r
+ * <p>\r
+ * Note that consumer could register additional functionality at later point\r
+ * by using service and functionality specific APIs (e.g.\r
+ * {@link ProviderSession#addRpcImplementation(QName, RpcImplementation)}\r
+ * \r
+ * <p>\r
+ * The consumer is <b>required to use</b> returned session for all\r
+ * communication with broker or one of the broker services. The session is\r
+ * announced to the consumer by invoking\r
+ * {@link Provider#onSessionInitiated(ProviderSession)}.\r
+ * \r
+ * \r
+ * @param prov\r
+ * Provider to be registered.\r
+ * @return a session unique to the provider registration.\r
+ * @throws IllegalArgumentException\r
+ * If the provider is <code>null</code>.\r
+ * @throws IllegalStateException\r
+ * If the consumer is already registered.\r
+ */\r
+ ProviderSession registerProvider(Provider prov);\r
+\r
+ /**\r
+ * {@link Consumer} specific access to the SAL functionality.\r
+ * \r
+ * <p>\r
+ * ConsumerSession is {@link Consumer}-specific access to the SAL\r
+ * functionality and infrastructure services.\r
+ * \r
+ * <p>\r
+ * The session serves to store SAL context (e.g. registration of\r
+ * functionality) for the consumer and provides access to the SAL\r
+ * infrastructure services and other functionality provided by\r
+ * {@link Provider}s.\r
+ * \r
+\r
+ * \r
+ */\r
+ public interface ConsumerSession {\r
+\r
+ /**\r
+ * Sends an RPC to other components registered to the broker.\r
+ * \r
+ * @see RpcImplementation\r
+ * @param rpc\r
+ * Name of RPC\r
+ * @param input\r
+ * Input data to the RPC\r
+ * @return Result of the RPC call\r
+ */\r
+ Future<RpcResult<CompositeNode>> rpc(QName rpc, CompositeNode input);\r
+\r
+ /**\r
+ * Returns a session specific instance (implementation) of requested\r
+ * service\r
+ * \r
+ * @param service\r
+ * Broker service\r
+ * @return Session specific implementation of service\r
+ */\r
+ <T extends BrokerService> T getService(Class<T> service);\r
+\r
+ /**\r
+ * Closes a session between consumer and broker.\r
+ * \r
+ * <p>\r
+ * The close operation unregisters a consumer and remove all registered\r
+ * functionality of the consumer from the system.\r
+ * \r
+ */\r
+ void close();\r
+ }\r
+\r
+ /**\r
+ * {@link Provider} specific access to the SAL functionality.\r
+ * \r
+ * <p>\r
+ * ProviderSession is {@link Provider}-specific access to the SAL\r
+ * functionality and infrastructure services, which also allows for exposing\r
+ * the provider's functionality to the other {@link Consumer}s.\r
+ * \r
+ * <p>\r
+ * The session serves to store SAL context (e.g. registration of\r
+ * functionality) for the providers and exposes access to the SAL\r
+ * infrastructure services, dynamic functionality registration and any other\r
+ * functionality provided by other {@link Provider}s.\r
+ * \r
+ */\r
+ public interface ProviderSession extends ConsumerSession {\r
+ /**\r
+ * Registers an implementation of the rpc.\r
+ * \r
+ * <p>\r
+ * The registered rpc functionality will be available to all other\r
+ * consumers and providers registered to the broker, which are aware of\r
+ * the {@link QName} assigned to the rpc.\r
+ * \r
+ * <p>\r
+ * There is no assumption that rpc type is in the set returned by\r
+ * invoking {@link RpcImplementation#getSupportedRpcs()}. This allows\r
+ * for dynamic rpc implementations.\r
+ * \r
+ * @param rpcType\r
+ * Name of Rpc\r
+ * @param implementation\r
+ * Provider's Implementation of the RPC functionality\r
+ * @throws IllegalArgumentException\r
+ * If the name of RPC is invalid\r
+ */\r
+ void addRpcImplementation(QName rpcType,\r
+ RpcImplementation implementation)\r
+ throws IllegalArgumentException;\r
+\r
+ /**\r
+ * Unregisters an Rpc implementation\r
+ * \r
+ * @param rpcType\r
+ * Name of Rpc\r
+ * @param implementation\r
+ * Registered Implementation of the Rpc functionality\r
+ * @throws IllegalArgumentException\r
+ */\r
+ void removeRpcImplementation(QName rpcType,\r
+ RpcImplementation implementation)\r
+ throws IllegalArgumentException;\r
+\r
+ /**\r
+ * Closes a session between provider and SAL.\r
+ * \r
+ * <p>\r
+ * The close operation unregisters a provider and remove all registered\r
+ * functionality of the provider from the system.\r
+ */\r
+ @Override\r
+ public void close();\r
+ }\r
+}\r
Code Review / controller.git / blobdiff