restconf/sal-rest-connector/src/main/java/org/opendaylight/restconf/Draft18.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;
   9
  10 import java.net.URI;
  11 import java.net.URISyntaxException;
  12 import java.text.ParseException;
  13 import java.text.SimpleDateFormat;
  14 import java.util.Date;
  15 import org.opendaylight.yangtools.yang.common.QName;
  16 import org.opendaylight.yangtools.yang.common.QNameModule;
  17 import org.slf4j.Logger;
  18 import org.slf4j.LoggerFactory;
  19
  20 /**
  21  * Base Draft for Restconf project
  22  * <ul>
  23  * <li>Supported {@link MediaTypes}
  24  * <li>Constants for modules
  25  * <ul>
  26  * <li>{@link RestconfModule}
  27  * <li>{@link MonitoringModule}
  28  * </ul>
  29  * </ul>
  30  *
  31  * We used old revision {@link Draft18.RestconfModule#REVISION} of restconf yang
  32  * because the latest restconf draft has to be supported by Yang 1.1 and we are
  33  * not. Then, this is only partial implementation of the latest restconf draft.
  34  */
  35 public final class Draft18 {
  36
  37     private Draft18() {
  38         throw new UnsupportedOperationException("Util class");
  39     }
  40
  41     /**
  42      * Set of application specific media types to identify each of the available
  43      * resource types
  44      */
  45     public static final class MediaTypes {
  46
  47         private MediaTypes() {
  48             throw new UnsupportedOperationException("Util class");
  49         }
  50
  51         public static final String DATA = "application/yang-data";
  52         public static final String PATCH = "application/yang.patch";
  53         public static final String PATCH_STATUS = "application/yang.patch-status";
  54         public static final String YIN = "application/yin";
  55         public static final String YANG = "application/yang";
  56     }
  57
  58     /**
  59      * Constants for restconf module
  60      *
  61      */
  62     public static final class RestconfModule {
  63
  64         private RestconfModule() {
  65             throw new UnsupportedOperationException("Util class");
  66         }
  67
  68         public static final String REVISION = "2013-10-19";
  69
  70         public static final String NAME = "ietf-restconf";
  71
  72         public static final String NAMESPACE = "urn:ietf:params:xml:ns:yang:ietf-restconf";
  73
  74         public static final String RESTCONF_GROUPING_SCHEMA_NODE = "restconf";
  75
  76         public static final String RESTCONF_CONTAINER_SCHEMA_NODE = "restconf";
  77
  78         public static final String MODULES_CONTAINER_SCHEMA_NODE = "modules";
  79
  80         public static final String MODULE_LIST_SCHEMA_NODE = "module";
  81
  82         public static final String OPERATIONS_CONTAINER_SCHEMA_NODE = "operations";
  83
  84         public static final String ERRORS_GROUPING_SCHEMA_NODE = "errors";
  85
  86         public static final String ERRORS_CONTAINER_SCHEMA_NODE = "errors";
  87
  88         public static final String ERROR_LIST_SCHEMA_NODE = "error";
  89
  90         public static final QName IETF_RESTCONF_QNAME = QName.create(Draft18.RestconfModule.NAMESPACE, Draft18.RestconfModule.REVISION,
  91                 Draft18.RestconfModule.NAME);
  92
  93         public static final QName ERRORS_CONTAINER_QNAME = QName.create(IETF_RESTCONF_QNAME, ERRORS_CONTAINER_SCHEMA_NODE);
  94
  95         public static final QName ERROR_LIST_QNAME = QName.create(IETF_RESTCONF_QNAME, ERROR_LIST_SCHEMA_NODE);
  96
  97         public static final QName ERROR_TYPE_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-type");
  98
  99         public static final QName ERROR_TAG_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-tag");
 100
 101         public static final QName ERROR_APP_TAG_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-app-tag");
 102
 103         public static final QName ERROR_MESSAGE_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-message");
 104
 105         public static final QName ERROR_INFO_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-info");
 106
 107         public static final QName ERROR_PATH_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-path");
 108     }
 109
 110     /**
 111      * Constants for ietf-yang-library model
 112      *
 113      */
 114     public static final class IetfYangLibrary {
 115
 116         private static final Logger LOG = LoggerFactory.getLogger(IetfYangLibrary.class);
 117
 118         private IetfYangLibrary() {
 119             throw new UnsupportedOperationException("Util class");
 120         }
 121
 122         public static final String NAME = "ietf-yang-library";
 123         public static final String NAMESPACE = "urn:ietf:params:xml:ns:yang:ietf-yang-library";
 124         public static final String REVISION = "2016-06-21";
 125
 126         public static Date DATE = null;
 127         public static URI URI_MODULE = null;
 128
 129         static {
 130             try {
 131                 DATE = new SimpleDateFormat("yyyy-MM-dd").parse(REVISION);
 132                 URI_MODULE = new URI(NAMESPACE);
 133             } catch (final ParseException | URISyntaxException e) {
 134                 LOG.error(e.getMessage());
 135             }
 136         }
 137
 138         public static final QNameModule MODULE_QNAME = QNameModule.create(URI_MODULE, DATE);
 139
 140         public static final String MODULE_SET_ID_LEAF = "module-set-id";
 141         public static final QName MODULE_SET_ID_LEAF_QNAME = QName.create(MODULE_QNAME, MODULE_SET_ID_LEAF);
 142
 143         public static final String GROUPING_MODULE_LIST = "module-list";
 144         public static final QName GROUPING_MODULE_LIST_QNAME = QName.create(MODULE_QNAME, GROUPING_MODULE_LIST);
 145
 146         public static final String MODULES_STATE_CONT = "modules-state";
 147         public static final QName MODUELS_STATE_CONT_QNAME = QName.create(MODULE_QNAME, MODULES_STATE_CONT);
 148
 149         public static final String MODULE_LIST = "module";
 150         public static final QName MODULE_QNAME_LIST = QName.create(MODULE_QNAME, MODULE_LIST);
 151
 152         public static final String SPECIFIC_MODULE_NAME_LEAF = "name";
 153         public static final QName SPECIFIC_MODULE_NAME_LEAF_QNAME =
 154                 QName.create(MODULE_QNAME, SPECIFIC_MODULE_NAME_LEAF);
 155
 156         public static final String SPECIFIC_MODULE_REVISION_LEAF = "revision";
 157         public static final QName SPECIFIC_MODULE_REVISION_LEAF_QNAME =
 158                 QName.create(MODULE_QNAME, SPECIFIC_MODULE_REVISION_LEAF);
 159
 160         public static final String BASE_URI_OF_SCHEMA = "/modules/";
 161         public static final String SPECIFIC_MODULE_SCHEMA_LEAF = "schema";
 162         public static final QName SPECIFIC_MODULE_SCHEMA_LEAF_QNAME =
 163                 QName.create(MODULE_QNAME, SPECIFIC_MODULE_SCHEMA_LEAF);
 164
 165         public static final String SPECIFIC_MODULE_NAMESPACE_LEAF = "namespace";
 166         public static final QName SPECIFIC_MODULE_NAMESPACE_LEAF_QNAME =
 167                 QName.create(MODULE_QNAME, SPECIFIC_MODULE_NAMESPACE_LEAF);
 168
 169         public static final String SPECIFIC_MODULE_FEATURE_LEAF_LIST = "feature";
 170         public static final QName SPECIFIC_MODULE_FEATURE_LEAF_LIST_QNAME =
 171                 QName.create(MODULE_QNAME, SPECIFIC_MODULE_FEATURE_LEAF_LIST);
 172
 173         public static final String SPECIFIC_MODULE_DEVIATION_LIST = "deviation";
 174         public static final QName SPECIFIC_MODULE_DEVIATION_LIST_QNAME =
 175                 QName.create(MODULE_QNAME, SPECIFIC_MODULE_DEVIATION_LIST);
 176
 177         public static final String SPECIFIC_MODULE_CONFORMANCE_LEAF = "conformance-type";
 178         public static final QName SPECIFIC_MODULE_CONFORMANCE_LEAF_QNAME =
 179                 QName.create(MODULE_QNAME, SPECIFIC_MODULE_CONFORMANCE_LEAF);
 180
 181         public static final String SPECIFIC_MODULE_SUBMODULE_LIST = "submodule";
 182         public static final QName SPECIFIC_MODULE_SUBMODULE_LIST_QNAME =
 183                 QName.create(MODULE_QNAME, SPECIFIC_MODULE_SUBMODULE_LIST);
 184     }
 185
 186     /**
 187      * Constants for ietf-restconf-monitoring module
 188      *
 189      */
 190     public static final class MonitoringModule {
 191
 192         private static final Logger LOG = LoggerFactory.getLogger(MonitoringModule.class);
 193
 194         private MonitoringModule() {
 195             throw new UnsupportedOperationException("Util class");
 196         }
 197
 198         public static final String NAME = "ietf-restconf-monitoring";
 199         public static final String NAMESPACE = "urn:ietf:params:xml:ns:yang:ietf-restconf-monitoring";
 200         public static final String REVISION = "2016-08-15";
 201
 202         public static Date DATE = null;
 203         public static URI URI_MODULE = null;
 204
 205         static {
 206             try {
 207                 DATE = new SimpleDateFormat("yyyy-MM-dd").parse(REVISION);
 208                 URI_MODULE = new URI(NAMESPACE);
 209             } catch (final ParseException | URISyntaxException e) {
 210                 LOG.error(e.getMessage());
 211             }
 212         }
 213
 214         public static final QNameModule MODULE_QNAME = QNameModule.create(URI_MODULE, DATE);
 215
 216         public static final String CONT_RESTCONF_STATE_NAME = "restconf-state";
 217         public static final QName CONT_RESTCONF_STATE_QNAME = QName.create(MODULE_QNAME, CONT_RESTCONF_STATE_NAME);
 218
 219         public static final String CONT_CAPABILITIES_NAME = "capabilities";
 220         public static final QName CONT_CAPABILITES_QNAME = QName.create(MODULE_QNAME, CONT_CAPABILITIES_NAME);
 221
 222         public static final String LEAF_LIST_CAPABILITY_NAME = "capability";
 223         public static final QName LEAF_LIST_CAPABILITY_QNAME = QName.create(MODULE_QNAME, LEAF_LIST_CAPABILITY_NAME);
 224
 225         public static final String CONT_STREAMS_NAME = "streams";
 226         public static final QName CONT_STREAMS_QNAME = QName.create(MODULE_QNAME, CONT_STREAMS_NAME);
 227
 228         public static final String LIST_STREAM_NAME = "stream";
 229         public static final QName LIST_STREAM_QNAME = QName.create(MODULE_QNAME, LIST_STREAM_NAME);
 230
 231         public static final String LEAF_NAME_STREAM_NAME = "name";
 232         public static final QName LEAF_NAME_STREAM_QNAME = QName.create(MODULE_QNAME, LEAF_NAME_STREAM_NAME);
 233
 234         public static final String LEAF_DESCR_STREAM_NAME = "description";
 235         public static final QName LEAF_DESCR_STREAM_QNAME = QName.create(MODULE_QNAME, LEAF_DESCR_STREAM_NAME);
 236
 237         public static final String LEAF_REPLAY_SUPP_STREAM_NAME = "replay-support";
 238         public static final QName LEAF_REPLAY_SUPP_STREAM_QNAME =
 239                 QName.create(MODULE_QNAME, LEAF_REPLAY_SUPP_STREAM_NAME);
 240
 241         public static final String LEAF_START_TIME_STREAM_NAME = "replay-log-creation-time";
 242         public static final QName LEAF_START_TIME_STREAM_QNAME =
 243                 QName.create(MODULE_QNAME, LEAF_START_TIME_STREAM_NAME);
 244
 245         public static final String LIST_ACCESS_STREAM_NAME = "access";
 246         public static final QName LIST_ACCESS_STREAM_QNAME = QName.create(MODULE_QNAME, LIST_ACCESS_STREAM_NAME);
 247
 248         public static final String LEAF_ENCODING_ACCESS_NAME = "encoding";
 249         public static final QName LEAF_ENCODING_ACCESS_QNAME = QName.create(MODULE_QNAME, LEAF_ENCODING_ACCESS_NAME);
 250
 251         public static final String LEAF_LOCATION_ACCESS_NAME = "location";
 252         public static final QName LEAF_LOCATION_ACCESS_QNAME = QName.create(MODULE_QNAME, LEAF_LOCATION_ACCESS_NAME);
 253
 254         // TODO remove after implement ietf-restconf monitoring
 255         public static final String STREAMS_CONTAINER_SCHEMA_NODE = "streams";
 256         public static final String STREAM_LIST_SCHEMA_NODE = "stream";
 257
 258         /**
 259          * Constants for capabilities
 260          */
 261         public static final class QueryParams {
 262
 263             private QueryParams() {
 264                 throw new UnsupportedOperationException("Util class");
 265             }
 266
 267             public static final String URI_BASE = "urn:ietf:params:restconf:capability:";
 268
 269             public static final String DEPTH = "depth:1.0";
 270             public static final String FIELDS = "fields:1.0";
 271             public static final String FILTER = "filter:1.0";
 272             public static final String REPLAY = "replay:1.0";
 273             public static final String WITH_DEFAULTS = "with-defaults:1.0";
 274         }
 275     }
 276 }