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 org.eclipse.jdt.annotation.NonNull;
  12 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.restconf.monitoring.rev170126.RestconfState;
  13 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.restconf.monitoring.rev170126.restconf.state.Streams;
  14 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev190104.$YangModuleInfoImpl;
  15 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev190104.module.list.Module;
  16 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev190104.module.list.module.Deviation;
  17 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev190104.module.list.module.Submodule;
  18 import org.opendaylight.yangtools.yang.common.QName;
  19 import org.opendaylight.yangtools.yang.common.QNameModule;
  20 import org.opendaylight.yangtools.yang.common.Revision;
  21 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  22 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  23 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  24
  25 /**
  26  * Common constants defined and relating to RFC8040.
  27  */
  28 public final class Rfc8040 {
  29     private static final YangInstanceIdentifier RESTCONF_STATE_STREAMS = YangInstanceIdentifier.create(
  30         NodeIdentifier.create(RestconfState.QNAME), NodeIdentifier.create(Streams.QNAME));
  31     private static final QName STREAM_QNAME = QName.create(Streams.QNAME, "stream").intern();
  32
  33     private Rfc8040() {
  34         // Hidden on purpose
  35     }
  36
  37     @Beta
  38     // FIXME: move this method somewhere else
  39     public static @NonNull YangInstanceIdentifier restconfStateStreamPath(final String streamName) {
  40         return restconfStateStreamPath(NodeIdentifierWithPredicates.of(Streams.QNAME, STREAM_QNAME, streamName));
  41     }
  42
  43     @Beta
  44     // FIXME: move this method somewhere else
  45     public static @NonNull YangInstanceIdentifier restconfStateStreamPath(final NodeIdentifierWithPredicates arg) {
  46         return RESTCONF_STATE_STREAMS.node(arg);
  47     }
  48
  49     /**
  50      * Constants for <a href="https://datatracker.ietf.org/doc/html/rfc8040#section-11.4">RESTCONF Capability URNs</a>.
  51      */
  52     public static final class Capabilities {
  53         /**
  54          * Support for <a href="https://datatracker.ietf.org/doc/html/rfc8040#section-4.8.2">depth</a> Query Parameter.
  55          */
  56         public static final String DEPTH = "urn:ietf:params:restconf:capability:depth:1.0";
  57         /**
  58          * Support for <a href="https://datatracker.ietf.org/doc/html/rfc8040#section-4.8.3">fields</a> Query Parameter.
  59          */
  60         public static final String FIELDS = "urn:ietf:params:restconf:capability:fields:1.0";
  61         /**
  62          * Support for <a href="https://datatracker.ietf.org/doc/html/rfc8040#section-4.8.4">filter</a> Query Parameter.
  63          */
  64         public static final String FILTER = "urn:ietf:params:restconf:capability:filter:1.0";
  65         /**
  66          * Support for <a href="https://datatracker.ietf.org/doc/html/rfc8040#section-4.8.7">start-time</a>
  67          * and <a href="https://datatracker.ietf.org/doc/html/rfc8040#section-4.8.7">stop-time</a> Query Parameters.
  68          */
  69         public static final String REPLAY = "urn:ietf:params:restconf:capability:replay:1.0";
  70         /**
  71          * Support for
  72          * <a href="https://datatracker.ietf.org/doc/html/rfc8040#section-4.8.9">with-defaults</a> Query Parameter.
  73          */
  74         public static final String WITH_DEFAULTS = "urn:ietf:params:restconf:capability:with-defaults:1.0";
  75
  76         private Capabilities() {
  77             // Hidden on purpose
  78         }
  79     }
  80
  81     /**
  82      * Set of application specific media types to identify each of the available resource types.
  83      */
  84     public static final class MediaTypes {
  85         /**
  86          * See: <a href="https://tools.ietf.org/html/rfc6415">rfc6415</a>.
  87          */
  88         public static final String XRD = "application/xrd";
  89
  90         public static final String DATA = "application/yang-data";
  91         public static final String YANG_PATCH = "application/yang.patch";
  92         public static final String YANG_PATCH_STATUS = "application/yang.patch-status";
  93
  94         private MediaTypes() {
  95             // Hidden on purpose
  96         }
  97     }
  98
  99     /**
 100      * Constants for ietf-yang-library model.
 101      */
 102     // FIXME: split this out
 103     public static final class IetfYangLibrary {
 104         public static final QNameModule MODULE_QNAME = $YangModuleInfoImpl.getInstance().getName().getModule();
 105         public static final Revision REVISION = MODULE_QNAME.getRevision().orElseThrow();
 106
 107         public static final QName MODULE_SET_ID_LEAF_QNAME = QName.create(MODULE_QNAME, "module-set-id").intern();
 108
 109         public static final QName MODULE_QNAME_LIST = Module.QNAME;
 110
 111         public static final String SPECIFIC_MODULE_NAME_LEAF = "name";
 112         public static final QName SPECIFIC_MODULE_NAME_LEAF_QNAME =
 113                 QName.create(MODULE_QNAME, SPECIFIC_MODULE_NAME_LEAF).intern();
 114
 115         public static final String SPECIFIC_MODULE_REVISION_LEAF = "revision";
 116         public static final QName SPECIFIC_MODULE_REVISION_LEAF_QNAME =
 117                 QName.create(MODULE_QNAME, SPECIFIC_MODULE_REVISION_LEAF).intern();
 118
 119         public static final String BASE_URI_OF_SCHEMA = "/modules/";
 120         public static final QName SPECIFIC_MODULE_SCHEMA_LEAF_QNAME = QName.create(MODULE_QNAME, "schema").intern();
 121         public static final QName SPECIFIC_MODULE_NAMESPACE_LEAF_QNAME =
 122                 QName.create(MODULE_QNAME, "namespace").intern();
 123
 124         public static final QName SPECIFIC_MODULE_FEATURE_LEAF_LIST_QNAME =
 125                 QName.create(MODULE_QNAME, "feature").intern();
 126
 127         public static final QName SPECIFIC_MODULE_DEVIATION_LIST_QNAME = Deviation.QNAME;
 128
 129         public static final QName SPECIFIC_MODULE_CONFORMANCE_LEAF_QNAME =
 130                 QName.create(MODULE_QNAME, "conformance-type").intern();
 131
 132         public static final QName SPECIFIC_MODULE_SUBMODULE_LIST_QNAME = Submodule.QNAME;
 133
 134         private IetfYangLibrary() {
 135             // Hidden on purpose
 136         }
 137     }
 138 }