Initial opendaylight infrastructure commit!!

[controller.git] / opendaylight / sal / api / src / main / java / org / opendaylight / controller / sal / inventory / IPluginOutInventoryService.java

diff --git a/opendaylight/sal/api/src/main/java/org/opendaylight/controller/sal/inventory/IPluginOutInventoryService.java b/opendaylight/sal/api/src/main/java/org/opendaylight/controller/sal/inventory/IPluginOutInventoryService.java
new file mode 100644 (file)
index 0000000..6fb9283
--- /dev/null
+++ b/opendaylight/sal/api/src/main/java/org/opendaylight/controller/sal/inventory/IPluginOutInventoryService.java
@@ -0,0 +1,46 @@
+
+/*
+ * 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.inventory;
+
+import java.util.Set;
+
+import org.opendaylight.controller.sal.core.Node;
+import org.opendaylight.controller.sal.core.NodeConnector;
+import org.opendaylight.controller.sal.core.Property;
+import org.opendaylight.controller.sal.core.UpdateType;
+
+/**
+ * The interface class describes Inventory update methods to be implemented by
+ * protocol plugin
+ */
+public interface IPluginOutInventoryService {
+    /**
+     * This method is called when some properties of a node are added/deleted/changed.
+     *
+     * @param node                     {@link org.opendaylight.controller.sal.core.Node} being updated
+     * @param type             {@link org.opendaylight.controller.sal.core.UpdateType}
+     * @param props            set of {@link org.opendaylight.controller.sal.core.Property} such as
+     *                                                 {@link org.opendaylight.controller.sal.core.Name} and/or
+     *                                                 {@link org.opendaylight.controller.sal.core.Tier} etc.
+     */
+    public void updateNode(Node node, UpdateType type, Set<Property> props);
+
+    /**
+     * This method is called when some properties of a node connector are added/deleted/changed.
+     *
+     * @param nodeConnector    {@link org.opendaylight.controller.sal.core.NodeConnector} being updated
+     * @param type             {@link org.opendaylight.controller.sal.core.UpdateType}
+     * @param props            set of {@link org.opendaylight.controller.sal.core.Property} such as
+     *                                                 {@link org.opendaylight.controller.sal.core.Name} and/or
+     *                                                 {@link org.opendaylight.controller.sal.core.State} etc.
+     */
+    public void updateNodeConnector(NodeConnector nodeConnector,
+            UpdateType type, Set<Property> props);
+}