Split Restconf implementations (draft02 and RFC) - Rfc8040 04/62704/10
authorJakub Toth <jakub.toth@pantheon.tech>
Tue, 5 Sep 2017 14:31:10 +0000 (16:31 +0200)
committerJakub Toth <jakub.toth@pantheon.tech>
Wed, 13 Sep 2017 09:54:06 +0000 (11:54 +0200)
  *move Rfc8040 to the new module restconf-nb-rfc8040

Change-Id: Ica52f23791e8326f20f8449d0e39273b7db8f5c5
Signed-off-by: Jakub Toth <jakub.toth@pantheon.tech>
restconf/restconf-common-models/pom.xml
restconf/restconf-nb-bierman02/src/main/java/org/opendaylight/restconf/Rfc8040.java
restconf/restconf-nb-rfc8040/pom.xml
restconf/restconf-nb-rfc8040/src/main/java/org/opendaylight/restconf/nb/rfc8040/Rfc8040.java [new file with mode: 0644]

index 54fddc8a2fd1e6f64b0b0f5185d254ba1eb045d8..44c6243c7c7d3af4e92616971db7f58ee5251b53 100644 (file)
@@ -6,7 +6,9 @@
   ~ and is available at http://www.eclipse.org/legal/epl-v10.html
   -->
 
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
   <modelVersion>4.0.0</modelVersion>
 
   <parent>
index f5942267c38519cb8246477a1ead67d3a3b4fa73..76c03b39723a6b58ce1dff8fc56b90120f6fbc78 100644 (file)
@@ -24,7 +24,10 @@ import org.opendaylight.yangtools.yang.common.SimpleDateFormatUtil;
  * <li>{@link MonitoringModule}
  * </ul>
  * </ul>
+ *
+ * @deprecated move to splitted module restconf-nb-rfc8040
  */
+@Deprecated
 public final class Rfc8040 {
 
     private Rfc8040() {
index 3752e0b21cdeab9486e088a090a590731daaa8c6..35543172f60b9669029358044d9d2f44c09fa596 100644 (file)
   <artifactId>restconf-nb-rfc8040</artifactId>
   <version>1.7.0-SNAPSHOT</version>
   <packaging>bundle</packaging>
+
+  <dependencies>
+    <dependency>
+      <groupId>org.opendaylight.netconf</groupId>
+      <artifactId>restconf-common-models</artifactId>
+      <version>${project.version}</version>
+    </dependency>
+
+    <dependency>
+      <groupId>org.opendaylight.yangtools</groupId>
+      <artifactId>yang-data-api</artifactId>
+    </dependency>
+
+    <dependency>
+      <groupId>org.jboss.resteasy</groupId>
+      <artifactId>jaxrs-api</artifactId>
+      <scope>provided</scope>
+    </dependency>
+  </dependencies>
 </project>
diff --git a/restconf/restconf-nb-rfc8040/src/main/java/org/opendaylight/restconf/nb/rfc8040/Rfc8040.java b/restconf/restconf-nb-rfc8040/src/main/java/org/opendaylight/restconf/nb/rfc8040/Rfc8040.java
new file mode 100644 (file)
index 0000000..8c6d2ca
--- /dev/null
@@ -0,0 +1,275 @@
+/*
+ * Copyright (c) 2016 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.restconf.nb.rfc8040;
+
+import java.net.URI;
+import java.text.ParseException;
+import java.util.Date;
+import org.opendaylight.yangtools.yang.common.QName;
+import org.opendaylight.yangtools.yang.common.QNameModule;
+import org.opendaylight.yangtools.yang.common.SimpleDateFormatUtil;
+
+/**
+ * Base Draft for Restconf project.
+ * <ul>
+ * <li>Supported {@link MediaTypes}
+ * <li>Constants for modules
+ * <ul>
+ * <li>{@link RestconfModule}
+ * <li>{@link MonitoringModule}
+ * </ul>
+ * </ul>
+ */
+public final class Rfc8040 {
+
+    private Rfc8040() {
+        throw new UnsupportedOperationException("Util class");
+    }
+
+    /**
+     * Set of application specific media types to identify each of the available
+     * resource types.
+     */
+    public static final class MediaTypes {
+
+        private MediaTypes() {
+            throw new UnsupportedOperationException("Util class");
+        }
+
+        public static final String DATA = "application/yang-data";
+        public static final String PATCH = "application/yang.patch";
+        public static final String PATCH_STATUS = "application/yang.patch-status";
+        public static final String YIN = "application/yin";
+        public static final String YANG = "application/yang";
+    }
+
+    /**
+     * Constants for restconf module.
+     *
+     */
+    public static final class RestconfModule {
+        private RestconfModule() {
+            throw new UnsupportedOperationException("Util class");
+        }
+
+        public static final String REVISION = "2017-01-26";
+        public static final String NAME = "ietf-restconf";
+        public static final String NAMESPACE = "urn:ietf:params:xml:ns:yang:ietf-restconf";
+
+        public static final QName IETF_RESTCONF_QNAME = QName.create(Rfc8040.RestconfModule.NAMESPACE,
+                Rfc8040.RestconfModule.REVISION, Rfc8040.RestconfModule.NAME).intern();
+
+        public static final Date DATE;
+
+        static {
+            try {
+                DATE = SimpleDateFormatUtil.getRevisionFormat().parse(REVISION);
+            } catch (final ParseException e) {
+                throw new ExceptionInInitializerError(e);
+            }
+        }
+
+        public static final URI URI_MODULE = URI.create(NAMESPACE);
+
+        // RESTCONF
+        public static final String RESTCONF_GROUPING_SCHEMA_NODE = "restconf";
+        public static final String RESTCONF_CONTAINER_SCHEMA_NODE = "restconf";
+        public static final String OPERATIONS_CONTAINER_SCHEMA_NODE = "operations";
+        public static final String DATA_CONTAINER_SCHEMA_NODE = "data";
+        public static final String LIB_VER_LEAF_SCHEMA_NODE = "yang-library-version";
+
+        public static final QName RESTCONF_GROUPING_QNAME =
+                QName.create(IETF_RESTCONF_QNAME, RESTCONF_GROUPING_SCHEMA_NODE).intern();
+        public static final QName RESTCONF_CONTAINER_QNAME =
+                QName.create(IETF_RESTCONF_QNAME, RESTCONF_CONTAINER_SCHEMA_NODE).intern();
+        public static final QName LIB_VER_LEAF_QNAME = QName.create(IETF_RESTCONF_QNAME, LIB_VER_LEAF_SCHEMA_NODE)
+                .intern();
+
+        // ERRORS
+        public static final String ERRORS_GROUPING_SCHEMA_NODE = "errors";
+        public static final String ERRORS_CONTAINER_SCHEMA_NODE = "errors";
+        public static final String ERROR_LIST_SCHEMA_NODE = "error";
+
+        public static final QName ERRORS_CONTAINER_QNAME =
+                QName.create(IETF_RESTCONF_QNAME, ERRORS_CONTAINER_SCHEMA_NODE);
+        public static final QName ERROR_LIST_QNAME = QName.create(IETF_RESTCONF_QNAME, ERROR_LIST_SCHEMA_NODE).intern();
+        public static final QName ERROR_TYPE_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-type").intern();
+        public static final QName ERROR_TAG_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-tag".intern());
+        public static final QName ERROR_APP_TAG_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-app-tag").intern();
+        public static final QName ERROR_MESSAGE_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-message").intern();
+        public static final QName ERROR_INFO_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-info").intern();
+        public static final QName ERROR_PATH_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-path").intern();
+    }
+
+    /**
+     * Constants for ietf-yang-library model.
+     *
+     */
+    public static final class IetfYangLibrary {
+        private IetfYangLibrary() {
+            throw new UnsupportedOperationException("Util class");
+        }
+
+        public static final String NAME = "ietf-yang-library";
+        public static final String NAMESPACE = "urn:ietf:params:xml:ns:yang:ietf-yang-library";
+        public static final String REVISION = "2016-06-21";
+
+        public static final Date DATE;
+
+        static {
+            try {
+                DATE = SimpleDateFormatUtil.getRevisionFormat().parse(REVISION);
+            } catch (final ParseException e) {
+                throw new ExceptionInInitializerError(e);
+            }
+        }
+
+        public static final URI URI_MODULE = URI.create(NAMESPACE);
+
+        public static final QNameModule MODULE_QNAME = QNameModule.create(URI_MODULE, DATE).intern();
+
+        public static final String MODULE_SET_ID_LEAF = "module-set-id";
+        public static final QName MODULE_SET_ID_LEAF_QNAME = QName.create(MODULE_QNAME, MODULE_SET_ID_LEAF).intern();
+
+        public static final String GROUPING_MODULE_LIST = "module-list";
+        public static final QName GROUPING_MODULE_LIST_QNAME = QName.create(MODULE_QNAME, GROUPING_MODULE_LIST)
+                .intern();
+
+        public static final String MODULES_STATE_CONT = "modules-state";
+        public static final QName MODUELS_STATE_CONT_QNAME = QName.create(MODULE_QNAME, MODULES_STATE_CONT).intern();
+
+        public static final String MODULE_LIST = "module";
+        public static final QName MODULE_QNAME_LIST = QName.create(MODULE_QNAME, MODULE_LIST).intern();
+
+        public static final String SPECIFIC_MODULE_NAME_LEAF = "name";
+        public static final QName SPECIFIC_MODULE_NAME_LEAF_QNAME =
+                QName.create(MODULE_QNAME, SPECIFIC_MODULE_NAME_LEAF).intern();
+
+        public static final String SPECIFIC_MODULE_REVISION_LEAF = "revision";
+        public static final QName SPECIFIC_MODULE_REVISION_LEAF_QNAME =
+                QName.create(MODULE_QNAME, SPECIFIC_MODULE_REVISION_LEAF).intern();
+
+        public static final String BASE_URI_OF_SCHEMA = "/modules/";
+        public static final String SPECIFIC_MODULE_SCHEMA_LEAF = "schema";
+        public static final QName SPECIFIC_MODULE_SCHEMA_LEAF_QNAME =
+                QName.create(MODULE_QNAME, SPECIFIC_MODULE_SCHEMA_LEAF).intern();
+
+        public static final String SPECIFIC_MODULE_NAMESPACE_LEAF = "namespace";
+        public static final QName SPECIFIC_MODULE_NAMESPACE_LEAF_QNAME =
+                QName.create(MODULE_QNAME, SPECIFIC_MODULE_NAMESPACE_LEAF).intern();
+
+        public static final String SPECIFIC_MODULE_FEATURE_LEAF_LIST = "feature";
+        public static final QName SPECIFIC_MODULE_FEATURE_LEAF_LIST_QNAME =
+                QName.create(MODULE_QNAME, SPECIFIC_MODULE_FEATURE_LEAF_LIST).intern();
+
+        public static final String SPECIFIC_MODULE_DEVIATION_LIST = "deviation";
+        public static final QName SPECIFIC_MODULE_DEVIATION_LIST_QNAME =
+                QName.create(MODULE_QNAME, SPECIFIC_MODULE_DEVIATION_LIST).intern();
+
+        public static final String SPECIFIC_MODULE_CONFORMANCE_LEAF = "conformance-type";
+        public static final QName SPECIFIC_MODULE_CONFORMANCE_LEAF_QNAME =
+                QName.create(MODULE_QNAME, SPECIFIC_MODULE_CONFORMANCE_LEAF).intern();
+
+        public static final String SPECIFIC_MODULE_SUBMODULE_LIST = "submodule";
+        public static final QName SPECIFIC_MODULE_SUBMODULE_LIST_QNAME =
+                QName.create(MODULE_QNAME, SPECIFIC_MODULE_SUBMODULE_LIST).intern();
+    }
+
+    /**
+     * Constants for ietf-restconf-monitoring module.
+     *
+     */
+    public static final class MonitoringModule {
+
+        private MonitoringModule() {
+            throw new UnsupportedOperationException("Util class");
+        }
+
+        public static final String NAME = "ietf-restconf-monitoring";
+        public static final String NAMESPACE = "urn:ietf:params:xml:ns:yang:ietf-restconf-monitoring";
+        public static final String REVISION = "2017-01-26";
+        public static final String PATH_TO_STREAM_WITHOUT_KEY =
+                "ietf-restconf-monitoring:restconf-state/streams/stream=";
+        public static final String PATH_TO_STREAMS = "ietf-restconf-monitoring:restconf-state/streams";
+
+        public static final Date DATE;
+
+        static {
+            try {
+                DATE = SimpleDateFormatUtil.getRevisionFormat().parse(REVISION);
+            } catch (final ParseException e) {
+                throw new ExceptionInInitializerError(e);
+            }
+        }
+
+        public static final URI URI_MODULE = URI.create(NAMESPACE);
+
+        public static final QNameModule MODULE_QNAME = QNameModule.create(URI_MODULE, DATE).intern();
+
+        public static final String CONT_RESTCONF_STATE_NAME = "restconf-state";
+        public static final QName CONT_RESTCONF_STATE_QNAME = QName.create(MODULE_QNAME, CONT_RESTCONF_STATE_NAME)
+                .intern();
+
+        public static final String CONT_CAPABILITIES_NAME = "capabilities";
+        public static final QName CONT_CAPABILITES_QNAME = QName.create(MODULE_QNAME, CONT_CAPABILITIES_NAME).intern();
+
+        public static final String LEAF_LIST_CAPABILITY_NAME = "capability";
+        public static final QName LEAF_LIST_CAPABILITY_QNAME = QName.create(MODULE_QNAME, LEAF_LIST_CAPABILITY_NAME)
+                .intern();
+
+        public static final String CONT_STREAMS_NAME = "streams";
+        public static final QName CONT_STREAMS_QNAME = QName.create(MODULE_QNAME, CONT_STREAMS_NAME).intern();
+
+        public static final String LIST_STREAM_NAME = "stream";
+        public static final QName LIST_STREAM_QNAME = QName.create(MODULE_QNAME, LIST_STREAM_NAME).intern();
+
+        public static final String LEAF_NAME_STREAM_NAME = "name";
+        public static final QName LEAF_NAME_STREAM_QNAME = QName.create(MODULE_QNAME, LEAF_NAME_STREAM_NAME).intern();
+
+        public static final String LEAF_DESCR_STREAM_NAME = "description";
+        public static final QName LEAF_DESCR_STREAM_QNAME = QName.create(MODULE_QNAME, LEAF_DESCR_STREAM_NAME).intern();
+
+        public static final String LEAF_REPLAY_SUPP_STREAM_NAME = "replay-support";
+        public static final QName LEAF_REPLAY_SUPP_STREAM_QNAME =
+                QName.create(MODULE_QNAME, LEAF_REPLAY_SUPP_STREAM_NAME).intern();
+
+        public static final String LEAF_START_TIME_STREAM_NAME = "replay-log-creation-time";
+        public static final QName LEAF_START_TIME_STREAM_QNAME =
+                QName.create(MODULE_QNAME, LEAF_START_TIME_STREAM_NAME).intern();
+
+        public static final String LIST_ACCESS_STREAM_NAME = "access";
+        public static final QName LIST_ACCESS_STREAM_QNAME = QName.create(MODULE_QNAME, LIST_ACCESS_STREAM_NAME)
+                .intern();
+
+        public static final String LEAF_ENCODING_ACCESS_NAME = "encoding";
+        public static final QName LEAF_ENCODING_ACCESS_QNAME = QName.create(MODULE_QNAME, LEAF_ENCODING_ACCESS_NAME)
+                .intern();
+
+        public static final String LEAF_LOCATION_ACCESS_NAME = "location";
+        public static final QName LEAF_LOCATION_ACCESS_QNAME = QName.create(MODULE_QNAME, LEAF_LOCATION_ACCESS_NAME)
+                .intern();
+
+        /**
+         * Constants for capabilities.
+         */
+        public static final class QueryParams {
+
+            private QueryParams() {
+                throw new UnsupportedOperationException("Util class");
+            }
+
+            public static final String URI_BASE = "urn:ietf:params:restconf:capability:";
+
+            public static final String DEPTH = URI_BASE + "depth:1.0";
+            public static final String FIELDS = URI_BASE + "fields:1.0";
+            public static final String FILTER = URI_BASE + "filter:1.0";
+            public static final String REPLAY = URI_BASE + "replay:1.0";
+            public static final String WITH_DEFAULTS = URI_BASE + "with-defaults:1.0";
+        }
+    }
+}