Initial opendaylight infrastructure commit!!

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

diff --git a/opendaylight/sal/yang-prototype/sal/sal-core-api/src/main/java/org/opendaylight/controller/sal/core/api/Consumer.java b/opendaylight/sal/yang-prototype/sal/sal-core-api/src/main/java/org/opendaylight/controller/sal/core/api/Consumer.java
new file mode 100644 (file)
index 0000000..1b223f9
--- /dev/null
+++ b/opendaylight/sal/yang-prototype/sal/sal-core-api/src/main/java/org/opendaylight/controller/sal/core/api/Consumer.java
@@ -0,0 +1,59 @@
+/*\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.Collection;\r
+\r
+import org.opendaylight.controller.sal.core.api.Broker.ConsumerSession;\r
+\r
+/**\r
+ * \r
+ * Defines the component of controller and supplies additional metadata. A\r
+ * component of the controller or application supplies a concrete implementation\r
+ * of this interface.\r
+ * \r
+ * A user-implemented component (application) which faciliates the SAL and SAL\r
+ * services to access infrastructure services or providers' functionality.\r
+ * \r
+ * \r
+ */\r
+public interface Consumer {\r
+\r
+    /**\r
+     * Callback signaling initialization of the consumer session to the SAL.\r
+     * \r
+     * The consumer MUST use the session for all communication with SAL or\r
+     * retrieving SAL infrastructure services.\r
+     * \r
+     * This method is invoked by {@link Broker#registerConsumer(Consumer)}\r
+     * \r
+     * @param session\r
+     *            Unique session between consumer and SAL.\r
+     */\r
+    public void onSessionInitiated(ConsumerSession session);\r
+\r
+    /**\r
+     * Get a set of implementations of consumer functionality to be registered\r
+     * into system during the consumer registration to the SAL.\r
+     * \r
+     * This method is invoked by {@link Broker#registerConsumer(Consumer)}.\r
+     * \r
+     * @return Set of consumer functionality.\r
+     */\r
+    public Collection<ConsumerFunctionality> getConsumerFunctionality();\r
+\r
+    /**\r
+     * The marker interface for the interfaces describing the consumer\r
+     * functionality contracts.\r
+     * \r
+     * \r
+     */\r
+    public interface ConsumerFunctionality {\r
+\r
+    }\r
+}\r