Initial opendaylight infrastructure commit!!

[controller.git] / opendaylight / sal / yang-prototype / sal / sal-core-api / src / main / java / org / opendaylight / controller / sal / core / api / BrokerService.java

diff --git a/opendaylight/sal/yang-prototype/sal/sal-core-api/src/main/java/org/opendaylight/controller/sal/core/api/BrokerService.java b/opendaylight/sal/yang-prototype/sal/sal-core-api/src/main/java/org/opendaylight/controller/sal/core/api/BrokerService.java
new file mode 100644 (file)
index 0000000..b854188
--- /dev/null
+++ b/opendaylight/sal/yang-prototype/sal/sal-core-api/src/main/java/org/opendaylight/controller/sal/core/api/BrokerService.java
@@ -0,0 +1,39 @@
+/*\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 org.opendaylight.controller.sal.core.api.Broker.ConsumerSession;\r
+\r
+/**\r
+ * \r
+ * Session-specific instance of the broker functionality.\r
+ * \r
+ * <p>\r
+ * BrokerService is marker interface for infrastructure services provided by the\r
+ * SAL. These services are session-specific, each {@link Provider} and\r
+ * {@link Consumer} usually has own instance of the service with it's own\r
+ * context.\r
+ * \r
+ * <p>\r
+ * The consumer's (or provider's) instance of specific service could be obtained\r
+ * by invoking {@link ConsumerSession#getService(Class)} method on session\r
+ * assigned to the consumer.\r
+ * \r
+ * <p>\r
+ * {@link BrokerService} and {@link Provider} may seem similar, but provider\r
+ * provides YANG model-based functionality and {@link BrokerService} exposes the\r
+ * necessary supporting functionality to implement specific functionality of\r
+ * YANG and to reuse it in the development of {@link Consumer}s and\r
+ * {@link Provider}s.\r
+ * \r
+ * \r
+ */\r
+public interface BrokerService {\r
+\r
+    void closeSession();\r
+}\r