Report HTTP status 409 on DATA_MISSING error

[netconf.git] / restconf / restconf-common / src / main / java / org / opendaylight / restconf / common / errors / RestconfError.java

diff --git a/restconf/restconf-common/src/main/java/org/opendaylight/restconf/common/errors/RestconfError.java b/restconf/restconf-common/src/main/java/org/opendaylight/restconf/common/errors/RestconfError.java
index 44890df1a98e6efa2ac38420f8ae8d161c91802f..ba8d73f7b0315fd6633e1dfc39a70e01f1aeada9 100644 (file)
--- a/restconf/restconf-common/src/main/java/org/opendaylight/restconf/common/errors/RestconfError.java
+++ b/restconf/restconf-common/src/main/java/org/opendaylight/restconf/common/errors/RestconfError.java
@@ -13,6 +13,8 @@ import java.io.Serializable;
 import java.util.Locale;
 import org.opendaylight.yangtools.yang.common.RpcError;
 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 /**
  * Encapsulates a restconf error as defined in the ietf restconf draft.
@@ -25,6 +27,7 @@ import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  *     See also <a href="https://tools.ietf.org/html/draft-bierman-netconf-restconf-02">RESTCONF</a>.
  */
 public class RestconfError implements Serializable {
+    private static final Logger LOG = LoggerFactory.getLogger(RestconfError.class);
     private static final long serialVersionUID = 1L;
 
     public enum ErrorType {
@@ -74,7 +77,7 @@ public class RestconfError implements Serializable {
         RESOURCE_DENIED("resource-denied", 409 /* Conflict */),
         ROLLBACK_FAILED("rollback-failed", 500 /* INTERNAL_SERVER_ERROR */),
         DATA_EXISTS("data-exists", 409 /* Conflict */),
-        DATA_MISSING("data-missing", 404 /* Resource Not Found */),
+        DATA_MISSING("data-missing", dataMissingHttpStatus()),
         OPERATION_NOT_SUPPORTED("operation-not-supported", 501 /* Not Implemented */),
         OPERATION_FAILED("operation-failed", 500 /* INTERNAL_SERVER_ERROR */),
         PARTIAL_OPERATION("partial-operation", 500 /* INTERNAL_SERVER_ERROR */),
@@ -104,6 +107,28 @@ public class RestconfError implements Serializable {
         public int getStatusCode() {
             return statusCode;
         }
+
+        private static int dataMissingHttpStatus() {
+            // Control over the HTTP status reported on "data-missing" conditions. This defaults to disabled,
+            // HTTP status 409 as specified by RFC8040 (and all previous drafts). See the discussion in:
+            // https://www.rfc-editor.org/errata/eid5565
+            // https://mailarchive.ietf.org/arch/msg/netconf/hkVDdHK4xA74NgvXzWP0zObMiyY/
+            final String propName = "org.opendaylight.restconf.eid5565";
+            final String propValue = System.getProperty(propName, "enabled");
+            switch (propValue) {
+                case "enabled":
+                    // RFC7231 interpretation: 404 Not Found
+                    LOG.info("RESTCONF data-missing condition is reported as HTTP status 404 (Errata 5565)");
+                    return 404;
+                case "disabled":
+                    break;
+                default:
+                    LOG.warn("Unhandled {} value \"{}\", assuming disabled", propName, propValue);
+            }
+
+            // RFC8040 specification: 409 Conflict
+            return 409;
+        }
     }
 
     private final ErrorType errorType;