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.restconf.monitoring.rev170126.RestconfState;
  14 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.restconf.monitoring.rev170126.restconf.state.Streams;
  15 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev190104.$YangModuleInfoImpl;
  16 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev190104.module.list.Module;
  17 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev190104.module.list.module.Deviation;
  18 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev190104.module.list.module.Submodule;
  19 import org.opendaylight.yangtools.yang.common.QName;
  20 import org.opendaylight.yangtools.yang.common.QNameModule;
  21 import org.opendaylight.yangtools.yang.common.Revision;
  22 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  23 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  24 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  25
  26 /**
  27  * Base Draft for Restconf project.
  28  * <ul>
  29  * <li>Supported {@link MediaTypes}
  30  * <li>Constants for modules
  31  * <ul>
  32  * <li>{@link RestconfModule}
  33  * </ul>
  34  * </ul>
  35  */
  36 public final class Rfc8040 {
  37     private static final YangInstanceIdentifier RESTCONF_STATE_STREAMS = YangInstanceIdentifier.create(
  38         NodeIdentifier.create(RestconfState.QNAME), NodeIdentifier.create(Streams.QNAME));
  39     private static final QName STREAM_QNAME = QName.create(Streams.QNAME, "stream").intern();
  40
  41     private Rfc8040() {
  42         // Hidden on purpose
  43     }
  44
  45     @Beta
  46     // FIXME: move this method somewhere else
  47     public static @NonNull YangInstanceIdentifier restconfStateStreamPath(final String streamName) {
  48         return restconfStateStreamPath(NodeIdentifierWithPredicates.of(Streams.QNAME, STREAM_QNAME, streamName));
  49     }
  50
  51     @Beta
  52     // FIXME: move this method somewhere else
  53     public static @NonNull YangInstanceIdentifier restconfStateStreamPath(final NodeIdentifierWithPredicates arg) {
  54         return RESTCONF_STATE_STREAMS.node(arg);
  55     }
  56
  57     /**
  58      * Constants for <a href="https://datatracker.ietf.org/doc/html/rfc8040#section-11.4">RESTCONF Capability URNs</a>.
  59      */
  60     public static final class Capabilities {
  61         /**
  62          * Support for <a href="https://datatracker.ietf.org/doc/html/rfc8040#section-4.8.2">depth</a> Query Parameter.
  63          */
  64         public static final String DEPTH = "urn:ietf:params:restconf:capability:depth:1.0";
  65         /**
  66          * Support for <a href="https://datatracker.ietf.org/doc/html/rfc8040#section-4.8.3">fields</a> Query Parameter.
  67          */
  68         public static final String FIELDS = "urn:ietf:params:restconf:capability:fields:1.0";
  69         /**
  70          * Support for <a href="https://datatracker.ietf.org/doc/html/rfc8040#section-4.8.4">filter</a> Query Parameter.
  71          */
  72         public static final String FILTER = "urn:ietf:params:restconf:capability:filter:1.0";
  73         /**
  74          * Support for <a href="https://datatracker.ietf.org/doc/html/rfc8040#section-4.8.7">start-time</a>
  75          * and <a href="https://datatracker.ietf.org/doc/html/rfc8040#section-4.8.7">stop-time</a> Query Parameters.
  76          */
  77         public static final String REPLAY = "urn:ietf:params:restconf:capability:replay:1.0";
  78         /**
  79          * Support for
  80          * <a href="https://datatracker.ietf.org/doc/html/rfc8040#section-4.8.9">with-defaults</a> Query Parameter.
  81          */
  82         public static final String WITH_DEFAULTS = "urn:ietf:params:restconf:capability:with-defaults:1.0";
  83
  84         private Capabilities() {
  85             // Hidden on purpose
  86         }
  87     }
  88
  89     /**
  90      * Set of application specific media types to identify each of the available resource types.
  91      */
  92     public static final class MediaTypes {
  93         /**
  94          * See: <a href="https://tools.ietf.org/html/rfc6415">rfc6415</a>.
  95          */
  96         public static final String XRD = "application/xrd";
  97
  98         public static final String DATA = "application/yang-data";
  99         public static final String YANG_PATCH = "application/yang.patch";
 100         public static final String YANG_PATCH_STATUS = "application/yang.patch-status";
 101
 102         private MediaTypes() {
 103             // Hidden on purpose
 104         }
 105     }
 106
 107     /**
 108      * Constants for restconf module.
 109      */
 110     // FIXME: split this out
 111     public static final class RestconfModule {
 112         public static final Revision REVISION = Revision.of("2017-01-26");
 113         public static final String NAME = "ietf-restconf";
 114         public static final String NAMESPACE = "urn:ietf:params:xml:ns:yang:ietf-restconf";
 115         public static final URI URI_MODULE = URI.create(NAMESPACE);
 116
 117         public static final QName IETF_RESTCONF_QNAME = QName.create(URI_MODULE,
 118                 Rfc8040.RestconfModule.REVISION, Rfc8040.RestconfModule.NAME).intern();
 119
 120         // RESTCONF
 121         public static final QName RESTCONF_GROUPING_QNAME = QName.create(IETF_RESTCONF_QNAME, "restconf").intern();
 122         public static final QName RESTCONF_CONTAINER_QNAME = QName.create(IETF_RESTCONF_QNAME, "restconf").intern();
 123         public static final QName LIB_VER_LEAF_QNAME = QName.create(IETF_RESTCONF_QNAME, "yang-library-version")
 124                 .intern();
 125
 126         // ERRORS
 127         public static final QName ERRORS_GROUPING_QNAME = QName.create(IETF_RESTCONF_QNAME, "errors").intern();
 128         public static final QName ERRORS_CONTAINER_QNAME = QName.create(IETF_RESTCONF_QNAME, "errors").intern();
 129         public static final QName ERROR_LIST_QNAME = QName.create(IETF_RESTCONF_QNAME, "error").intern();
 130         public static final QName ERROR_TYPE_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-type").intern();
 131         public static final QName ERROR_TAG_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-tag").intern();
 132         public static final QName ERROR_APP_TAG_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-app-tag").intern();
 133         public static final QName ERROR_MESSAGE_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-message").intern();
 134         public static final QName ERROR_INFO_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-info").intern();
 135         public static final QName ERROR_PATH_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-path").intern();
 136
 137         private RestconfModule() {
 138             // Hidden on purpose
 139         }
 140     }
 141
 142     /**
 143      * Constants for ietf-yang-library model.
 144      */
 145     // FIXME: split this out
 146     public static final class IetfYangLibrary {
 147         public static final QNameModule MODULE_QNAME = $YangModuleInfoImpl.getInstance().getName().getModule();
 148         public static final Revision REVISION = MODULE_QNAME.getRevision().orElseThrow();
 149
 150         public static final QName MODULE_SET_ID_LEAF_QNAME = QName.create(MODULE_QNAME, "module-set-id").intern();
 151
 152         public static final QName MODULE_QNAME_LIST = Module.QNAME;
 153
 154         public static final String SPECIFIC_MODULE_NAME_LEAF = "name";
 155         public static final QName SPECIFIC_MODULE_NAME_LEAF_QNAME =
 156                 QName.create(MODULE_QNAME, SPECIFIC_MODULE_NAME_LEAF).intern();
 157
 158         public static final String SPECIFIC_MODULE_REVISION_LEAF = "revision";
 159         public static final QName SPECIFIC_MODULE_REVISION_LEAF_QNAME =
 160                 QName.create(MODULE_QNAME, SPECIFIC_MODULE_REVISION_LEAF).intern();
 161
 162         public static final String BASE_URI_OF_SCHEMA = "/modules/";
 163         public static final QName SPECIFIC_MODULE_SCHEMA_LEAF_QNAME = QName.create(MODULE_QNAME, "schema").intern();
 164         public static final QName SPECIFIC_MODULE_NAMESPACE_LEAF_QNAME =
 165                 QName.create(MODULE_QNAME, "namespace").intern();
 166
 167         public static final QName SPECIFIC_MODULE_FEATURE_LEAF_LIST_QNAME =
 168                 QName.create(MODULE_QNAME, "feature").intern();
 169
 170         public static final QName SPECIFIC_MODULE_DEVIATION_LIST_QNAME = Deviation.QNAME;
 171
 172         public static final QName SPECIFIC_MODULE_CONFORMANCE_LEAF_QNAME =
 173                 QName.create(MODULE_QNAME, "conformance-type").intern();
 174
 175         public static final QName SPECIFIC_MODULE_SUBMODULE_LIST_QNAME = Submodule.QNAME;
 176
 177         private IetfYangLibrary() {
 178             // Hidden on purpose
 179         }
 180     }
 181 }