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.yangtools.yang.common.QName;
12 import org.opendaylight.yangtools.yang.common.QNameModule;
13 import org.opendaylight.yangtools.yang.common.Revision;
16 * Base Draft for Restconf project.
18 * <li>Supported {@link MediaTypes}
19 * <li>Constants for modules
21 * <li>{@link RestconfModule}
22 * <li>{@link MonitoringModule}
26 public final class Rfc8040 {
29 throw new UnsupportedOperationException("Util class");
33 * Set of application specific media types to identify each of the available
36 public static final class MediaTypes {
38 private MediaTypes() {
39 throw new UnsupportedOperationException("Util class");
42 public static final String DATA = "application/yang-data";
43 public static final String PATCH = "application/yang.patch";
44 public static final String PATCH_STATUS = "application/yang.patch-status";
45 public static final String YIN = "application/yin";
46 public static final String YANG = "application/yang";
50 * Constants for restconf module.
53 public static final class RestconfModule {
54 private RestconfModule() {
55 throw new UnsupportedOperationException("Util class");
58 public static final Revision REVISION = Revision.of("2017-01-26");
59 public static final String NAME = "ietf-restconf";
60 public static final String NAMESPACE = "urn:ietf:params:xml:ns:yang:ietf-restconf";
61 public static final URI URI_MODULE = URI.create(NAMESPACE);
63 public static final QName IETF_RESTCONF_QNAME = QName.create(URI_MODULE,
64 Rfc8040.RestconfModule.REVISION, Rfc8040.RestconfModule.NAME).intern();
67 public static final String RESTCONF_GROUPING_SCHEMA_NODE = "restconf";
68 public static final String RESTCONF_CONTAINER_SCHEMA_NODE = "restconf";
69 public static final String OPERATIONS_CONTAINER_SCHEMA_NODE = "operations";
70 public static final String DATA_CONTAINER_SCHEMA_NODE = "data";
71 public static final String LIB_VER_LEAF_SCHEMA_NODE = "yang-library-version";
73 public static final QName RESTCONF_GROUPING_QNAME =
74 QName.create(IETF_RESTCONF_QNAME, RESTCONF_GROUPING_SCHEMA_NODE).intern();
75 public static final QName RESTCONF_CONTAINER_QNAME =
76 QName.create(IETF_RESTCONF_QNAME, RESTCONF_CONTAINER_SCHEMA_NODE).intern();
77 public static final QName LIB_VER_LEAF_QNAME = QName.create(IETF_RESTCONF_QNAME, LIB_VER_LEAF_SCHEMA_NODE)
81 public static final String ERRORS_GROUPING_SCHEMA_NODE = "errors";
82 public static final String ERRORS_CONTAINER_SCHEMA_NODE = "errors";
83 public static final String ERROR_LIST_SCHEMA_NODE = "error";
85 public static final QName ERRORS_GROUPING_QNAME =
86 QName.create(IETF_RESTCONF_QNAME, ERRORS_GROUPING_SCHEMA_NODE).intern();
87 public static final QName ERRORS_CONTAINER_QNAME =
88 QName.create(IETF_RESTCONF_QNAME, ERRORS_CONTAINER_SCHEMA_NODE).intern();
89 public static final QName ERROR_LIST_QNAME = QName.create(IETF_RESTCONF_QNAME, ERROR_LIST_SCHEMA_NODE).intern();
90 public static final QName ERROR_TYPE_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-type").intern();
91 public static final QName ERROR_TAG_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-tag").intern();
92 public static final QName ERROR_APP_TAG_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-app-tag").intern();
93 public static final QName ERROR_MESSAGE_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-message").intern();
94 public static final QName ERROR_INFO_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-info").intern();
95 public static final QName ERROR_PATH_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-path").intern();
99 * Constants for ietf-yang-library model.
102 public static final class IetfYangLibrary {
103 private IetfYangLibrary() {
104 throw new UnsupportedOperationException("Util class");
107 public static final String NAME = "ietf-yang-library";
108 public static final String NAMESPACE = "urn:ietf:params:xml:ns:yang:ietf-yang-library";
109 public static final URI URI_MODULE = URI.create(NAMESPACE);
110 public static final Revision REVISION = Revision.of("2016-06-21");
112 public static final QNameModule MODULE_QNAME = QNameModule.create(URI_MODULE, REVISION).intern();
114 public static final String MODULE_SET_ID_LEAF = "module-set-id";
115 public static final QName MODULE_SET_ID_LEAF_QNAME = QName.create(MODULE_QNAME, MODULE_SET_ID_LEAF).intern();
117 public static final String GROUPING_MODULE_LIST = "module-list";
118 public static final QName GROUPING_MODULE_LIST_QNAME = QName.create(MODULE_QNAME, GROUPING_MODULE_LIST)
121 public static final String MODULES_STATE_CONT = "modules-state";
122 public static final QName MODUELS_STATE_CONT_QNAME = QName.create(MODULE_QNAME, MODULES_STATE_CONT).intern();
124 public static final String MODULE_LIST = "module";
125 public static final QName MODULE_QNAME_LIST = QName.create(MODULE_QNAME, MODULE_LIST).intern();
127 public static final String SPECIFIC_MODULE_NAME_LEAF = "name";
128 public static final QName SPECIFIC_MODULE_NAME_LEAF_QNAME =
129 QName.create(MODULE_QNAME, SPECIFIC_MODULE_NAME_LEAF).intern();
131 public static final String SPECIFIC_MODULE_REVISION_LEAF = "revision";
132 public static final QName SPECIFIC_MODULE_REVISION_LEAF_QNAME =
133 QName.create(MODULE_QNAME, SPECIFIC_MODULE_REVISION_LEAF).intern();
135 public static final String BASE_URI_OF_SCHEMA = "/modules/";
136 public static final String SPECIFIC_MODULE_SCHEMA_LEAF = "schema";
137 public static final QName SPECIFIC_MODULE_SCHEMA_LEAF_QNAME =
138 QName.create(MODULE_QNAME, SPECIFIC_MODULE_SCHEMA_LEAF).intern();
140 public static final String SPECIFIC_MODULE_NAMESPACE_LEAF = "namespace";
141 public static final QName SPECIFIC_MODULE_NAMESPACE_LEAF_QNAME =
142 QName.create(MODULE_QNAME, SPECIFIC_MODULE_NAMESPACE_LEAF).intern();
144 public static final String SPECIFIC_MODULE_FEATURE_LEAF_LIST = "feature";
145 public static final QName SPECIFIC_MODULE_FEATURE_LEAF_LIST_QNAME =
146 QName.create(MODULE_QNAME, SPECIFIC_MODULE_FEATURE_LEAF_LIST).intern();
148 public static final String SPECIFIC_MODULE_DEVIATION_LIST = "deviation";
149 public static final QName SPECIFIC_MODULE_DEVIATION_LIST_QNAME =
150 QName.create(MODULE_QNAME, SPECIFIC_MODULE_DEVIATION_LIST).intern();
152 public static final String SPECIFIC_MODULE_CONFORMANCE_LEAF = "conformance-type";
153 public static final QName SPECIFIC_MODULE_CONFORMANCE_LEAF_QNAME =
154 QName.create(MODULE_QNAME, SPECIFIC_MODULE_CONFORMANCE_LEAF).intern();
156 public static final String SPECIFIC_MODULE_SUBMODULE_LIST = "submodule";
157 public static final QName SPECIFIC_MODULE_SUBMODULE_LIST_QNAME =
158 QName.create(MODULE_QNAME, SPECIFIC_MODULE_SUBMODULE_LIST).intern();
162 * Constants for ietf-restconf-monitoring module.
165 public static final class MonitoringModule {
167 private MonitoringModule() {
168 throw new UnsupportedOperationException("Util class");
171 public static final String NAME = "ietf-restconf-monitoring";
172 public static final String NAMESPACE = "urn:ietf:params:xml:ns:yang:ietf-restconf-monitoring";
173 public static final Revision REVISION = Revision.of("2017-01-26");
174 public static final String PATH_TO_STREAM_WITHOUT_KEY =
175 "ietf-restconf-monitoring:restconf-state/streams/stream=";
176 public static final String PATH_TO_STREAMS = "ietf-restconf-monitoring:restconf-state/streams";
178 public static final URI URI_MODULE = URI.create(NAMESPACE);
180 public static final QNameModule MODULE_QNAME = QNameModule.create(URI_MODULE, REVISION).intern();
182 public static final String CONT_RESTCONF_STATE_NAME = "restconf-state";
183 public static final QName CONT_RESTCONF_STATE_QNAME = QName.create(MODULE_QNAME, CONT_RESTCONF_STATE_NAME)
186 public static final String CONT_CAPABILITIES_NAME = "capabilities";
187 public static final QName CONT_CAPABILITES_QNAME = QName.create(MODULE_QNAME, CONT_CAPABILITIES_NAME).intern();
189 public static final String LEAF_LIST_CAPABILITY_NAME = "capability";
190 public static final QName LEAF_LIST_CAPABILITY_QNAME = QName.create(MODULE_QNAME, LEAF_LIST_CAPABILITY_NAME)
193 public static final String CONT_STREAMS_NAME = "streams";
194 public static final QName CONT_STREAMS_QNAME = QName.create(MODULE_QNAME, CONT_STREAMS_NAME).intern();
196 public static final String LIST_STREAM_NAME = "stream";
197 public static final QName LIST_STREAM_QNAME = QName.create(MODULE_QNAME, LIST_STREAM_NAME).intern();
199 public static final String LEAF_NAME_STREAM_NAME = "name";
200 public static final QName LEAF_NAME_STREAM_QNAME = QName.create(MODULE_QNAME, LEAF_NAME_STREAM_NAME).intern();
202 public static final String LEAF_DESCR_STREAM_NAME = "description";
203 public static final QName LEAF_DESCR_STREAM_QNAME = QName.create(MODULE_QNAME, LEAF_DESCR_STREAM_NAME).intern();
205 public static final String LEAF_REPLAY_SUPP_STREAM_NAME = "replay-support";
206 public static final QName LEAF_REPLAY_SUPP_STREAM_QNAME =
207 QName.create(MODULE_QNAME, LEAF_REPLAY_SUPP_STREAM_NAME).intern();
209 public static final String LEAF_START_TIME_STREAM_NAME = "replay-log-creation-time";
210 public static final QName LEAF_START_TIME_STREAM_QNAME =
211 QName.create(MODULE_QNAME, LEAF_START_TIME_STREAM_NAME).intern();
213 public static final String LIST_ACCESS_STREAM_NAME = "access";
214 public static final QName LIST_ACCESS_STREAM_QNAME = QName.create(MODULE_QNAME, LIST_ACCESS_STREAM_NAME)
217 public static final String LEAF_ENCODING_ACCESS_NAME = "encoding";
218 public static final QName LEAF_ENCODING_ACCESS_QNAME = QName.create(MODULE_QNAME, LEAF_ENCODING_ACCESS_NAME)
221 public static final String LEAF_LOCATION_ACCESS_NAME = "location";
222 public static final QName LEAF_LOCATION_ACCESS_QNAME = QName.create(MODULE_QNAME, LEAF_LOCATION_ACCESS_NAME)
226 * Constants for capabilities.
228 public static final class QueryParams {
230 private QueryParams() {
231 throw new UnsupportedOperationException("Util class");
234 public static final String URI_BASE = "urn:ietf:params:restconf:capability:";
236 public static final String DEPTH = URI_BASE + "depth:1.0";
237 public static final String FIELDS = URI_BASE + "fields:1.0";
238 public static final String FILTER = URI_BASE + "filter:1.0";
239 public static final String REPLAY = URI_BASE + "replay:1.0";
240 public static final String WITH_DEFAULTS = URI_BASE + "with-defaults:1.0";