2 * Copyright (c) 2016 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.restconf.nb.rfc8040;
11 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev190104.$YangModuleInfoImpl;
12 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev190104.module.list.Module;
13 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev190104.module.list.module.Deviation;
14 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev190104.module.list.module.Submodule;
15 import org.opendaylight.yangtools.yang.common.QName;
16 import org.opendaylight.yangtools.yang.common.QNameModule;
17 import org.opendaylight.yangtools.yang.common.Revision;
20 * Base Draft for Restconf project.
22 * <li>Supported {@link MediaTypes}
23 * <li>Constants for modules
25 * <li>{@link RestconfModule}
26 * <li>{@link MonitoringModule}
30 public final class Rfc8040 {
33 throw new UnsupportedOperationException("Util class");
37 * Set of application specific media types to identify each of the available
40 public static final class MediaTypes {
42 private MediaTypes() {
43 throw new UnsupportedOperationException("Util class");
47 * See: <a href="https://tools.ietf.org/html/rfc6415">rfc6415</a>.
49 public static final String XRD = "application/xrd";
51 public static final String DATA = "application/yang-data";
52 public static final String YANG_PATCH = "application/yang.patch";
53 public static final String YANG_PATCH_STATUS = "application/yang.patch-status";
57 * Constants for restconf module.
60 public static final class RestconfModule {
61 private RestconfModule() {
62 throw new UnsupportedOperationException("Util class");
65 public static final Revision REVISION = Revision.of("2017-01-26");
66 public static final String NAME = "ietf-restconf";
67 public static final String NAMESPACE = "urn:ietf:params:xml:ns:yang:ietf-restconf";
68 public static final URI URI_MODULE = URI.create(NAMESPACE);
70 public static final QName IETF_RESTCONF_QNAME = QName.create(URI_MODULE,
71 Rfc8040.RestconfModule.REVISION, Rfc8040.RestconfModule.NAME).intern();
74 public static final String RESTCONF_GROUPING_SCHEMA_NODE = "restconf";
75 public static final String RESTCONF_CONTAINER_SCHEMA_NODE = "restconf";
76 public static final String OPERATIONS_CONTAINER_SCHEMA_NODE = "operations";
77 public static final String DATA_CONTAINER_SCHEMA_NODE = "data";
78 public static final String LIB_VER_LEAF_SCHEMA_NODE = "yang-library-version";
80 public static final QName RESTCONF_GROUPING_QNAME =
81 QName.create(IETF_RESTCONF_QNAME, RESTCONF_GROUPING_SCHEMA_NODE).intern();
82 public static final QName RESTCONF_CONTAINER_QNAME =
83 QName.create(IETF_RESTCONF_QNAME, RESTCONF_CONTAINER_SCHEMA_NODE).intern();
84 public static final QName LIB_VER_LEAF_QNAME = QName.create(IETF_RESTCONF_QNAME, LIB_VER_LEAF_SCHEMA_NODE)
88 public static final String ERRORS_GROUPING_SCHEMA_NODE = "errors";
89 public static final String ERRORS_CONTAINER_SCHEMA_NODE = "errors";
90 public static final String ERROR_LIST_SCHEMA_NODE = "error";
92 public static final QName ERRORS_GROUPING_QNAME =
93 QName.create(IETF_RESTCONF_QNAME, ERRORS_GROUPING_SCHEMA_NODE).intern();
94 public static final QName ERRORS_CONTAINER_QNAME =
95 QName.create(IETF_RESTCONF_QNAME, ERRORS_CONTAINER_SCHEMA_NODE).intern();
96 public static final QName ERROR_LIST_QNAME = QName.create(IETF_RESTCONF_QNAME, ERROR_LIST_SCHEMA_NODE).intern();
97 public static final QName ERROR_TYPE_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-type").intern();
98 public static final QName ERROR_TAG_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-tag").intern();
99 public static final QName ERROR_APP_TAG_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-app-tag").intern();
100 public static final QName ERROR_MESSAGE_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-message").intern();
101 public static final QName ERROR_INFO_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-info").intern();
102 public static final QName ERROR_PATH_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-path").intern();
106 * Constants for ietf-yang-library model.
109 public static final class IetfYangLibrary {
110 private IetfYangLibrary() {
111 throw new UnsupportedOperationException("Util class");
114 public static final QNameModule MODULE_QNAME = $YangModuleInfoImpl.getInstance().getName().getModule();
115 public static final Revision REVISION = MODULE_QNAME.getRevision().orElseThrow();
117 public static final QName MODULE_SET_ID_LEAF_QNAME = QName.create(MODULE_QNAME, "module-set-id").intern();
119 public static final QName MODULE_QNAME_LIST = Module.QNAME;
121 public static final String SPECIFIC_MODULE_NAME_LEAF = "name";
122 public static final QName SPECIFIC_MODULE_NAME_LEAF_QNAME =
123 QName.create(MODULE_QNAME, SPECIFIC_MODULE_NAME_LEAF).intern();
125 public static final String SPECIFIC_MODULE_REVISION_LEAF = "revision";
126 public static final QName SPECIFIC_MODULE_REVISION_LEAF_QNAME =
127 QName.create(MODULE_QNAME, SPECIFIC_MODULE_REVISION_LEAF).intern();
129 public static final String BASE_URI_OF_SCHEMA = "/modules/";
130 public static final QName SPECIFIC_MODULE_SCHEMA_LEAF_QNAME = QName.create(MODULE_QNAME, "schema").intern();
131 public static final QName SPECIFIC_MODULE_NAMESPACE_LEAF_QNAME =
132 QName.create(MODULE_QNAME, "namespace").intern();
134 public static final QName SPECIFIC_MODULE_FEATURE_LEAF_LIST_QNAME =
135 QName.create(MODULE_QNAME, "feature").intern();
137 public static final QName SPECIFIC_MODULE_DEVIATION_LIST_QNAME = Deviation.QNAME;
139 public static final QName SPECIFIC_MODULE_CONFORMANCE_LEAF_QNAME =
140 QName.create(MODULE_QNAME, "conformance-type").intern();
142 public static final QName SPECIFIC_MODULE_SUBMODULE_LIST_QNAME = Submodule.QNAME;
146 * Constants for ietf-restconf-monitoring module.
149 public static final class MonitoringModule {
151 private MonitoringModule() {
152 throw new UnsupportedOperationException("Util class");
155 public static final String NAME = "ietf-restconf-monitoring";
156 public static final String NAMESPACE = "urn:ietf:params:xml:ns:yang:ietf-restconf-monitoring";
157 public static final Revision REVISION = Revision.of("2017-01-26");
158 public static final String PATH_TO_STREAM_WITHOUT_KEY =
159 "ietf-restconf-monitoring:restconf-state/streams/stream=";
160 public static final String PATH_TO_STREAMS = "ietf-restconf-monitoring:restconf-state/streams";
162 public static final URI URI_MODULE = URI.create(NAMESPACE);
164 public static final QNameModule MODULE_QNAME = QNameModule.create(URI_MODULE, REVISION).intern();
166 public static final String CONT_RESTCONF_STATE_NAME = "restconf-state";
167 public static final QName CONT_RESTCONF_STATE_QNAME = QName.create(MODULE_QNAME, CONT_RESTCONF_STATE_NAME)
170 public static final String CONT_CAPABILITIES_NAME = "capabilities";
171 public static final QName CONT_CAPABILITES_QNAME = QName.create(MODULE_QNAME, CONT_CAPABILITIES_NAME).intern();
173 public static final String LEAF_LIST_CAPABILITY_NAME = "capability";
174 public static final QName LEAF_LIST_CAPABILITY_QNAME = QName.create(MODULE_QNAME, LEAF_LIST_CAPABILITY_NAME)
177 public static final String CONT_STREAMS_NAME = "streams";
178 public static final QName CONT_STREAMS_QNAME = QName.create(MODULE_QNAME, CONT_STREAMS_NAME).intern();
180 public static final String LIST_STREAM_NAME = "stream";
181 public static final QName LIST_STREAM_QNAME = QName.create(MODULE_QNAME, LIST_STREAM_NAME).intern();
183 public static final String LEAF_NAME_STREAM_NAME = "name";
184 public static final QName LEAF_NAME_STREAM_QNAME = QName.create(MODULE_QNAME, LEAF_NAME_STREAM_NAME).intern();
186 public static final String LEAF_DESCR_STREAM_NAME = "description";
187 public static final QName LEAF_DESCR_STREAM_QNAME = QName.create(MODULE_QNAME, LEAF_DESCR_STREAM_NAME).intern();
189 public static final String LEAF_REPLAY_SUPP_STREAM_NAME = "replay-support";
190 public static final QName LEAF_REPLAY_SUPP_STREAM_QNAME =
191 QName.create(MODULE_QNAME, LEAF_REPLAY_SUPP_STREAM_NAME).intern();
193 public static final String LEAF_START_TIME_STREAM_NAME = "replay-log-creation-time";
194 public static final QName LEAF_START_TIME_STREAM_QNAME =
195 QName.create(MODULE_QNAME, LEAF_START_TIME_STREAM_NAME).intern();
197 public static final String LIST_ACCESS_STREAM_NAME = "access";
198 public static final QName LIST_ACCESS_STREAM_QNAME = QName.create(MODULE_QNAME, LIST_ACCESS_STREAM_NAME)
201 public static final String LEAF_ENCODING_ACCESS_NAME = "encoding";
202 public static final QName LEAF_ENCODING_ACCESS_QNAME = QName.create(MODULE_QNAME, LEAF_ENCODING_ACCESS_NAME)
205 public static final String LEAF_LOCATION_ACCESS_NAME = "location";
206 public static final QName LEAF_LOCATION_ACCESS_QNAME = QName.create(MODULE_QNAME, LEAF_LOCATION_ACCESS_NAME)
210 * Constants for capabilities.
212 public static final class QueryParams {
214 private QueryParams() {
215 throw new UnsupportedOperationException("Util class");
218 public static final String URI_BASE = "urn:ietf:params:restconf:capability:";
220 public static final String DEPTH = URI_BASE + "depth:1.0";
221 public static final String FIELDS = URI_BASE + "fields:1.0";
222 public static final String FILTER = URI_BASE + "filter:1.0";
223 public static final String REPLAY = URI_BASE + "replay:1.0";
224 public static final String WITH_DEFAULTS = URI_BASE + "with-defaults:1.0";