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 java.text.ParseException;
12 import java.util.Date;
13 import org.opendaylight.yangtools.yang.common.QName;
14 import org.opendaylight.yangtools.yang.common.QNameModule;
15 import org.opendaylight.yangtools.yang.common.SimpleDateFormatUtil;
18 * Base Draft for Restconf project.
20 * <li>Supported {@link MediaTypes}
21 * <li>Constants for modules
23 * <li>{@link RestconfModule}
24 * <li>{@link MonitoringModule}
28 public final class Rfc8040 {
31 throw new UnsupportedOperationException("Util class");
35 * Set of application specific media types to identify each of the available
38 public static final class MediaTypes {
40 private MediaTypes() {
41 throw new UnsupportedOperationException("Util class");
44 public static final String DATA = "application/yang-data";
45 public static final String PATCH = "application/yang.patch";
46 public static final String PATCH_STATUS = "application/yang.patch-status";
47 public static final String YIN = "application/yin";
48 public static final String YANG = "application/yang";
52 * Constants for restconf module.
55 public static final class RestconfModule {
56 private RestconfModule() {
57 throw new UnsupportedOperationException("Util class");
60 public static final String REVISION = "2017-01-26";
61 public static final String NAME = "ietf-restconf";
62 public static final String NAMESPACE = "urn:ietf:params:xml:ns:yang:ietf-restconf";
64 public static final QName IETF_RESTCONF_QNAME = QName.create(Rfc8040.RestconfModule.NAMESPACE,
65 Rfc8040.RestconfModule.REVISION, Rfc8040.RestconfModule.NAME).intern();
67 public static final Date DATE;
71 DATE = SimpleDateFormatUtil.getRevisionFormat().parse(REVISION);
72 } catch (final ParseException e) {
73 throw new ExceptionInInitializerError(e);
77 public static final URI URI_MODULE = URI.create(NAMESPACE);
80 public static final String RESTCONF_GROUPING_SCHEMA_NODE = "restconf";
81 public static final String RESTCONF_CONTAINER_SCHEMA_NODE = "restconf";
82 public static final String OPERATIONS_CONTAINER_SCHEMA_NODE = "operations";
83 public static final String DATA_CONTAINER_SCHEMA_NODE = "data";
84 public static final String LIB_VER_LEAF_SCHEMA_NODE = "yang-library-version";
86 public static final QName RESTCONF_GROUPING_QNAME =
87 QName.create(IETF_RESTCONF_QNAME, RESTCONF_GROUPING_SCHEMA_NODE).intern();
88 public static final QName RESTCONF_CONTAINER_QNAME =
89 QName.create(IETF_RESTCONF_QNAME, RESTCONF_CONTAINER_SCHEMA_NODE).intern();
90 public static final QName LIB_VER_LEAF_QNAME = QName.create(IETF_RESTCONF_QNAME, LIB_VER_LEAF_SCHEMA_NODE)
94 public static final String ERRORS_GROUPING_SCHEMA_NODE = "errors";
95 public static final String ERRORS_CONTAINER_SCHEMA_NODE = "errors";
96 public static final String ERROR_LIST_SCHEMA_NODE = "error";
98 public static final QName ERRORS_CONTAINER_QNAME =
99 QName.create(IETF_RESTCONF_QNAME, ERRORS_CONTAINER_SCHEMA_NODE);
100 public static final QName ERROR_LIST_QNAME = QName.create(IETF_RESTCONF_QNAME, ERROR_LIST_SCHEMA_NODE).intern();
101 public static final QName ERROR_TYPE_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-type").intern();
102 public static final QName ERROR_TAG_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-tag".intern());
103 public static final QName ERROR_APP_TAG_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-app-tag").intern();
104 public static final QName ERROR_MESSAGE_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-message").intern();
105 public static final QName ERROR_INFO_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-info").intern();
106 public static final QName ERROR_PATH_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-path").intern();
110 * Constants for ietf-yang-library model.
113 public static final class IetfYangLibrary {
114 private IetfYangLibrary() {
115 throw new UnsupportedOperationException("Util class");
118 public static final String NAME = "ietf-yang-library";
119 public static final String NAMESPACE = "urn:ietf:params:xml:ns:yang:ietf-yang-library";
120 public static final String REVISION = "2016-06-21";
122 public static final Date DATE;
126 DATE = SimpleDateFormatUtil.getRevisionFormat().parse(REVISION);
127 } catch (final ParseException e) {
128 throw new ExceptionInInitializerError(e);
132 public static final URI URI_MODULE = URI.create(NAMESPACE);
134 public static final QNameModule MODULE_QNAME = QNameModule.create(URI_MODULE, DATE).intern();
136 public static final String MODULE_SET_ID_LEAF = "module-set-id";
137 public static final QName MODULE_SET_ID_LEAF_QNAME = QName.create(MODULE_QNAME, MODULE_SET_ID_LEAF).intern();
139 public static final String GROUPING_MODULE_LIST = "module-list";
140 public static final QName GROUPING_MODULE_LIST_QNAME = QName.create(MODULE_QNAME, GROUPING_MODULE_LIST)
143 public static final String MODULES_STATE_CONT = "modules-state";
144 public static final QName MODUELS_STATE_CONT_QNAME = QName.create(MODULE_QNAME, MODULES_STATE_CONT).intern();
146 public static final String MODULE_LIST = "module";
147 public static final QName MODULE_QNAME_LIST = QName.create(MODULE_QNAME, MODULE_LIST).intern();
149 public static final String SPECIFIC_MODULE_NAME_LEAF = "name";
150 public static final QName SPECIFIC_MODULE_NAME_LEAF_QNAME =
151 QName.create(MODULE_QNAME, SPECIFIC_MODULE_NAME_LEAF).intern();
153 public static final String SPECIFIC_MODULE_REVISION_LEAF = "revision";
154 public static final QName SPECIFIC_MODULE_REVISION_LEAF_QNAME =
155 QName.create(MODULE_QNAME, SPECIFIC_MODULE_REVISION_LEAF).intern();
157 public static final String BASE_URI_OF_SCHEMA = "/modules/";
158 public static final String SPECIFIC_MODULE_SCHEMA_LEAF = "schema";
159 public static final QName SPECIFIC_MODULE_SCHEMA_LEAF_QNAME =
160 QName.create(MODULE_QNAME, SPECIFIC_MODULE_SCHEMA_LEAF).intern();
162 public static final String SPECIFIC_MODULE_NAMESPACE_LEAF = "namespace";
163 public static final QName SPECIFIC_MODULE_NAMESPACE_LEAF_QNAME =
164 QName.create(MODULE_QNAME, SPECIFIC_MODULE_NAMESPACE_LEAF).intern();
166 public static final String SPECIFIC_MODULE_FEATURE_LEAF_LIST = "feature";
167 public static final QName SPECIFIC_MODULE_FEATURE_LEAF_LIST_QNAME =
168 QName.create(MODULE_QNAME, SPECIFIC_MODULE_FEATURE_LEAF_LIST).intern();
170 public static final String SPECIFIC_MODULE_DEVIATION_LIST = "deviation";
171 public static final QName SPECIFIC_MODULE_DEVIATION_LIST_QNAME =
172 QName.create(MODULE_QNAME, SPECIFIC_MODULE_DEVIATION_LIST).intern();
174 public static final String SPECIFIC_MODULE_CONFORMANCE_LEAF = "conformance-type";
175 public static final QName SPECIFIC_MODULE_CONFORMANCE_LEAF_QNAME =
176 QName.create(MODULE_QNAME, SPECIFIC_MODULE_CONFORMANCE_LEAF).intern();
178 public static final String SPECIFIC_MODULE_SUBMODULE_LIST = "submodule";
179 public static final QName SPECIFIC_MODULE_SUBMODULE_LIST_QNAME =
180 QName.create(MODULE_QNAME, SPECIFIC_MODULE_SUBMODULE_LIST).intern();
184 * Constants for ietf-restconf-monitoring module.
187 public static final class MonitoringModule {
189 private MonitoringModule() {
190 throw new UnsupportedOperationException("Util class");
193 public static final String NAME = "ietf-restconf-monitoring";
194 public static final String NAMESPACE = "urn:ietf:params:xml:ns:yang:ietf-restconf-monitoring";
195 public static final String REVISION = "2017-01-26";
196 public static final String PATH_TO_STREAM_WITHOUT_KEY =
197 "ietf-restconf-monitoring:restconf-state/streams/stream=";
198 public static final String PATH_TO_STREAMS = "ietf-restconf-monitoring:restconf-state/streams";
200 public static final Date DATE;
204 DATE = SimpleDateFormatUtil.getRevisionFormat().parse(REVISION);
205 } catch (final ParseException e) {
206 throw new ExceptionInInitializerError(e);
210 public static final URI URI_MODULE = URI.create(NAMESPACE);
212 public static final QNameModule MODULE_QNAME = QNameModule.create(URI_MODULE, DATE).intern();
214 public static final String CONT_RESTCONF_STATE_NAME = "restconf-state";
215 public static final QName CONT_RESTCONF_STATE_QNAME = QName.create(MODULE_QNAME, CONT_RESTCONF_STATE_NAME)
218 public static final String CONT_CAPABILITIES_NAME = "capabilities";
219 public static final QName CONT_CAPABILITES_QNAME = QName.create(MODULE_QNAME, CONT_CAPABILITIES_NAME).intern();
221 public static final String LEAF_LIST_CAPABILITY_NAME = "capability";
222 public static final QName LEAF_LIST_CAPABILITY_QNAME = QName.create(MODULE_QNAME, LEAF_LIST_CAPABILITY_NAME)
225 public static final String CONT_STREAMS_NAME = "streams";
226 public static final QName CONT_STREAMS_QNAME = QName.create(MODULE_QNAME, CONT_STREAMS_NAME).intern();
228 public static final String LIST_STREAM_NAME = "stream";
229 public static final QName LIST_STREAM_QNAME = QName.create(MODULE_QNAME, LIST_STREAM_NAME).intern();
231 public static final String LEAF_NAME_STREAM_NAME = "name";
232 public static final QName LEAF_NAME_STREAM_QNAME = QName.create(MODULE_QNAME, LEAF_NAME_STREAM_NAME).intern();
234 public static final String LEAF_DESCR_STREAM_NAME = "description";
235 public static final QName LEAF_DESCR_STREAM_QNAME = QName.create(MODULE_QNAME, LEAF_DESCR_STREAM_NAME).intern();
237 public static final String LEAF_REPLAY_SUPP_STREAM_NAME = "replay-support";
238 public static final QName LEAF_REPLAY_SUPP_STREAM_QNAME =
239 QName.create(MODULE_QNAME, LEAF_REPLAY_SUPP_STREAM_NAME).intern();
241 public static final String LEAF_START_TIME_STREAM_NAME = "replay-log-creation-time";
242 public static final QName LEAF_START_TIME_STREAM_QNAME =
243 QName.create(MODULE_QNAME, LEAF_START_TIME_STREAM_NAME).intern();
245 public static final String LIST_ACCESS_STREAM_NAME = "access";
246 public static final QName LIST_ACCESS_STREAM_QNAME = QName.create(MODULE_QNAME, LIST_ACCESS_STREAM_NAME)
249 public static final String LEAF_ENCODING_ACCESS_NAME = "encoding";
250 public static final QName LEAF_ENCODING_ACCESS_QNAME = QName.create(MODULE_QNAME, LEAF_ENCODING_ACCESS_NAME)
253 public static final String LEAF_LOCATION_ACCESS_NAME = "location";
254 public static final QName LEAF_LOCATION_ACCESS_QNAME = QName.create(MODULE_QNAME, LEAF_LOCATION_ACCESS_NAME)
258 * Constants for capabilities.
260 public static final class QueryParams {
262 private QueryParams() {
263 throw new UnsupportedOperationException("Util class");
266 public static final String URI_BASE = "urn:ietf:params:restconf:capability:";
268 public static final String DEPTH = URI_BASE + "depth:1.0";
269 public static final String FIELDS = URI_BASE + "fields:1.0";
270 public static final String FILTER = URI_BASE + "filter:1.0";
271 public static final String REPLAY = URI_BASE + "replay:1.0";
272 public static final String WITH_DEFAULTS = URI_BASE + "with-defaults:1.0";