restconf/restconf-nb-rfc8040/src/main/java/org/opendaylight/restconf/nb/rfc8040/Rfc8040.java

   1 /*
   2  * Copyright (c) 2016 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.restconf.nb.rfc8040;
   9
  10 import java.net.URI;
  11 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev190104.$YangModuleInfoImpl;
  12 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev190104.module.list.Module;
  13 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev190104.module.list.module.Deviation;
  14 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev190104.module.list.module.Submodule;
  15 import org.opendaylight.yangtools.yang.common.QName;
  16 import org.opendaylight.yangtools.yang.common.QNameModule;
  17 import org.opendaylight.yangtools.yang.common.Revision;
  18
  19 /**
  20  * Base Draft for Restconf project.
  21  * <ul>
  22  * <li>Supported {@link MediaTypes}
  23  * <li>Constants for modules
  24  * <ul>
  25  * <li>{@link RestconfModule}
  26  * <li>{@link MonitoringModule}
  27  * </ul>
  28  * </ul>
  29  */
  30 public final class Rfc8040 {
  31
  32     private Rfc8040() {
  33         throw new UnsupportedOperationException("Util class");
  34     }
  35
  36     /**
  37      * Set of application specific media types to identify each of the available
  38      * resource types.
  39      */
  40     public static final class MediaTypes {
  41
  42         private MediaTypes() {
  43             throw new UnsupportedOperationException("Util class");
  44         }
  45
  46         /**
  47          * See: <a href="https://tools.ietf.org/html/rfc6415">rfc6415</a>.
  48          */
  49         public static final String XRD = "application/xrd";
  50
  51         public static final String DATA = "application/yang-data";
  52         // up to and including draft-ietf-netconf-yang-patch-08
  53         public static final String YANG_PATCH = "application/yang.patch";
  54         public static final String YANG_PATCH_STATUS = "application/yang.patch-status";
  55
  56         // since draft-ietf-netconf-yang-patch-09
  57         public static final String YANG_PATCH_RFC8072 = "application/yang-patch";
  58     }
  59
  60     /**
  61      * Constants for restconf module.
  62      *
  63      */
  64     public static final class RestconfModule {
  65         private RestconfModule() {
  66             throw new UnsupportedOperationException("Util class");
  67         }
  68
  69         public static final Revision REVISION = Revision.of("2017-01-26");
  70         public static final String NAME = "ietf-restconf";
  71         public static final String NAMESPACE = "urn:ietf:params:xml:ns:yang:ietf-restconf";
  72         public static final URI URI_MODULE = URI.create(NAMESPACE);
  73
  74         public static final QName IETF_RESTCONF_QNAME = QName.create(URI_MODULE,
  75                 Rfc8040.RestconfModule.REVISION, Rfc8040.RestconfModule.NAME).intern();
  76
  77         // RESTCONF
  78         public static final String RESTCONF_GROUPING_SCHEMA_NODE = "restconf";
  79         public static final String RESTCONF_CONTAINER_SCHEMA_NODE = "restconf";
  80         public static final String OPERATIONS_CONTAINER_SCHEMA_NODE = "operations";
  81         public static final String DATA_CONTAINER_SCHEMA_NODE = "data";
  82         public static final String LIB_VER_LEAF_SCHEMA_NODE = "yang-library-version";
  83
  84         public static final QName RESTCONF_GROUPING_QNAME =
  85                 QName.create(IETF_RESTCONF_QNAME, RESTCONF_GROUPING_SCHEMA_NODE).intern();
  86         public static final QName RESTCONF_CONTAINER_QNAME =
  87                 QName.create(IETF_RESTCONF_QNAME, RESTCONF_CONTAINER_SCHEMA_NODE).intern();
  88         public static final QName LIB_VER_LEAF_QNAME = QName.create(IETF_RESTCONF_QNAME, LIB_VER_LEAF_SCHEMA_NODE)
  89                 .intern();
  90
  91         // ERRORS
  92         public static final String ERRORS_GROUPING_SCHEMA_NODE = "errors";
  93         public static final String ERRORS_CONTAINER_SCHEMA_NODE = "errors";
  94         public static final String ERROR_LIST_SCHEMA_NODE = "error";
  95
  96         public static final QName ERRORS_GROUPING_QNAME =
  97                 QName.create(IETF_RESTCONF_QNAME, ERRORS_GROUPING_SCHEMA_NODE).intern();
  98         public static final QName ERRORS_CONTAINER_QNAME =
  99                 QName.create(IETF_RESTCONF_QNAME, ERRORS_CONTAINER_SCHEMA_NODE).intern();
 100         public static final QName ERROR_LIST_QNAME = QName.create(IETF_RESTCONF_QNAME, ERROR_LIST_SCHEMA_NODE).intern();
 101         public static final QName ERROR_TYPE_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-type").intern();
 102         public static final QName ERROR_TAG_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-tag").intern();
 103         public static final QName ERROR_APP_TAG_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-app-tag").intern();
 104         public static final QName ERROR_MESSAGE_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-message").intern();
 105         public static final QName ERROR_INFO_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-info").intern();
 106         public static final QName ERROR_PATH_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-path").intern();
 107     }
 108
 109     /**
 110      * Constants for ietf-yang-library model.
 111      *
 112      */
 113     public static final class IetfYangLibrary {
 114         private IetfYangLibrary() {
 115             throw new UnsupportedOperationException("Util class");
 116         }
 117
 118         public static final QNameModule MODULE_QNAME = $YangModuleInfoImpl.getInstance().getName().getModule();
 119         public static final Revision REVISION = MODULE_QNAME.getRevision().orElseThrow();
 120
 121         public static final QName MODULE_SET_ID_LEAF_QNAME = QName.create(MODULE_QNAME, "module-set-id").intern();
 122
 123         public static final QName MODULE_QNAME_LIST = Module.QNAME;
 124
 125         public static final String SPECIFIC_MODULE_NAME_LEAF = "name";
 126         public static final QName SPECIFIC_MODULE_NAME_LEAF_QNAME =
 127                 QName.create(MODULE_QNAME, SPECIFIC_MODULE_NAME_LEAF).intern();
 128
 129         public static final String SPECIFIC_MODULE_REVISION_LEAF = "revision";
 130         public static final QName SPECIFIC_MODULE_REVISION_LEAF_QNAME =
 131                 QName.create(MODULE_QNAME, SPECIFIC_MODULE_REVISION_LEAF).intern();
 132
 133         public static final String BASE_URI_OF_SCHEMA = "/modules/";
 134         public static final QName SPECIFIC_MODULE_SCHEMA_LEAF_QNAME = QName.create(MODULE_QNAME, "schema").intern();
 135         public static final QName SPECIFIC_MODULE_NAMESPACE_LEAF_QNAME =
 136                 QName.create(MODULE_QNAME, "namespace").intern();
 137
 138         public static final QName SPECIFIC_MODULE_FEATURE_LEAF_LIST_QNAME =
 139                 QName.create(MODULE_QNAME, "feature").intern();
 140
 141         public static final QName SPECIFIC_MODULE_DEVIATION_LIST_QNAME = Deviation.QNAME;
 142
 143         public static final QName SPECIFIC_MODULE_CONFORMANCE_LEAF_QNAME =
 144                 QName.create(MODULE_QNAME, "conformance-type").intern();
 145
 146         public static final QName SPECIFIC_MODULE_SUBMODULE_LIST_QNAME = Submodule.QNAME;
 147     }
 148
 149     /**
 150      * Constants for ietf-restconf-monitoring module.
 151      *
 152      */
 153     public static final class MonitoringModule {
 154
 155         private MonitoringModule() {
 156             throw new UnsupportedOperationException("Util class");
 157         }
 158
 159         public static final String NAME = "ietf-restconf-monitoring";
 160         public static final String NAMESPACE = "urn:ietf:params:xml:ns:yang:ietf-restconf-monitoring";
 161         public static final Revision REVISION = Revision.of("2017-01-26");
 162         public static final String PATH_TO_STREAM_WITHOUT_KEY =
 163                 "ietf-restconf-monitoring:restconf-state/streams/stream=";
 164         public static final String PATH_TO_STREAMS = "ietf-restconf-monitoring:restconf-state/streams";
 165
 166         public static final URI URI_MODULE = URI.create(NAMESPACE);
 167
 168         public static final QNameModule MODULE_QNAME = QNameModule.create(URI_MODULE, REVISION).intern();
 169
 170         public static final String CONT_RESTCONF_STATE_NAME = "restconf-state";
 171         public static final QName CONT_RESTCONF_STATE_QNAME = QName.create(MODULE_QNAME, CONT_RESTCONF_STATE_NAME)
 172                 .intern();
 173
 174         public static final String CONT_CAPABILITIES_NAME = "capabilities";
 175         public static final QName CONT_CAPABILITES_QNAME = QName.create(MODULE_QNAME, CONT_CAPABILITIES_NAME).intern();
 176
 177         public static final String LEAF_LIST_CAPABILITY_NAME = "capability";
 178         public static final QName LEAF_LIST_CAPABILITY_QNAME = QName.create(MODULE_QNAME, LEAF_LIST_CAPABILITY_NAME)
 179                 .intern();
 180
 181         public static final String CONT_STREAMS_NAME = "streams";
 182         public static final QName CONT_STREAMS_QNAME = QName.create(MODULE_QNAME, CONT_STREAMS_NAME).intern();
 183
 184         public static final String LIST_STREAM_NAME = "stream";
 185         public static final QName LIST_STREAM_QNAME = QName.create(MODULE_QNAME, LIST_STREAM_NAME).intern();
 186
 187         public static final String LEAF_NAME_STREAM_NAME = "name";
 188         public static final QName LEAF_NAME_STREAM_QNAME = QName.create(MODULE_QNAME, LEAF_NAME_STREAM_NAME).intern();
 189
 190         public static final String LEAF_DESCR_STREAM_NAME = "description";
 191         public static final QName LEAF_DESCR_STREAM_QNAME = QName.create(MODULE_QNAME, LEAF_DESCR_STREAM_NAME).intern();
 192
 193         public static final String LEAF_REPLAY_SUPP_STREAM_NAME = "replay-support";
 194         public static final QName LEAF_REPLAY_SUPP_STREAM_QNAME =
 195                 QName.create(MODULE_QNAME, LEAF_REPLAY_SUPP_STREAM_NAME).intern();
 196
 197         public static final String LEAF_START_TIME_STREAM_NAME = "replay-log-creation-time";
 198         public static final QName LEAF_START_TIME_STREAM_QNAME =
 199                 QName.create(MODULE_QNAME, LEAF_START_TIME_STREAM_NAME).intern();
 200
 201         public static final String LIST_ACCESS_STREAM_NAME = "access";
 202         public static final QName LIST_ACCESS_STREAM_QNAME = QName.create(MODULE_QNAME, LIST_ACCESS_STREAM_NAME)
 203                 .intern();
 204
 205         public static final String LEAF_ENCODING_ACCESS_NAME = "encoding";
 206         public static final QName LEAF_ENCODING_ACCESS_QNAME = QName.create(MODULE_QNAME, LEAF_ENCODING_ACCESS_NAME)
 207                 .intern();
 208
 209         public static final String LEAF_LOCATION_ACCESS_NAME = "location";
 210         public static final QName LEAF_LOCATION_ACCESS_QNAME = QName.create(MODULE_QNAME, LEAF_LOCATION_ACCESS_NAME)
 211                 .intern();
 212
 213         /**
 214          * Constants for capabilities.
 215          */
 216         public static final class QueryParams {
 217
 218             private QueryParams() {
 219                 throw new UnsupportedOperationException("Util class");
 220             }
 221
 222             public static final String URI_BASE = "urn:ietf:params:restconf:capability:";
 223
 224             public static final String DEPTH = URI_BASE + "depth:1.0";
 225             public static final String FIELDS = URI_BASE + "fields:1.0";
 226             public static final String FILTER = URI_BASE + "filter:1.0";
 227             public static final String REPLAY = URI_BASE + "replay:1.0";
 228             public static final String WITH_DEFAULTS = URI_BASE + "with-defaults:1.0";
 229         }
 230     }
 231 }