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 com.google.common.annotations.Beta;
  11 import java.net.URI;
  12 import org.eclipse.jdt.annotation.NonNull;
  13 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev190104.$YangModuleInfoImpl;
  14 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev190104.module.list.Module;
  15 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev190104.module.list.module.Deviation;
  16 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev190104.module.list.module.Submodule;
  17 import org.opendaylight.yangtools.yang.common.QName;
  18 import org.opendaylight.yangtools.yang.common.QNameModule;
  19 import org.opendaylight.yangtools.yang.common.Revision;
  20 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  21 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  22 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  23
  24 /**
  25  * Base Draft for Restconf project.
  26  * <ul>
  27  * <li>Supported {@link MediaTypes}
  28  * <li>Constants for modules
  29  * <ul>
  30  * <li>{@link RestconfModule}
  31  * <li>{@link MonitoringModule}
  32  * </ul>
  33  * </ul>
  34  */
  35 public final class Rfc8040 {
  36
  37     private Rfc8040() {
  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         /**
  52          * See: <a href="https://tools.ietf.org/html/rfc6415">rfc6415</a>.
  53          */
  54         public static final String XRD = "application/xrd";
  55
  56         public static final String DATA = "application/yang-data";
  57         // up to and including draft-ietf-netconf-yang-patch-08
  58         public static final String YANG_PATCH = "application/yang.patch";
  59         public static final String YANG_PATCH_STATUS = "application/yang.patch-status";
  60
  61         // since draft-ietf-netconf-yang-patch-09
  62         public static final String YANG_PATCH_RFC8072 = "application/yang-patch";
  63     }
  64
  65     /**
  66      * Constants for restconf module.
  67      *
  68      */
  69     public static final class RestconfModule {
  70         private RestconfModule() {
  71             throw new UnsupportedOperationException("Util class");
  72         }
  73
  74         public static final Revision REVISION = Revision.of("2017-01-26");
  75         public static final String NAME = "ietf-restconf";
  76         public static final String NAMESPACE = "urn:ietf:params:xml:ns:yang:ietf-restconf";
  77         public static final URI URI_MODULE = URI.create(NAMESPACE);
  78
  79         public static final QName IETF_RESTCONF_QNAME = QName.create(URI_MODULE,
  80                 Rfc8040.RestconfModule.REVISION, Rfc8040.RestconfModule.NAME).intern();
  81
  82         // RESTCONF
  83         public static final String RESTCONF_GROUPING_SCHEMA_NODE = "restconf";
  84         public static final String RESTCONF_CONTAINER_SCHEMA_NODE = "restconf";
  85         public static final String OPERATIONS_CONTAINER_SCHEMA_NODE = "operations";
  86         public static final String DATA_CONTAINER_SCHEMA_NODE = "data";
  87         public static final String LIB_VER_LEAF_SCHEMA_NODE = "yang-library-version";
  88
  89         public static final QName RESTCONF_GROUPING_QNAME =
  90                 QName.create(IETF_RESTCONF_QNAME, RESTCONF_GROUPING_SCHEMA_NODE).intern();
  91         public static final QName RESTCONF_CONTAINER_QNAME =
  92                 QName.create(IETF_RESTCONF_QNAME, RESTCONF_CONTAINER_SCHEMA_NODE).intern();
  93         public static final QName LIB_VER_LEAF_QNAME = QName.create(IETF_RESTCONF_QNAME, LIB_VER_LEAF_SCHEMA_NODE)
  94                 .intern();
  95
  96         // ERRORS
  97         public static final String ERRORS_GROUPING_SCHEMA_NODE = "errors";
  98         public static final String ERRORS_CONTAINER_SCHEMA_NODE = "errors";
  99         public static final String ERROR_LIST_SCHEMA_NODE = "error";
 100
 101         public static final QName ERRORS_GROUPING_QNAME =
 102                 QName.create(IETF_RESTCONF_QNAME, ERRORS_GROUPING_SCHEMA_NODE).intern();
 103         public static final QName ERRORS_CONTAINER_QNAME =
 104                 QName.create(IETF_RESTCONF_QNAME, ERRORS_CONTAINER_SCHEMA_NODE).intern();
 105         public static final QName ERROR_LIST_QNAME = QName.create(IETF_RESTCONF_QNAME, ERROR_LIST_SCHEMA_NODE).intern();
 106         public static final QName ERROR_TYPE_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-type").intern();
 107         public static final QName ERROR_TAG_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-tag").intern();
 108         public static final QName ERROR_APP_TAG_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-app-tag").intern();
 109         public static final QName ERROR_MESSAGE_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-message").intern();
 110         public static final QName ERROR_INFO_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-info").intern();
 111         public static final QName ERROR_PATH_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-path").intern();
 112     }
 113
 114     /**
 115      * Constants for ietf-yang-library model.
 116      *
 117      */
 118     public static final class IetfYangLibrary {
 119         private IetfYangLibrary() {
 120             throw new UnsupportedOperationException("Util class");
 121         }
 122
 123         public static final QNameModule MODULE_QNAME = $YangModuleInfoImpl.getInstance().getName().getModule();
 124         public static final Revision REVISION = MODULE_QNAME.getRevision().orElseThrow();
 125
 126         public static final QName MODULE_SET_ID_LEAF_QNAME = QName.create(MODULE_QNAME, "module-set-id").intern();
 127
 128         public static final QName MODULE_QNAME_LIST = Module.QNAME;
 129
 130         public static final String SPECIFIC_MODULE_NAME_LEAF = "name";
 131         public static final QName SPECIFIC_MODULE_NAME_LEAF_QNAME =
 132                 QName.create(MODULE_QNAME, SPECIFIC_MODULE_NAME_LEAF).intern();
 133
 134         public static final String SPECIFIC_MODULE_REVISION_LEAF = "revision";
 135         public static final QName SPECIFIC_MODULE_REVISION_LEAF_QNAME =
 136                 QName.create(MODULE_QNAME, SPECIFIC_MODULE_REVISION_LEAF).intern();
 137
 138         public static final String BASE_URI_OF_SCHEMA = "/modules/";
 139         public static final QName SPECIFIC_MODULE_SCHEMA_LEAF_QNAME = QName.create(MODULE_QNAME, "schema").intern();
 140         public static final QName SPECIFIC_MODULE_NAMESPACE_LEAF_QNAME =
 141                 QName.create(MODULE_QNAME, "namespace").intern();
 142
 143         public static final QName SPECIFIC_MODULE_FEATURE_LEAF_LIST_QNAME =
 144                 QName.create(MODULE_QNAME, "feature").intern();
 145
 146         public static final QName SPECIFIC_MODULE_DEVIATION_LIST_QNAME = Deviation.QNAME;
 147
 148         public static final QName SPECIFIC_MODULE_CONFORMANCE_LEAF_QNAME =
 149                 QName.create(MODULE_QNAME, "conformance-type").intern();
 150
 151         public static final QName SPECIFIC_MODULE_SUBMODULE_LIST_QNAME = Submodule.QNAME;
 152     }
 153
 154     /**
 155      * Constants for ietf-restconf-monitoring module.
 156      *
 157      */
 158     public static final class MonitoringModule {
 159
 160         private MonitoringModule() {
 161             throw new UnsupportedOperationException("Util class");
 162         }
 163
 164         public static final String NAME = "ietf-restconf-monitoring";
 165         public static final String NAMESPACE = "urn:ietf:params:xml:ns:yang:ietf-restconf-monitoring";
 166         public static final Revision REVISION = Revision.of("2017-01-26");
 167         public static final String PATH_TO_STREAM_WITHOUT_KEY =
 168                 "ietf-restconf-monitoring:restconf-state/streams/stream=";
 169         public static final String PATH_TO_STREAMS = "ietf-restconf-monitoring:restconf-state/streams";
 170
 171         public static final URI URI_MODULE = URI.create(NAMESPACE);
 172
 173         public static final QNameModule MODULE_QNAME = QNameModule.create(URI_MODULE, REVISION).intern();
 174
 175         public static final String CONT_RESTCONF_STATE_NAME = "restconf-state";
 176         public static final QName CONT_RESTCONF_STATE_QNAME = QName.create(MODULE_QNAME, CONT_RESTCONF_STATE_NAME)
 177                 .intern();
 178
 179         public static final String CONT_CAPABILITIES_NAME = "capabilities";
 180         public static final QName CONT_CAPABILITES_QNAME = QName.create(MODULE_QNAME, CONT_CAPABILITIES_NAME).intern();
 181
 182         public static final String LEAF_LIST_CAPABILITY_NAME = "capability";
 183         public static final QName LEAF_LIST_CAPABILITY_QNAME = QName.create(MODULE_QNAME, LEAF_LIST_CAPABILITY_NAME)
 184                 .intern();
 185
 186         public static final String CONT_STREAMS_NAME = "streams";
 187         public static final QName CONT_STREAMS_QNAME = QName.create(MODULE_QNAME, CONT_STREAMS_NAME).intern();
 188
 189         public static final String LIST_STREAM_NAME = "stream";
 190         public static final QName LIST_STREAM_QNAME = QName.create(MODULE_QNAME, LIST_STREAM_NAME).intern();
 191
 192         public static final String LEAF_NAME_STREAM_NAME = "name";
 193         public static final QName LEAF_NAME_STREAM_QNAME = QName.create(MODULE_QNAME, LEAF_NAME_STREAM_NAME).intern();
 194
 195         public static final String LEAF_DESCR_STREAM_NAME = "description";
 196         public static final QName LEAF_DESCR_STREAM_QNAME = QName.create(MODULE_QNAME, LEAF_DESCR_STREAM_NAME).intern();
 197
 198         public static final String LEAF_REPLAY_SUPP_STREAM_NAME = "replay-support";
 199         public static final QName LEAF_REPLAY_SUPP_STREAM_QNAME =
 200                 QName.create(MODULE_QNAME, LEAF_REPLAY_SUPP_STREAM_NAME).intern();
 201
 202         public static final String LEAF_START_TIME_STREAM_NAME = "replay-log-creation-time";
 203         public static final QName LEAF_START_TIME_STREAM_QNAME =
 204                 QName.create(MODULE_QNAME, LEAF_START_TIME_STREAM_NAME).intern();
 205
 206         public static final String LIST_ACCESS_STREAM_NAME = "access";
 207         public static final QName LIST_ACCESS_STREAM_QNAME = QName.create(MODULE_QNAME, LIST_ACCESS_STREAM_NAME)
 208                 .intern();
 209
 210         public static final String LEAF_ENCODING_ACCESS_NAME = "encoding";
 211         public static final QName LEAF_ENCODING_ACCESS_QNAME = QName.create(MODULE_QNAME, LEAF_ENCODING_ACCESS_NAME)
 212                 .intern();
 213
 214         public static final String LEAF_LOCATION_ACCESS_NAME = "location";
 215         public static final QName LEAF_LOCATION_ACCESS_QNAME = QName.create(MODULE_QNAME, LEAF_LOCATION_ACCESS_NAME)
 216                 .intern();
 217
 218         private static final YangInstanceIdentifier RESTCONF_STATE_STREAMS = YangInstanceIdentifier.create(
 219             NodeIdentifier.create(CONT_RESTCONF_STATE_QNAME), NodeIdentifier.create(CONT_STREAMS_QNAME),
 220             NodeIdentifier.create(LIST_STREAM_QNAME));
 221
 222         @Beta
 223         // FIXME: move this method somewhere else
 224         public static @NonNull YangInstanceIdentifier restconfStateStreamPath(final String streamName) {
 225             return restconfStateStreamPath(NodeIdentifierWithPredicates.of(LIST_STREAM_QNAME, LEAF_NAME_STREAM_QNAME,
 226                 streamName));
 227         }
 228
 229         @Beta
 230         // FIXME: move this method somewhere else
 231         public static @NonNull YangInstanceIdentifier restconfStateStreamPath(final NodeIdentifierWithPredicates arg) {
 232             return RESTCONF_STATE_STREAMS.node(arg);
 233         }
 234
 235         /**
 236          * Constants for capabilities.
 237          */
 238         public static final class QueryParams {
 239
 240             private QueryParams() {
 241                 throw new UnsupportedOperationException("Util class");
 242             }
 243
 244             public static final String URI_BASE = "urn:ietf:params:restconf:capability:";
 245
 246             public static final String DEPTH = URI_BASE + "depth:1.0";
 247             public static final String FIELDS = URI_BASE + "fields:1.0";
 248             public static final String FILTER = URI_BASE + "filter:1.0";
 249             public static final String REPLAY = URI_BASE + "replay:1.0";
 250             public static final String WITH_DEFAULTS = URI_BASE + "with-defaults:1.0";
 251         }
 252     }
 253 }