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.restconf.monitoring.rev170126.restconf.state.streams.Stream;
  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  * Common constants defined and relating to RFC8040.
  28  */
  29 public final class Rfc8040 {
  30     private static final YangInstanceIdentifier RESTCONF_STATE_STREAMS = YangInstanceIdentifier.create(
  31         NodeIdentifier.create(RestconfState.QNAME), NodeIdentifier.create(Streams.QNAME),
  32         NodeIdentifier.create(Stream.QNAME));
  33     private static final QName NAME_QNAME = QName.create(Stream.QNAME, "name").intern();
  34
  35     private Rfc8040() {
  36         // Hidden on purpose
  37     }
  38
  39     @Beta
  40     // FIXME: move this method somewhere else
  41     public static @NonNull YangInstanceIdentifier restconfStateStreamPath(final String streamName) {
  42         return restconfStateStreamPath(NodeIdentifierWithPredicates.of(Stream.QNAME, NAME_QNAME, streamName));
  43     }
  44
  45     @Beta
  46     // FIXME: move this method somewhere else
  47     public static @NonNull YangInstanceIdentifier restconfStateStreamPath(final NodeIdentifierWithPredicates arg) {
  48         return RESTCONF_STATE_STREAMS.node(arg);
  49     }
  50
  51     /**
  52      * Constants for <a href="https://datatracker.ietf.org/doc/html/rfc8040#section-11.4">RESTCONF Capability URNs</a>.
  53      */
  54     public static final class Capabilities {
  55         /**
  56          * Support for <a href="https://datatracker.ietf.org/doc/html/rfc8040#section-4.8.2">depth</a> Query Parameter.
  57          */
  58         public static final String DEPTH = "urn:ietf:params:restconf:capability:depth:1.0";
  59         /**
  60          * Support for <a href="https://datatracker.ietf.org/doc/html/rfc8040#section-4.8.3">fields</a> Query Parameter.
  61          */
  62         public static final String FIELDS = "urn:ietf:params:restconf:capability:fields:1.0";
  63         /**
  64          * Support for <a href="https://datatracker.ietf.org/doc/html/rfc8040#section-4.8.4">filter</a> Query Parameter.
  65          */
  66         public static final String FILTER = "urn:ietf:params:restconf:capability:filter:1.0";
  67         /**
  68          * Support for <a href="https://datatracker.ietf.org/doc/html/rfc8040#section-4.8.7">start-time</a>
  69          * and <a href="https://datatracker.ietf.org/doc/html/rfc8040#section-4.8.7">stop-time</a> Query Parameters.
  70          */
  71         public static final String REPLAY = "urn:ietf:params:restconf:capability:replay:1.0";
  72         /**
  73          * Support for
  74          * <a href="https://datatracker.ietf.org/doc/html/rfc8040#section-4.8.9">with-defaults</a> Query Parameter.
  75          */
  76         public static final String WITH_DEFAULTS = "urn:ietf:params:restconf:capability:with-defaults:1.0";
  77
  78         private Capabilities() {
  79             // Hidden on purpose
  80         }
  81     }
  82
  83     /**
  84      * Constants for ietf-yang-library model.
  85      */
  86     // FIXME: split this out
  87     public static final class IetfYangLibrary {
  88         public static final QNameModule MODULE_QNAME = $YangModuleInfoImpl.getInstance().getName().getModule();
  89         public static final Revision REVISION = MODULE_QNAME.getRevision().orElseThrow();
  90
  91         public static final QName MODULE_SET_ID_LEAF_QNAME = QName.create(MODULE_QNAME, "module-set-id").intern();
  92
  93         public static final QName MODULE_QNAME_LIST = Module.QNAME;
  94
  95         public static final String SPECIFIC_MODULE_NAME_LEAF = "name";
  96         public static final QName SPECIFIC_MODULE_NAME_LEAF_QNAME =
  97                 QName.create(MODULE_QNAME, SPECIFIC_MODULE_NAME_LEAF).intern();
  98
  99         public static final String SPECIFIC_MODULE_REVISION_LEAF = "revision";
 100         public static final QName SPECIFIC_MODULE_REVISION_LEAF_QNAME =
 101                 QName.create(MODULE_QNAME, SPECIFIC_MODULE_REVISION_LEAF).intern();
 102
 103         public static final String BASE_URI_OF_SCHEMA = "/modules/";
 104         public static final QName SPECIFIC_MODULE_SCHEMA_LEAF_QNAME = QName.create(MODULE_QNAME, "schema").intern();
 105         public static final QName SPECIFIC_MODULE_NAMESPACE_LEAF_QNAME =
 106                 QName.create(MODULE_QNAME, "namespace").intern();
 107
 108         public static final QName SPECIFIC_MODULE_FEATURE_LEAF_LIST_QNAME =
 109                 QName.create(MODULE_QNAME, "feature").intern();
 110
 111         public static final QName SPECIFIC_MODULE_DEVIATION_LIST_QNAME = Deviation.QNAME;
 112
 113         public static final QName SPECIFIC_MODULE_CONFORMANCE_LEAF_QNAME =
 114                 QName.create(MODULE_QNAME, "conformance-type").intern();
 115
 116         public static final QName SPECIFIC_MODULE_SUBMODULE_LIST_QNAME = Submodule.QNAME;
 117
 118         private IetfYangLibrary() {
 119             // Hidden on purpose
 120         }
 121     }
 122 }