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