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 static final Logger LOG = LoggerFactory.getLogger(RestconfModule.class);
  65
  66         private RestconfModule() {
  67             throw new UnsupportedOperationException("Util class");
  68         }
  69
  70         public static final String REVISION = "2016-08-15";
  71         public static final String NAME = "ietf-restconf";
  72         public static final String NAMESPACE = "urn:ietf:params:xml:ns:yang:ietf-restconf";
  73
  74         public static final QName IETF_RESTCONF_QNAME = QName.create(Draft18.RestconfModule.NAMESPACE,
  75                 Draft18.RestconfModule.REVISION, Draft18.RestconfModule.NAME);
  76
  77         public static Date DATE = null;
  78         public static URI URI_MODULE = null;
  79
  80         static {
  81             try {
  82                 DATE = new SimpleDateFormat("yyyy-MM-dd").parse(REVISION);
  83                 URI_MODULE = new URI(NAMESPACE);
  84             } catch (final ParseException | URISyntaxException e) {
  85                 LOG.error(e.getMessage());
  86             }
  87         }
  88
  89         // RESTCONF
  90         public static final String RESTCONF_GROUPING_SCHEMA_NODE = "restconf";
  91         public static final String RESTCONF_CONTAINER_SCHEMA_NODE = "restconf";
  92         public static final String OPERATIONS_CONTAINER_SCHEMA_NODE = "operations";
  93         public static final String DATA_CONTAINER_SCHEMA_NODE = "data";
  94         public static final String LIB_VER_LEAF_SCHEMA_NODE = "yang-library-version";
  95
  96         public static final QName RESTCONF_GROUPING_QNAME =
  97                 QName.create(IETF_RESTCONF_QNAME, RESTCONF_GROUPING_SCHEMA_NODE);
  98         public static final QName RESTCONF_CONTAINER_QNAME =
  99                 QName.create(IETF_RESTCONF_QNAME, RESTCONF_CONTAINER_SCHEMA_NODE);
 100         public static final QName LIB_VER_LEAF_QNAME = QName.create(IETF_RESTCONF_QNAME, LIB_VER_LEAF_SCHEMA_NODE);
 101
 102         // ERRORS
 103         public static final String ERRORS_GROUPING_SCHEMA_NODE = "errors";
 104         public static final String ERRORS_CONTAINER_SCHEMA_NODE = "errors";
 105         public static final String ERROR_LIST_SCHEMA_NODE = "error";
 106
 107         public static final QName ERRORS_CONTAINER_QNAME =
 108                 QName.create(IETF_RESTCONF_QNAME, ERRORS_CONTAINER_SCHEMA_NODE);
 109         public static final QName ERROR_LIST_QNAME = QName.create(IETF_RESTCONF_QNAME, ERROR_LIST_SCHEMA_NODE);
 110         public static final QName ERROR_TYPE_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-type");
 111         public static final QName ERROR_TAG_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-tag");
 112         public static final QName ERROR_APP_TAG_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-app-tag");
 113         public static final QName ERROR_MESSAGE_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-message");
 114         public static final QName ERROR_INFO_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-info");
 115         public static final QName ERROR_PATH_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-path");
 116     }
 117
 118     /**
 119      * Constants for ietf-yang-library model
 120      *
 121      */
 122     public static final class IetfYangLibrary {
 123
 124         private static final Logger LOG = LoggerFactory.getLogger(IetfYangLibrary.class);
 125
 126         private IetfYangLibrary() {
 127             throw new UnsupportedOperationException("Util class");
 128         }
 129
 130         public static final String NAME = "ietf-yang-library";
 131         public static final String NAMESPACE = "urn:ietf:params:xml:ns:yang:ietf-yang-library";
 132         public static final String REVISION = "2016-06-21";
 133
 134         public static Date DATE = null;
 135         public static URI URI_MODULE = null;
 136
 137         static {
 138             try {
 139                 DATE = new SimpleDateFormat("yyyy-MM-dd").parse(REVISION);
 140                 URI_MODULE = new URI(NAMESPACE);
 141             } catch (final ParseException | URISyntaxException e) {
 142                 LOG.error(e.getMessage());
 143             }
 144         }
 145
 146         public static final QNameModule MODULE_QNAME = QNameModule.create(URI_MODULE, DATE);
 147
 148         public static final String MODULE_SET_ID_LEAF = "module-set-id";
 149         public static final QName MODULE_SET_ID_LEAF_QNAME = QName.create(MODULE_QNAME, MODULE_SET_ID_LEAF);
 150
 151         public static final String GROUPING_MODULE_LIST = "module-list";
 152         public static final QName GROUPING_MODULE_LIST_QNAME = QName.create(MODULE_QNAME, GROUPING_MODULE_LIST);
 153
 154         public static final String MODULES_STATE_CONT = "modules-state";
 155         public static final QName MODUELS_STATE_CONT_QNAME = QName.create(MODULE_QNAME, MODULES_STATE_CONT);
 156
 157         public static final String MODULE_LIST = "module";
 158         public static final QName MODULE_QNAME_LIST = QName.create(MODULE_QNAME, MODULE_LIST);
 159
 160         public static final String SPECIFIC_MODULE_NAME_LEAF = "name";
 161         public static final QName SPECIFIC_MODULE_NAME_LEAF_QNAME =
 162                 QName.create(MODULE_QNAME, SPECIFIC_MODULE_NAME_LEAF);
 163
 164         public static final String SPECIFIC_MODULE_REVISION_LEAF = "revision";
 165         public static final QName SPECIFIC_MODULE_REVISION_LEAF_QNAME =
 166                 QName.create(MODULE_QNAME, SPECIFIC_MODULE_REVISION_LEAF);
 167
 168         public static final String BASE_URI_OF_SCHEMA = "/modules/";
 169         public static final String SPECIFIC_MODULE_SCHEMA_LEAF = "schema";
 170         public static final QName SPECIFIC_MODULE_SCHEMA_LEAF_QNAME =
 171                 QName.create(MODULE_QNAME, SPECIFIC_MODULE_SCHEMA_LEAF);
 172
 173         public static final String SPECIFIC_MODULE_NAMESPACE_LEAF = "namespace";
 174         public static final QName SPECIFIC_MODULE_NAMESPACE_LEAF_QNAME =
 175                 QName.create(MODULE_QNAME, SPECIFIC_MODULE_NAMESPACE_LEAF);
 176
 177         public static final String SPECIFIC_MODULE_FEATURE_LEAF_LIST = "feature";
 178         public static final QName SPECIFIC_MODULE_FEATURE_LEAF_LIST_QNAME =
 179                 QName.create(MODULE_QNAME, SPECIFIC_MODULE_FEATURE_LEAF_LIST);
 180
 181         public static final String SPECIFIC_MODULE_DEVIATION_LIST = "deviation";
 182         public static final QName SPECIFIC_MODULE_DEVIATION_LIST_QNAME =
 183                 QName.create(MODULE_QNAME, SPECIFIC_MODULE_DEVIATION_LIST);
 184
 185         public static final String SPECIFIC_MODULE_CONFORMANCE_LEAF = "conformance-type";
 186         public static final QName SPECIFIC_MODULE_CONFORMANCE_LEAF_QNAME =
 187                 QName.create(MODULE_QNAME, SPECIFIC_MODULE_CONFORMANCE_LEAF);
 188
 189         public static final String SPECIFIC_MODULE_SUBMODULE_LIST = "submodule";
 190         public static final QName SPECIFIC_MODULE_SUBMODULE_LIST_QNAME =
 191                 QName.create(MODULE_QNAME, SPECIFIC_MODULE_SUBMODULE_LIST);
 192     }
 193
 194     /**
 195      * Constants for ietf-restconf-monitoring module
 196      *
 197      */
 198     public static final class MonitoringModule {
 199
 200         private static final Logger LOG = LoggerFactory.getLogger(MonitoringModule.class);
 201
 202         private MonitoringModule() {
 203             throw new UnsupportedOperationException("Util class");
 204         }
 205
 206         public static final String NAME = "ietf-restconf-monitoring";
 207         public static final String NAMESPACE = "urn:ietf:params:xml:ns:yang:ietf-restconf-monitoring";
 208         public static final String REVISION = "2016-08-15";
 209         public static final String PATH_TO_STREAM_WITHOUT_KEY =
 210                 "ietf-restconf-monitoring:restconf-state/streams/stream=";
 211         public static final String PATH_TO_STREAMS = "ietf-restconf-monitoring:restconf-state/streams";
 212
 213         public static Date DATE = null;
 214         public static URI URI_MODULE = null;
 215
 216         static {
 217             try {
 218                 DATE = new SimpleDateFormat("yyyy-MM-dd").parse(REVISION);
 219                 URI_MODULE = new URI(NAMESPACE);
 220             } catch (final ParseException | URISyntaxException e) {
 221                 LOG.error(e.getMessage());
 222             }
 223         }
 224
 225         public static final QNameModule MODULE_QNAME = QNameModule.create(URI_MODULE, DATE);
 226
 227         public static final String CONT_RESTCONF_STATE_NAME = "restconf-state";
 228         public static final QName CONT_RESTCONF_STATE_QNAME = QName.create(MODULE_QNAME, CONT_RESTCONF_STATE_NAME);
 229
 230         public static final String CONT_CAPABILITIES_NAME = "capabilities";
 231         public static final QName CONT_CAPABILITES_QNAME = QName.create(MODULE_QNAME, CONT_CAPABILITIES_NAME);
 232
 233         public static final String LEAF_LIST_CAPABILITY_NAME = "capability";
 234         public static final QName LEAF_LIST_CAPABILITY_QNAME = QName.create(MODULE_QNAME, LEAF_LIST_CAPABILITY_NAME);
 235
 236         public static final String CONT_STREAMS_NAME = "streams";
 237         public static final QName CONT_STREAMS_QNAME = QName.create(MODULE_QNAME, CONT_STREAMS_NAME);
 238
 239         public static final String LIST_STREAM_NAME = "stream";
 240         public static final QName LIST_STREAM_QNAME = QName.create(MODULE_QNAME, LIST_STREAM_NAME);
 241
 242         public static final String LEAF_NAME_STREAM_NAME = "name";
 243         public static final QName LEAF_NAME_STREAM_QNAME = QName.create(MODULE_QNAME, LEAF_NAME_STREAM_NAME);
 244
 245         public static final String LEAF_DESCR_STREAM_NAME = "description";
 246         public static final QName LEAF_DESCR_STREAM_QNAME = QName.create(MODULE_QNAME, LEAF_DESCR_STREAM_NAME);
 247
 248         public static final String LEAF_REPLAY_SUPP_STREAM_NAME = "replay-support";
 249         public static final QName LEAF_REPLAY_SUPP_STREAM_QNAME =
 250                 QName.create(MODULE_QNAME, LEAF_REPLAY_SUPP_STREAM_NAME);
 251
 252         public static final String LEAF_START_TIME_STREAM_NAME = "replay-log-creation-time";
 253         public static final QName LEAF_START_TIME_STREAM_QNAME =
 254                 QName.create(MODULE_QNAME, LEAF_START_TIME_STREAM_NAME);
 255
 256         public static final String LIST_ACCESS_STREAM_NAME = "access";
 257         public static final QName LIST_ACCESS_STREAM_QNAME = QName.create(MODULE_QNAME, LIST_ACCESS_STREAM_NAME);
 258
 259         public static final String LEAF_ENCODING_ACCESS_NAME = "encoding";
 260         public static final QName LEAF_ENCODING_ACCESS_QNAME = QName.create(MODULE_QNAME, LEAF_ENCODING_ACCESS_NAME);
 261
 262         public static final String LEAF_LOCATION_ACCESS_NAME = "location";
 263         public static final QName LEAF_LOCATION_ACCESS_QNAME = QName.create(MODULE_QNAME, LEAF_LOCATION_ACCESS_NAME);
 264
 265         /**
 266          * Constants for capabilities
 267          */
 268         public static final class QueryParams {
 269
 270             private QueryParams() {
 271                 throw new UnsupportedOperationException("Util class");
 272             }
 273
 274             public static final String URI_BASE = "urn:ietf:params:restconf:capability:";
 275
 276             public static final String DEPTH = URI_BASE + "depth:1.0";
 277             public static final String FIELDS = URI_BASE + "fields:1.0";
 278             public static final String FILTER = URI_BASE + "filter:1.0";
 279             public static final String REPLAY = URI_BASE + "replay:1.0";
 280             public static final String WITH_DEFAULTS = URI_BASE + "with-defaults:1.0";
 281         }
 282     }
 283 }