Removing ovsdb plugin dependency on sal.utils classes

This patch copies all the required classes (Status.java & StatusCode.java) from sal.utils and places them in plugin.api package.

Patch set 3: Add review comments.

Change-Id: I7e5ca9ef3480f4c3dcf604e1874f7e980681c2e8
Also-by: Anil Vishnoi <vishnoianil@gmail.com>
Signed-off-by: Sam Hague <shague@redhat.com>

diff --git a/commons/parent/pom.xml b/commons/parent/pom.xml
index 3fbddcd9751d8e642e2afbe734e1889f10bf5959..0cff71fa7d74a90473675b47c555f1f2a5fff6ff 100755 (executable)
--- a/commons/parent/pom.xml
+++ b/commons/parent/pom.xml
@@ -39,7 +39,7 @@ and is available at http://www.eclipse.org/legal/epl-v10.html
     <openstack.netvirt.providers.version>1.1.0-SNAPSHOT</openstack.netvirt.providers.version>
     <ovsdb.library.version>1.1.0-SNAPSHOT</ovsdb.library.version>
     <ovsdb.northbound.version>0.7.0-SNAPSHOT</ovsdb.northbound.version>
-    <ovsdb.plugin.version>1.1.0-SNAPSHOT</ovsdb.plugin.version>
+    <ovsdb.plugin.version>1.1.1-SNAPSHOT</ovsdb.plugin.version>
     <ovsdb.ovssfc.version>0.1.0-SNAPSHOT</ovsdb.ovssfc.version>
     <ovsdb.utils.config.version>1.1.0-SNAPSHOT</ovsdb.utils.config.version>
     <plugin.shell.version>1.1.0-SNAPSHOT</plugin.shell.version>

diff --git a/features/ovsdb/pom.xml b/features/ovsdb/pom.xml
index 510184d3967f2436ab4c8a216cfd9881c535c4d0..2ec41c665d1f1c06bad56ff8c689d231436033b7 100644 (file)
--- a/features/ovsdb/pom.xml
+++ b/features/ovsdb/pom.xml
@@ -19,7 +19,7 @@ and is available at http://www.eclipse.org/legal/epl-v10.html
   </parent>
 
   <artifactId>features-ovsdb</artifactId>
-  <version>1.1.0-SNAPSHOT</version>
+  <version>1.1.1-SNAPSHOT</version>
   <packaging>jar</packaging>
 
   <properties>

diff --git a/integrationtest/src/test/java/org/opendaylight/ovsdb/integrationtest/netvirt/NetVirtIT.java b/integrationtest/src/test/java/org/opendaylight/ovsdb/integrationtest/netvirt/NetVirtIT.java
index 31f5b13890e4b56c70520385a00fc36251a1a270..36bb8a707650be322053f62c975e2789b88591cc 100644 (file)
--- a/integrationtest/src/test/java/org/opendaylight/ovsdb/integrationtest/netvirt/NetVirtIT.java
+++ b/integrationtest/src/test/java/org/opendaylight/ovsdb/integrationtest/netvirt/NetVirtIT.java
@@ -62,7 +62,7 @@ public class NetVirtIT extends OvsdbIntegrationTestBase {
                        "odl-base-all"),
                 features("mvn:org.opendaylight.controller/features-neutron/0.5.0-SNAPSHOT/xml/features",
                         "odl-neutron-all"),
-                features("mvn:org.opendaylight.ovsdb/features-ovsdb/1.1.0-SNAPSHOT/xml/features",
+                features("mvn:org.opendaylight.ovsdb/features-ovsdb/1.1.1-SNAPSHOT/xml/features",
                         "odl-ovsdb-openstack")
         };
     }

diff --git a/integrationtest/src/test/java/org/opendaylight/ovsdb/integrationtest/neutron/NeutronIT.java b/integrationtest/src/test/java/org/opendaylight/ovsdb/integrationtest/neutron/NeutronIT.java
index 456b0c87aada21c72f327b2fa3d8db2d8d765c9b..98a33e8d69af40b84e35e987026b561d77b4967f 100644 (file)
--- a/integrationtest/src/test/java/org/opendaylight/ovsdb/integrationtest/neutron/NeutronIT.java
+++ b/integrationtest/src/test/java/org/opendaylight/ovsdb/integrationtest/neutron/NeutronIT.java
@@ -20,12 +20,12 @@ import static org.ops4j.pax.exam.CoreOptions.systemProperty;
 
 import org.opendaylight.controller.networkconfig.neutron.NeutronNetwork;
 import org.opendaylight.controller.sal.core.Node;
-import org.opendaylight.controller.sal.utils.Status;
 import org.opendaylight.ovsdb.integrationtest.ConfigurationBundles;
 import org.opendaylight.ovsdb.integrationtest.OvsdbIntegrationTestBase;
 import org.opendaylight.ovsdb.lib.notation.Row;
 import org.opendaylight.ovsdb.lib.notation.UUID;
 import org.opendaylight.ovsdb.lib.notation.Version;
+import org.opendaylight.ovsdb.plugin.api.Status;
 import org.opendaylight.ovsdb.openstack.netvirt.api.ConfigurationService;
 import org.opendaylight.ovsdb.openstack.netvirt.api.Constants;
 import org.opendaylight.ovsdb.openstack.netvirt.api.BridgeConfigurationManager;

diff --git a/integrationtest/src/test/java/org/opendaylight/ovsdb/integrationtest/plugin/OvsdbPluginIT.java b/integrationtest/src/test/java/org/opendaylight/ovsdb/integrationtest/plugin/OvsdbPluginIT.java
index b44d6fe3c342bf8602b22e694b6fe47d38bcb255..1c89b6191a769da5738809b66f3197b57af3f840 100644 (file)
--- a/integrationtest/src/test/java/org/opendaylight/ovsdb/integrationtest/plugin/OvsdbPluginIT.java
+++ b/integrationtest/src/test/java/org/opendaylight/ovsdb/integrationtest/plugin/OvsdbPluginIT.java
@@ -23,7 +23,6 @@ import static org.ops4j.pax.exam.CoreOptions.systemProperty;
 import org.junit.After;
 import org.opendaylight.controller.sal.core.Node;
 import org.opendaylight.controller.sal.utils.ServiceHelper;
-import org.opendaylight.controller.sal.utils.Status;
 import org.opendaylight.ovsdb.integrationtest.ConfigurationBundles;
 import org.opendaylight.ovsdb.integrationtest.OvsdbIntegrationTestBase;
 import org.opendaylight.ovsdb.lib.OvsdbClient;
@@ -34,6 +33,7 @@ import org.opendaylight.ovsdb.plugin.api.OvsdbConfigurationService;
 import org.opendaylight.ovsdb.plugin.api.OvsdbConnectionService;
 import org.opendaylight.ovsdb.plugin.api.OvsdbInventoryListener;
 import org.opendaylight.ovsdb.plugin.api.OvsdbInventoryService;
+import org.opendaylight.ovsdb.plugin.api.Status;
 import org.opendaylight.ovsdb.plugin.api.StatusWithUuid;
 import org.opendaylight.ovsdb.schema.openvswitch.Bridge;
 import org.opendaylight.ovsdb.schema.openvswitch.OpenVSwitch;

diff --git a/integrationtest/src/test/java/org/opendaylight/ovsdb/integrationtest/plugin/OvsdbPluginV3IT.java b/integrationtest/src/test/java/org/opendaylight/ovsdb/integrationtest/plugin/OvsdbPluginV3IT.java
index cb05e3948b4f7cc4c73fd3b15685d6aad41679b9..cb00f57d201be58f899c402d9da15b3da5909106 100644 (file)
--- a/integrationtest/src/test/java/org/opendaylight/ovsdb/integrationtest/plugin/OvsdbPluginV3IT.java
+++ b/integrationtest/src/test/java/org/opendaylight/ovsdb/integrationtest/plugin/OvsdbPluginV3IT.java
@@ -36,7 +36,6 @@ import org.junit.runner.RunWith;
 import org.mockito.Mockito;
 import org.opendaylight.controller.sal.core.Node;
 import org.opendaylight.controller.sal.utils.ServiceHelper;
-import org.opendaylight.controller.sal.utils.StatusCode;
 import org.opendaylight.ovsdb.integrationtest.ConfigurationBundles;
 import org.opendaylight.ovsdb.integrationtest.OvsdbIntegrationTestBase;
 import org.opendaylight.ovsdb.lib.OvsdbClient;
@@ -49,6 +48,7 @@ import org.opendaylight.ovsdb.plugin.api.OvsdbConfigurationService;
 import org.opendaylight.ovsdb.plugin.api.OvsdbConnectionService;
 import org.opendaylight.ovsdb.plugin.api.OvsdbInventoryListener;
 import org.opendaylight.ovsdb.plugin.api.OvsdbInventoryService;
+import org.opendaylight.ovsdb.plugin.api.StatusCode;
 import org.opendaylight.ovsdb.plugin.api.StatusWithUuid;
 import org.opendaylight.ovsdb.schema.openvswitch.Bridge;
 import org.opendaylight.ovsdb.schema.openvswitch.OpenVSwitch;

diff --git a/northbound/pom.xml b/northbound/pom.xml
index 594fd4cc583d6dca8b105d1b157c291c4254e3da..d15e7a6a81988b832d52139c8003e1525944fab1 100644 (file)
--- a/northbound/pom.xml
+++ b/northbound/pom.xml
@@ -99,30 +99,10 @@ and is available at http://www.eclipse.org/legal/epl-v10.html
         <extensions>true</extensions>
         <configuration>
           <instructions>
-            <Export-Package></Export-Package>
-            <Import-Package>org.opendaylight.controller.sal.utils,
-              org.opendaylight.controller.northbound.commons,
-              org.opendaylight.controller.northbound.commons.exception,
-              org.opendaylight.controller.northbound.commons.utils,
+            <Import-Package>
               com.sun.jersey.spi.container.servlet,
-              org.opendaylight.controller.sal.core,
-              org.opendaylight.controller.sal.authorization,
-              org.opendaylight.ovsdb.plugin.api,
-              org.opendaylight.ovsdb.lib,
-              org.opendaylight.ovsdb.lib.jsonrpc,
-              org.opendaylight.ovsdb.lib.notation,
-              org.opendaylight.ovsdb.lib.operations,
-              org.opendaylight.ovsdb.lib.message,
-              org.opendaylight.ovsdb.lib.schema,
-              org.opendaylight.ovsdb.lib.schema.typed,
-              javax.ws.rs,
-              javax.ws.rs.core,
-              javax.xml.bind,
-              javax.xml.bind.annotation,
-              org.slf4j,
-              org.apache.catalina.filters,
-              !org.codehaus.enunciate.jaxrs,*</Import-Package>
-            <Export-Package></Export-Package>
+              !org.codehaus.enunciate.jaxrs,
+              *</Import-Package>
             <Web-ContextPath>/ovsdb/nb</Web-ContextPath>
             <Jaxrs-Resources>,${classes;ANNOTATION;javax.ws.rs.Path}</Jaxrs-Resources>
           </instructions>

diff --git a/northbound/src/main/java/org/opendaylight/ovsdb/northbound/OvsdbNorthboundV2.java b/northbound/src/main/java/org/opendaylight/ovsdb/northbound/OvsdbNorthboundV2.java
index 771484d0ade9349ef97182d75797745d7b25e8d5..135acd46265f0ad2c0346f3e6fe2ef3911301106 100644 (file)
--- a/northbound/src/main/java/org/opendaylight/ovsdb/northbound/OvsdbNorthboundV2.java
+++ b/northbound/src/main/java/org/opendaylight/ovsdb/northbound/OvsdbNorthboundV2.java
@@ -39,7 +39,6 @@ import org.opendaylight.controller.northbound.commons.utils.NorthboundUtils;
 import org.opendaylight.controller.sal.authorization.Privilege;
 import org.opendaylight.controller.sal.core.Node;
 import org.opendaylight.controller.sal.utils.ServiceHelper;
-import org.opendaylight.controller.sal.utils.Status;
 import org.opendaylight.ovsdb.lib.OvsdbClient;
 import org.opendaylight.ovsdb.lib.notation.Row;
 import org.opendaylight.ovsdb.lib.notation.UUID;
@@ -47,6 +46,7 @@ import org.opendaylight.ovsdb.lib.schema.DatabaseSchema;
 import org.opendaylight.ovsdb.plugin.api.OvsVswitchdSchemaConstants;
 import org.opendaylight.ovsdb.plugin.api.OvsdbConfigurationService;
 import org.opendaylight.ovsdb.plugin.api.OvsdbConnectionService;
+import org.opendaylight.ovsdb.plugin.api.Status;
 import org.opendaylight.ovsdb.plugin.api.StatusWithUuid;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -355,7 +355,11 @@ public class OvsdbNorthboundV2 {
                     .entity(uuid.toString())
                     .build();
         }
-        return NorthboundUtils.getResponse(statusWithUuid);
+        /* TODO better way to return the status. Likely the shim will handle this */
+        //return NorthboundUtils.getResponse(statusWithUuid);
+        return NorthboundUtils.getResponse(
+                new org.opendaylight.controller.sal.utils.Status(
+                        org.opendaylight.controller.sal.utils.StatusCode.SUCCESS));
     }
 
     /**
@@ -595,7 +599,10 @@ public class OvsdbNorthboundV2 {
         }
 
         Status status = ovsdbTable.updateRow(node, bckCompatibleTableName, localRow.getParentUuid(), rowUuid, localRow.getRow());
-        return NorthboundUtils.getResponse(status);
+        /* TODO better way to return the status. Likely the shim will handle this */
+        return NorthboundUtils.getResponse(
+                new org.opendaylight.controller.sal.utils.Status(
+                        org.opendaylight.controller.sal.utils.StatusCode.SUCCESS));
     }
 
     /**
@@ -674,7 +681,10 @@ public class OvsdbNorthboundV2 {
         if (status.isSuccess()) {
             return Response.noContent().build();
         }
-        return NorthboundUtils.getResponse(status);
+        /* TODO better way to return the status. Likely the shim will handle this */
+        return NorthboundUtils.getResponse(
+                new org.opendaylight.controller.sal.utils.Status(
+                        org.opendaylight.controller.sal.utils.StatusCode.SUCCESS));
     }
 
     private String getBackwardCompatibleTableName(OvsdbClient client, String databaseName, String tableName) {

diff --git a/openstack/net-virt-providers/src/main/java/org/opendaylight/ovsdb/openstack/netvirt/providers/openflow13/OF13Provider.java b/openstack/net-virt-providers/src/main/java/org/opendaylight/ovsdb/openstack/netvirt/providers/openflow13/OF13Provider.java
index e24653a6c3fa6248a2b61ee9617efb6a6590a791..bab343933daad6a5ba30af2d5a787fb019b60e9c 100644 (file)
--- a/openstack/net-virt-providers/src/main/java/org/opendaylight/ovsdb/openstack/netvirt/providers/openflow13/OF13Provider.java
+++ b/openstack/net-virt-providers/src/main/java/org/opendaylight/ovsdb/openstack/netvirt/providers/openflow13/OF13Provider.java
@@ -25,8 +25,6 @@ import org.opendaylight.controller.networkconfig.neutron.NeutronNetwork;
 import org.opendaylight.controller.networkconfig.neutron.NeutronSecurityGroup;
 import org.opendaylight.controller.sal.core.Node;
 import org.opendaylight.controller.sal.utils.HexEncode;
-import org.opendaylight.controller.sal.utils.Status;
-import org.opendaylight.controller.sal.utils.StatusCode;
 import org.opendaylight.ovsdb.lib.notation.Row;
 import org.opendaylight.ovsdb.lib.notation.UUID;
 import org.opendaylight.ovsdb.openstack.netvirt.NetworkHandler;
@@ -42,6 +40,8 @@ import org.opendaylight.ovsdb.openstack.netvirt.api.SecurityServicesManager;
 import org.opendaylight.ovsdb.openstack.netvirt.api.TenantNetworkManager;
 import org.opendaylight.ovsdb.plugin.api.OvsdbConfigurationService;
 import org.opendaylight.ovsdb.plugin.api.OvsdbConnectionService;
+import org.opendaylight.ovsdb.plugin.api.Status;
+import org.opendaylight.ovsdb.plugin.api.StatusCode;
 import org.opendaylight.ovsdb.plugin.api.StatusWithUuid;
 import org.opendaylight.ovsdb.schema.openvswitch.Bridge;
 import org.opendaylight.ovsdb.schema.openvswitch.Interface;

diff --git a/openstack/net-virt/src/main/java/org/opendaylight/ovsdb/openstack/netvirt/api/NetworkingProvider.java b/openstack/net-virt/src/main/java/org/opendaylight/ovsdb/openstack/netvirt/api/NetworkingProvider.java
index 19dc1a8358e3b6f23136e08058dd66dd61c0509a..55a3a00807a1584a835851eda7f9739abc2c5156 100644 (file)
--- a/openstack/net-virt/src/main/java/org/opendaylight/ovsdb/openstack/netvirt/api/NetworkingProvider.java
+++ b/openstack/net-virt/src/main/java/org/opendaylight/ovsdb/openstack/netvirt/api/NetworkingProvider.java
@@ -12,7 +12,7 @@ package org.opendaylight.ovsdb.openstack.netvirt.api;
 
 import org.opendaylight.controller.networkconfig.neutron.NeutronNetwork;
 import org.opendaylight.controller.sal.core.Node;
-import org.opendaylight.controller.sal.utils.Status;
+import org.opendaylight.ovsdb.plugin.api.Status;
 import org.opendaylight.ovsdb.schema.openvswitch.Interface;
 
 /**

diff --git a/openstack/net-virt/src/main/java/org/opendaylight/ovsdb/openstack/netvirt/impl/BridgeConfigurationManagerImpl.java b/openstack/net-virt/src/main/java/org/opendaylight/ovsdb/openstack/netvirt/impl/BridgeConfigurationManagerImpl.java
index 64b2c3dfe7226b1070ee6b3539626ccaf519f473..aa131325bef3362450de6d929452823321052001 100644 (file)
--- a/openstack/net-virt/src/main/java/org/opendaylight/ovsdb/openstack/netvirt/impl/BridgeConfigurationManagerImpl.java
+++ b/openstack/net-virt/src/main/java/org/opendaylight/ovsdb/openstack/netvirt/impl/BridgeConfigurationManagerImpl.java
@@ -11,8 +11,6 @@ package org.opendaylight.ovsdb.openstack.netvirt.impl;
 
 import org.opendaylight.controller.networkconfig.neutron.NeutronNetwork;
 import org.opendaylight.controller.sal.core.Node;
-import org.opendaylight.controller.sal.utils.Status;
-import org.opendaylight.controller.sal.utils.StatusCode;
 import org.opendaylight.ovsdb.lib.error.SchemaVersionMismatchException;
 import org.opendaylight.ovsdb.lib.notation.Row;
 import org.opendaylight.ovsdb.lib.notation.UUID;
@@ -22,6 +20,8 @@ import org.opendaylight.ovsdb.openstack.netvirt.api.ConfigurationService;
 import org.opendaylight.ovsdb.openstack.netvirt.api.Constants;
 import org.opendaylight.ovsdb.openstack.netvirt.api.NetworkingProviderManager;
 import org.opendaylight.ovsdb.plugin.api.OvsdbConfigurationService;
+import org.opendaylight.ovsdb.plugin.api.Status;
+import org.opendaylight.ovsdb.plugin.api.StatusCode;
 import org.opendaylight.ovsdb.plugin.api.StatusWithUuid;
 import org.opendaylight.ovsdb.schema.openvswitch.Bridge;
 import org.opendaylight.ovsdb.schema.openvswitch.Interface;

diff --git a/plugin/pom.xml b/plugin/pom.xml
index ea28686db277bb4a55edea67355e7db1a53c70fe..c1e3ff67b9ec754ecf06cc2624cd27e639cd9ac4 100755 (executable)
--- a/plugin/pom.xml
+++ b/plugin/pom.xml
@@ -19,7 +19,7 @@ and is available at http://www.eclipse.org/legal/epl-v10.html
   </parent>
 
   <artifactId>plugin</artifactId>
-  <version>1.1.0-SNAPSHOT</version>
+  <version>1.1.1-SNAPSHOT</version>
   <packaging>bundle</packaging>
 
   <dependencies>

diff --git a/plugin/src/main/java/org/opendaylight/ovsdb/plugin/api/OvsdbConfigurationService.java b/plugin/src/main/java/org/opendaylight/ovsdb/plugin/api/OvsdbConfigurationService.java
index 083acc0849a82b899ede6e8e594384960bb9b476..288faa031b9f8feb1c581d73a55370eefc14e1d5 100644 (file)
--- a/plugin/src/main/java/org/opendaylight/ovsdb/plugin/api/OvsdbConfigurationService.java
+++ b/plugin/src/main/java/org/opendaylight/ovsdb/plugin/api/OvsdbConfigurationService.java
@@ -14,7 +14,6 @@ import java.util.concurrent.ConcurrentMap;
 import java.util.concurrent.ExecutionException;
 
 import org.opendaylight.controller.sal.core.Node;
-import org.opendaylight.controller.sal.utils.Status;
 import org.opendaylight.ovsdb.lib.notation.Row;
 import org.opendaylight.ovsdb.lib.notation.UUID;
 import org.opendaylight.ovsdb.lib.schema.GenericTableSchema;

diff --git a/plugin/src/main/java/org/opendaylight/ovsdb/plugin/api/Status.java b/plugin/src/main/java/org/opendaylight/ovsdb/plugin/api/Status.java
new file mode 100644 (file)
index 0000000..932be5b
--- /dev/null
+++ b/plugin/src/main/java/org/opendaylight/ovsdb/plugin/api/Status.java
@@ -0,0 +1,149 @@
+/*
+ * 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.ovsdb.plugin.api;
+
+import java.io.Serializable;
+
+/**
+ * Represents the return object of the osgi service interfaces function calls.
+ * It contains a code {@code StatusCode} representing the result of the call and
+ * a string which describes a failure reason (if any) in human readable form.
+ */
+@Deprecated
+public class Status implements Serializable {
+    private static final long serialVersionUID = 0L;
+    private StatusCode code;
+    private String description;
+    private long requestId;
+
+    /**
+     * Generates an instance of the Status class. This is used as return code
+     * for internal API2 function calls. This constructor allows to specify,
+     * beside the Status Code, a custom human readable description to add more
+     * information about the status.
+     *
+     * @param errorCode
+     *            The status code. If passed as null, code will be stored as
+     *            {@code StatusCode.UNDEFINED}
+     * @param description
+     *            The human readable description of the status. If passed as
+     *            null, description will be inferred by the code
+     */
+    public Status(StatusCode errorCode, String description) {
+        this.code = (errorCode != null) ? errorCode : StatusCode.UNDEFINED;
+        this.description = (description != null) ? description : this.code
+                .toString();
+        this.requestId = 0;
+    }
+
+    /**
+     * Generates an instance of the Status class based on the passed StatusCode
+     * only. The description field of the Status object will be inferred by the
+     * status code.
+     *
+     * @param errorCode
+     *            The status code. If passed as null, code will be stored as
+     *            {@code StatusCode.UNDEFINED}
+     */
+    public Status(StatusCode errorCode) {
+        this.code = (errorCode != null) ? errorCode : StatusCode.UNDEFINED;
+        this.description = (description != null) ? description : this.code
+                .toString();
+        this.requestId = 0;
+    }
+
+    /**
+     * Generates an instance of the Status class to be used in case of
+     * asynchronous call. It is supposed to be created by the underlying
+     * infrastructure only when it was successful in allocating the asynchronous
+     * request id, hence caller should expect StatusCode to be successful.
+     *
+     * @param errorCode
+     *            The status code. If passed as null, code will be stored as
+     *            {@code StatusCode.UNDEFINED}
+     * @param requestId
+     *            The request id set by underlying infrastructure for this
+     *            request
+     */
+    public Status(StatusCode errorCode, long requestId) {
+        this.code = (errorCode != null) ? errorCode : StatusCode.UNDEFINED;
+        this.description = (description != null) ? description : this.code
+                .toString();
+        this.requestId = requestId;
+    }
+
+    /**
+     * Returns the status code
+     *
+     * @return the {@code StatusCode} representing the status code
+     */
+    public StatusCode getCode() {
+        return code;
+    }
+
+    /**
+     * Returns a human readable description of the failure if any
+     *
+     * @return a string representing the reason of failure
+     */
+    public String getDescription() {
+        return description;
+    }
+
+    /**
+     * Tells whether the status is successful
+     *
+     * @return true if the Status code is {@code StatusCode.SUCCESS}
+     */
+    public boolean isSuccess() {
+        return code == StatusCode.SUCCESS || code == StatusCode.CREATED;
+    }
+
+    /**
+     * Return the request id assigned by underlying infrastructure in case of
+     * asynchronous request. In case of synchronous requests, the returned id
+     * is expected to be 0
+     *
+     * @return The request id assigned for this asynchronous request
+     */
+    public long getRequestId() {
+        return requestId;
+    }
+
+    @Override
+    public String toString() {
+        return code + ": " + description + " (" + requestId + ")";
+    }
+
+    @Override
+    public int hashCode() {
+        final int prime = 31;
+        int result = 1;
+        result = prime * result + ((code == null) ? 0 : code.calculateConsistentHashCode());
+        return result;
+    }
+
+    @Override
+    public boolean equals(Object obj) {
+        if (this == obj) {
+            return true;
+        }
+        if (obj == null) {
+            return false;
+        }
+        if (getClass() != obj.getClass()) {
+            return false;
+        }
+        Status other = (Status) obj;
+        if (code != other.code) {
+            return false;
+        }
+        return true;
+    }
+}

diff --git a/plugin/src/main/java/org/opendaylight/ovsdb/plugin/api/StatusCode.java b/plugin/src/main/java/org/opendaylight/ovsdb/plugin/api/StatusCode.java
new file mode 100644 (file)
index 0000000..311677a
--- /dev/null
+++ b/plugin/src/main/java/org/opendaylight/ovsdb/plugin/api/StatusCode.java
@@ -0,0 +1,57 @@
+/*
+ * 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.ovsdb.plugin.api;
+
+/**
+ * The enum which describes the generic error conditions.
+ * Each enum value is associated with a minimal description string.
+ *
+ */
+public enum StatusCode {
+    SUCCESS("Success"),
+    CREATED("Created"),
+
+    BADREQUEST("Bad Request"),
+    UNAUTHORIZED("UnAuthorized"),
+    FORBIDDEN("Forbidden"),
+    NOTFOUND("Not Found"),
+    NOTALLOWED("Method Not Allowed"),
+    NOTACCEPTABLE("Request Not Acceptable"),
+    TIMEOUT("Request Timeout"),
+    CONFLICT("Resource Conflict"),
+    GONE("Resource Gone"),
+    UNSUPPORTED("Unsupported"),
+
+    INTERNALERROR("Internal Error"),
+    NOTIMPLEMENTED("Not Implemented"),
+    NOSERVICE("Service Not Available"),
+
+    UNDEFINED("Undefined Error");
+
+    private String description;
+    private StatusCode(String description) {
+        this.description = description;
+    }
+
+    /**
+     * Prints the description associated to the code value
+     */
+    @Override
+    public String toString() {
+        return description;
+    }
+
+    public int calculateConsistentHashCode() {
+        if (this.description != null) {
+            return this.description.hashCode();
+        } else {
+            return 0;
+        }
+    }
+}

diff --git a/plugin/src/main/java/org/opendaylight/ovsdb/plugin/api/StatusWithUuid.java b/plugin/src/main/java/org/opendaylight/ovsdb/plugin/api/StatusWithUuid.java
index be8625af9f5234cbd9a6278af7de744a4cfb9189..b8bd5b6e3362754be25e647360e95b8c69692c4d 100644 (file)
--- a/plugin/src/main/java/org/opendaylight/ovsdb/plugin/api/StatusWithUuid.java
+++ b/plugin/src/main/java/org/opendaylight/ovsdb/plugin/api/StatusWithUuid.java
@@ -9,8 +9,6 @@
  */
 package org.opendaylight.ovsdb.plugin.api;
 
-import org.opendaylight.controller.sal.utils.Status;
-import org.opendaylight.controller.sal.utils.StatusCode;
 import org.opendaylight.ovsdb.lib.notation.UUID;
 
 /**

diff --git a/plugin/src/main/java/org/opendaylight/ovsdb/plugin/impl/ConfigurationServiceImpl.java b/plugin/src/main/java/org/opendaylight/ovsdb/plugin/impl/ConfigurationServiceImpl.java
index d284eb6854d399df51378095d17966b21ca17ae0..237cc80b9864bb1239b1e4d4406f588beeb5a48e 100644 (file)
--- a/plugin/src/main/java/org/opendaylight/ovsdb/plugin/impl/ConfigurationServiceImpl.java
+++ b/plugin/src/main/java/org/opendaylight/ovsdb/plugin/impl/ConfigurationServiceImpl.java
@@ -23,8 +23,6 @@ import java.util.concurrent.ConcurrentMap;
 import java.util.concurrent.ExecutionException;
 
 import org.opendaylight.controller.sal.core.Node;
-import org.opendaylight.controller.sal.utils.Status;
-import org.opendaylight.controller.sal.utils.StatusCode;
 import org.opendaylight.ovsdb.lib.OvsdbClient;
 import org.opendaylight.ovsdb.lib.error.SchemaVersionMismatchException;
 import org.opendaylight.ovsdb.lib.notation.Column;
@@ -48,6 +46,8 @@ import org.opendaylight.ovsdb.plugin.api.OvsVswitchdSchemaConstants;
 import org.opendaylight.ovsdb.plugin.api.OvsdbConfigurationService;
 import org.opendaylight.ovsdb.plugin.api.OvsdbConnectionService;
 import org.opendaylight.ovsdb.plugin.api.OvsdbInventoryService;
+import org.opendaylight.ovsdb.plugin.api.Status;
+import org.opendaylight.ovsdb.plugin.api.StatusCode;
 import org.opendaylight.ovsdb.plugin.api.StatusWithUuid;
 import org.opendaylight.ovsdb.plugin.error.OvsdbPluginException;
 import org.opendaylight.ovsdb.schema.openvswitch.Bridge;

diff --git a/plugin/src/main/java/org/opendaylight/ovsdb/plugin/impl/ConnectionServiceImpl.java b/plugin/src/main/java/org/opendaylight/ovsdb/plugin/impl/ConnectionServiceImpl.java
index a7625941151144b09b0b562533bc50c0b01a88ea..288bc6581804c54e7ad86ea5c0c8328cf32cc4af 100644 (file)
--- a/plugin/src/main/java/org/opendaylight/ovsdb/plugin/impl/ConnectionServiceImpl.java
+++ b/plugin/src/main/java/org/opendaylight/ovsdb/plugin/impl/ConnectionServiceImpl.java
@@ -25,8 +25,6 @@ import java.util.concurrent.ExecutionException;
 
 import org.opendaylight.controller.sal.core.Node;
 import org.opendaylight.controller.sal.core.Property;
-import org.opendaylight.controller.sal.utils.Status;
-import org.opendaylight.controller.sal.utils.StatusCode;
 import org.opendaylight.ovsdb.lib.MonitorCallBack;
 import org.opendaylight.ovsdb.lib.OvsdbClient;
 import org.opendaylight.ovsdb.lib.OvsdbConnection;
@@ -41,6 +39,8 @@ import org.opendaylight.ovsdb.lib.schema.GenericTableSchema;
 import org.opendaylight.ovsdb.lib.schema.TableSchema;
 import org.opendaylight.ovsdb.plugin.api.Connection;
 import org.opendaylight.ovsdb.plugin.api.ConnectionConstants;
+import org.opendaylight.ovsdb.plugin.api.Status;
+import org.opendaylight.ovsdb.plugin.api.StatusCode;
 import org.opendaylight.ovsdb.plugin.internal.IPAddressProperty;
 import org.opendaylight.ovsdb.plugin.internal.L4PortProperty;
 import org.opendaylight.ovsdb.plugin.api.OvsdbConnectionService;