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.yangtools.yang.common.QName;
  12 import org.opendaylight.yangtools.yang.common.QNameModule;
  13 import org.opendaylight.yangtools.yang.common.Revision;
  14
  15 /**
  16  * Base Draft for Restconf project.
  17  * <ul>
  18  * <li>Supported {@link MediaTypes}
  19  * <li>Constants for modules
  20  * <ul>
  21  * <li>{@link RestconfModule}
  22  * <li>{@link MonitoringModule}
  23  * </ul>
  24  * </ul>
  25  */
  26 public final class Rfc8040 {
  27
  28     private Rfc8040() {
  29         throw new UnsupportedOperationException("Util class");
  30     }
  31
  32     /**
  33      * Set of application specific media types to identify each of the available
  34      * resource types.
  35      */
  36     public static final class MediaTypes {
  37
  38         private MediaTypes() {
  39             throw new UnsupportedOperationException("Util class");
  40         }
  41
  42         public static final String DATA = "application/yang-data";
  43         public static final String PATCH = "application/yang.patch";
  44         public static final String PATCH_STATUS = "application/yang.patch-status";
  45         public static final String YIN = "application/yin";
  46         public static final String YANG = "application/yang";
  47     }
  48
  49     /**
  50      * Constants for restconf module.
  51      *
  52      */
  53     public static final class RestconfModule {
  54         private RestconfModule() {
  55             throw new UnsupportedOperationException("Util class");
  56         }
  57
  58         public static final Revision REVISION = Revision.of("2017-01-26");
  59         public static final String NAME = "ietf-restconf";
  60         public static final String NAMESPACE = "urn:ietf:params:xml:ns:yang:ietf-restconf";
  61         public static final URI URI_MODULE = URI.create(NAMESPACE);
  62
  63         public static final QName IETF_RESTCONF_QNAME = QName.create(URI_MODULE,
  64                 Rfc8040.RestconfModule.REVISION, Rfc8040.RestconfModule.NAME).intern();
  65
  66         // RESTCONF
  67         public static final String RESTCONF_GROUPING_SCHEMA_NODE = "restconf";
  68         public static final String RESTCONF_CONTAINER_SCHEMA_NODE = "restconf";
  69         public static final String OPERATIONS_CONTAINER_SCHEMA_NODE = "operations";
  70         public static final String DATA_CONTAINER_SCHEMA_NODE = "data";
  71         public static final String LIB_VER_LEAF_SCHEMA_NODE = "yang-library-version";
  72
  73         public static final QName RESTCONF_GROUPING_QNAME =
  74                 QName.create(IETF_RESTCONF_QNAME, RESTCONF_GROUPING_SCHEMA_NODE).intern();
  75         public static final QName RESTCONF_CONTAINER_QNAME =
  76                 QName.create(IETF_RESTCONF_QNAME, RESTCONF_CONTAINER_SCHEMA_NODE).intern();
  77         public static final QName LIB_VER_LEAF_QNAME = QName.create(IETF_RESTCONF_QNAME, LIB_VER_LEAF_SCHEMA_NODE)
  78                 .intern();
  79
  80         // ERRORS
  81         public static final String ERRORS_GROUPING_SCHEMA_NODE = "errors";
  82         public static final String ERRORS_CONTAINER_SCHEMA_NODE = "errors";
  83         public static final String ERROR_LIST_SCHEMA_NODE = "error";
  84
  85         public static final QName ERRORS_CONTAINER_QNAME =
  86                 QName.create(IETF_RESTCONF_QNAME, ERRORS_CONTAINER_SCHEMA_NODE);
  87         public static final QName ERROR_LIST_QNAME = QName.create(IETF_RESTCONF_QNAME, ERROR_LIST_SCHEMA_NODE).intern();
  88         public static final QName ERROR_TYPE_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-type").intern();
  89         public static final QName ERROR_TAG_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-tag".intern());
  90         public static final QName ERROR_APP_TAG_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-app-tag").intern();
  91         public static final QName ERROR_MESSAGE_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-message").intern();
  92         public static final QName ERROR_INFO_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-info").intern();
  93         public static final QName ERROR_PATH_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-path").intern();
  94     }
  95
  96     /**
  97      * Constants for ietf-yang-library model.
  98      *
  99      */
 100     public static final class IetfYangLibrary {
 101         private IetfYangLibrary() {
 102             throw new UnsupportedOperationException("Util class");
 103         }
 104
 105         public static final String NAME = "ietf-yang-library";
 106         public static final String NAMESPACE = "urn:ietf:params:xml:ns:yang:ietf-yang-library";
 107         public static final URI URI_MODULE = URI.create(NAMESPACE);
 108         public static final Revision REVISION =  Revision.of("2016-06-21");
 109
 110         public static final QNameModule MODULE_QNAME = QNameModule.create(URI_MODULE, REVISION).intern();
 111
 112         public static final String MODULE_SET_ID_LEAF = "module-set-id";
 113         public static final QName MODULE_SET_ID_LEAF_QNAME = QName.create(MODULE_QNAME, MODULE_SET_ID_LEAF).intern();
 114
 115         public static final String GROUPING_MODULE_LIST = "module-list";
 116         public static final QName GROUPING_MODULE_LIST_QNAME = QName.create(MODULE_QNAME, GROUPING_MODULE_LIST)
 117                 .intern();
 118
 119         public static final String MODULES_STATE_CONT = "modules-state";
 120         public static final QName MODUELS_STATE_CONT_QNAME = QName.create(MODULE_QNAME, MODULES_STATE_CONT).intern();
 121
 122         public static final String MODULE_LIST = "module";
 123         public static final QName MODULE_QNAME_LIST = QName.create(MODULE_QNAME, MODULE_LIST).intern();
 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 String SPECIFIC_MODULE_SCHEMA_LEAF = "schema";
 135         public static final QName SPECIFIC_MODULE_SCHEMA_LEAF_QNAME =
 136                 QName.create(MODULE_QNAME, SPECIFIC_MODULE_SCHEMA_LEAF).intern();
 137
 138         public static final String SPECIFIC_MODULE_NAMESPACE_LEAF = "namespace";
 139         public static final QName SPECIFIC_MODULE_NAMESPACE_LEAF_QNAME =
 140                 QName.create(MODULE_QNAME, SPECIFIC_MODULE_NAMESPACE_LEAF).intern();
 141
 142         public static final String SPECIFIC_MODULE_FEATURE_LEAF_LIST = "feature";
 143         public static final QName SPECIFIC_MODULE_FEATURE_LEAF_LIST_QNAME =
 144                 QName.create(MODULE_QNAME, SPECIFIC_MODULE_FEATURE_LEAF_LIST).intern();
 145
 146         public static final String SPECIFIC_MODULE_DEVIATION_LIST = "deviation";
 147         public static final QName SPECIFIC_MODULE_DEVIATION_LIST_QNAME =
 148                 QName.create(MODULE_QNAME, SPECIFIC_MODULE_DEVIATION_LIST).intern();
 149
 150         public static final String SPECIFIC_MODULE_CONFORMANCE_LEAF = "conformance-type";
 151         public static final QName SPECIFIC_MODULE_CONFORMANCE_LEAF_QNAME =
 152                 QName.create(MODULE_QNAME, SPECIFIC_MODULE_CONFORMANCE_LEAF).intern();
 153
 154         public static final String SPECIFIC_MODULE_SUBMODULE_LIST = "submodule";
 155         public static final QName SPECIFIC_MODULE_SUBMODULE_LIST_QNAME =
 156                 QName.create(MODULE_QNAME, SPECIFIC_MODULE_SUBMODULE_LIST).intern();
 157     }
 158
 159     /**
 160      * Constants for ietf-restconf-monitoring module.
 161      *
 162      */
 163     public static final class MonitoringModule {
 164
 165         private MonitoringModule() {
 166             throw new UnsupportedOperationException("Util class");
 167         }
 168
 169         public static final String NAME = "ietf-restconf-monitoring";
 170         public static final String NAMESPACE = "urn:ietf:params:xml:ns:yang:ietf-restconf-monitoring";
 171         public static final Revision REVISION = Revision.of("2017-01-26");
 172         public static final String PATH_TO_STREAM_WITHOUT_KEY =
 173                 "ietf-restconf-monitoring:restconf-state/streams/stream=";
 174         public static final String PATH_TO_STREAMS = "ietf-restconf-monitoring:restconf-state/streams";
 175
 176         public static final URI URI_MODULE = URI.create(NAMESPACE);
 177
 178         public static final QNameModule MODULE_QNAME = QNameModule.create(URI_MODULE, REVISION).intern();
 179
 180         public static final String CONT_RESTCONF_STATE_NAME = "restconf-state";
 181         public static final QName CONT_RESTCONF_STATE_QNAME = QName.create(MODULE_QNAME, CONT_RESTCONF_STATE_NAME)
 182                 .intern();
 183
 184         public static final String CONT_CAPABILITIES_NAME = "capabilities";
 185         public static final QName CONT_CAPABILITES_QNAME = QName.create(MODULE_QNAME, CONT_CAPABILITIES_NAME).intern();
 186
 187         public static final String LEAF_LIST_CAPABILITY_NAME = "capability";
 188         public static final QName LEAF_LIST_CAPABILITY_QNAME = QName.create(MODULE_QNAME, LEAF_LIST_CAPABILITY_NAME)
 189                 .intern();
 190
 191         public static final String CONT_STREAMS_NAME = "streams";
 192         public static final QName CONT_STREAMS_QNAME = QName.create(MODULE_QNAME, CONT_STREAMS_NAME).intern();
 193
 194         public static final String LIST_STREAM_NAME = "stream";
 195         public static final QName LIST_STREAM_QNAME = QName.create(MODULE_QNAME, LIST_STREAM_NAME).intern();
 196
 197         public static final String LEAF_NAME_STREAM_NAME = "name";
 198         public static final QName LEAF_NAME_STREAM_QNAME = QName.create(MODULE_QNAME, LEAF_NAME_STREAM_NAME).intern();
 199
 200         public static final String LEAF_DESCR_STREAM_NAME = "description";
 201         public static final QName LEAF_DESCR_STREAM_QNAME = QName.create(MODULE_QNAME, LEAF_DESCR_STREAM_NAME).intern();
 202
 203         public static final String LEAF_REPLAY_SUPP_STREAM_NAME = "replay-support";
 204         public static final QName LEAF_REPLAY_SUPP_STREAM_QNAME =
 205                 QName.create(MODULE_QNAME, LEAF_REPLAY_SUPP_STREAM_NAME).intern();
 206
 207         public static final String LEAF_START_TIME_STREAM_NAME = "replay-log-creation-time";
 208         public static final QName LEAF_START_TIME_STREAM_QNAME =
 209                 QName.create(MODULE_QNAME, LEAF_START_TIME_STREAM_NAME).intern();
 210
 211         public static final String LIST_ACCESS_STREAM_NAME = "access";
 212         public static final QName LIST_ACCESS_STREAM_QNAME = QName.create(MODULE_QNAME, LIST_ACCESS_STREAM_NAME)
 213                 .intern();
 214
 215         public static final String LEAF_ENCODING_ACCESS_NAME = "encoding";
 216         public static final QName LEAF_ENCODING_ACCESS_QNAME = QName.create(MODULE_QNAME, LEAF_ENCODING_ACCESS_NAME)
 217                 .intern();
 218
 219         public static final String LEAF_LOCATION_ACCESS_NAME = "location";
 220         public static final QName LEAF_LOCATION_ACCESS_QNAME = QName.create(MODULE_QNAME, LEAF_LOCATION_ACCESS_NAME)
 221                 .intern();
 222
 223         /**
 224          * Constants for capabilities.
 225          */
 226         public static final class QueryParams {
 227
 228             private QueryParams() {
 229                 throw new UnsupportedOperationException("Util class");
 230             }
 231
 232             public static final String URI_BASE = "urn:ietf:params:restconf:capability:";
 233
 234             public static final String DEPTH = URI_BASE + "depth:1.0";
 235             public static final String FIELDS = URI_BASE + "fields:1.0";
 236             public static final String FILTER = URI_BASE + "filter:1.0";
 237             public static final String REPLAY = URI_BASE + "replay:1.0";
 238             public static final String WITH_DEFAULTS = URI_BASE + "with-defaults:1.0";
 239         }
 240     }
 241 }