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.rev160621.$YangModuleInfoImpl;
12 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev160621.module.list.Module;
13 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev160621.module.list.module.Deviation;
14 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev160621.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");
46 public static final String DATA = "application/yang-data";
47 public static final String YANG_PATCH = "application/yang.patch";
48 public static final String YANG_PATCH_STATUS = "application/yang.patch-status";
52 * Constants for restconf module.
55 public static final class RestconfModule {
56 private RestconfModule() {
57 throw new UnsupportedOperationException("Util class");
60 public static final Revision REVISION = Revision.of("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";
63 public static final URI URI_MODULE = URI.create(NAMESPACE);
65 public static final QName IETF_RESTCONF_QNAME = QName.create(URI_MODULE,
66 Rfc8040.RestconfModule.REVISION, Rfc8040.RestconfModule.NAME).intern();
69 public static final String RESTCONF_GROUPING_SCHEMA_NODE = "restconf";
70 public static final String RESTCONF_CONTAINER_SCHEMA_NODE = "restconf";
71 public static final String OPERATIONS_CONTAINER_SCHEMA_NODE = "operations";
72 public static final String DATA_CONTAINER_SCHEMA_NODE = "data";
73 public static final String LIB_VER_LEAF_SCHEMA_NODE = "yang-library-version";
75 public static final QName RESTCONF_GROUPING_QNAME =
76 QName.create(IETF_RESTCONF_QNAME, RESTCONF_GROUPING_SCHEMA_NODE).intern();
77 public static final QName RESTCONF_CONTAINER_QNAME =
78 QName.create(IETF_RESTCONF_QNAME, RESTCONF_CONTAINER_SCHEMA_NODE).intern();
79 public static final QName LIB_VER_LEAF_QNAME = QName.create(IETF_RESTCONF_QNAME, LIB_VER_LEAF_SCHEMA_NODE)
83 public static final String ERRORS_GROUPING_SCHEMA_NODE = "errors";
84 public static final String ERRORS_CONTAINER_SCHEMA_NODE = "errors";
85 public static final String ERROR_LIST_SCHEMA_NODE = "error";
87 public static final QName ERRORS_GROUPING_QNAME =
88 QName.create(IETF_RESTCONF_QNAME, ERRORS_GROUPING_SCHEMA_NODE).intern();
89 public static final QName ERRORS_CONTAINER_QNAME =
90 QName.create(IETF_RESTCONF_QNAME, ERRORS_CONTAINER_SCHEMA_NODE).intern();
91 public static final QName ERROR_LIST_QNAME = QName.create(IETF_RESTCONF_QNAME, ERROR_LIST_SCHEMA_NODE).intern();
92 public static final QName ERROR_TYPE_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-type").intern();
93 public static final QName ERROR_TAG_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-tag").intern();
94 public static final QName ERROR_APP_TAG_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-app-tag").intern();
95 public static final QName ERROR_MESSAGE_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-message").intern();
96 public static final QName ERROR_INFO_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-info").intern();
97 public static final QName ERROR_PATH_QNAME = QName.create(IETF_RESTCONF_QNAME, "error-path").intern();
101 * Constants for ietf-yang-library model.
104 public static final class IetfYangLibrary {
105 private IetfYangLibrary() {
106 throw new UnsupportedOperationException("Util class");
109 public static final QNameModule MODULE_QNAME = $YangModuleInfoImpl.getInstance().getName().getModule();
110 public static final Revision REVISION = MODULE_QNAME.getRevision().orElseThrow();
112 public static final QName MODULE_SET_ID_LEAF_QNAME = QName.create(MODULE_QNAME, "module-set-id").intern();
114 public static final QName MODULE_QNAME_LIST = Module.QNAME;
116 public static final String SPECIFIC_MODULE_NAME_LEAF = "name";
117 public static final QName SPECIFIC_MODULE_NAME_LEAF_QNAME =
118 QName.create(MODULE_QNAME, SPECIFIC_MODULE_NAME_LEAF).intern();
120 public static final String SPECIFIC_MODULE_REVISION_LEAF = "revision";
121 public static final QName SPECIFIC_MODULE_REVISION_LEAF_QNAME =
122 QName.create(MODULE_QNAME, SPECIFIC_MODULE_REVISION_LEAF).intern();
124 public static final String BASE_URI_OF_SCHEMA = "/modules/";
125 public static final QName SPECIFIC_MODULE_SCHEMA_LEAF_QNAME = QName.create(MODULE_QNAME, "schema").intern();
126 public static final QName SPECIFIC_MODULE_NAMESPACE_LEAF_QNAME =
127 QName.create(MODULE_QNAME, "namespace").intern();
129 public static final QName SPECIFIC_MODULE_FEATURE_LEAF_LIST_QNAME =
130 QName.create(MODULE_QNAME, "feature").intern();
132 public static final QName SPECIFIC_MODULE_DEVIATION_LIST_QNAME = Deviation.QNAME;
134 public static final QName SPECIFIC_MODULE_CONFORMANCE_LEAF_QNAME =
135 QName.create(MODULE_QNAME, "conformance-type").intern();
137 public static final QName SPECIFIC_MODULE_SUBMODULE_LIST_QNAME = Submodule.QNAME;
141 * Constants for ietf-restconf-monitoring module.
144 public static final class MonitoringModule {
146 private MonitoringModule() {
147 throw new UnsupportedOperationException("Util class");
150 public static final String NAME = "ietf-restconf-monitoring";
151 public static final String NAMESPACE = "urn:ietf:params:xml:ns:yang:ietf-restconf-monitoring";
152 public static final Revision REVISION = Revision.of("2017-01-26");
153 public static final String PATH_TO_STREAM_WITHOUT_KEY =
154 "ietf-restconf-monitoring:restconf-state/streams/stream=";
155 public static final String PATH_TO_STREAMS = "ietf-restconf-monitoring:restconf-state/streams";
157 public static final URI URI_MODULE = URI.create(NAMESPACE);
159 public static final QNameModule MODULE_QNAME = QNameModule.create(URI_MODULE, REVISION).intern();
161 public static final String CONT_RESTCONF_STATE_NAME = "restconf-state";
162 public static final QName CONT_RESTCONF_STATE_QNAME = QName.create(MODULE_QNAME, CONT_RESTCONF_STATE_NAME)
165 public static final String CONT_CAPABILITIES_NAME = "capabilities";
166 public static final QName CONT_CAPABILITES_QNAME = QName.create(MODULE_QNAME, CONT_CAPABILITIES_NAME).intern();
168 public static final String LEAF_LIST_CAPABILITY_NAME = "capability";
169 public static final QName LEAF_LIST_CAPABILITY_QNAME = QName.create(MODULE_QNAME, LEAF_LIST_CAPABILITY_NAME)
172 public static final String CONT_STREAMS_NAME = "streams";
173 public static final QName CONT_STREAMS_QNAME = QName.create(MODULE_QNAME, CONT_STREAMS_NAME).intern();
175 public static final String LIST_STREAM_NAME = "stream";
176 public static final QName LIST_STREAM_QNAME = QName.create(MODULE_QNAME, LIST_STREAM_NAME).intern();
178 public static final String LEAF_NAME_STREAM_NAME = "name";
179 public static final QName LEAF_NAME_STREAM_QNAME = QName.create(MODULE_QNAME, LEAF_NAME_STREAM_NAME).intern();
181 public static final String LEAF_DESCR_STREAM_NAME = "description";
182 public static final QName LEAF_DESCR_STREAM_QNAME = QName.create(MODULE_QNAME, LEAF_DESCR_STREAM_NAME).intern();
184 public static final String LEAF_REPLAY_SUPP_STREAM_NAME = "replay-support";
185 public static final QName LEAF_REPLAY_SUPP_STREAM_QNAME =
186 QName.create(MODULE_QNAME, LEAF_REPLAY_SUPP_STREAM_NAME).intern();
188 public static final String LEAF_START_TIME_STREAM_NAME = "replay-log-creation-time";
189 public static final QName LEAF_START_TIME_STREAM_QNAME =
190 QName.create(MODULE_QNAME, LEAF_START_TIME_STREAM_NAME).intern();
192 public static final String LIST_ACCESS_STREAM_NAME = "access";
193 public static final QName LIST_ACCESS_STREAM_QNAME = QName.create(MODULE_QNAME, LIST_ACCESS_STREAM_NAME)
196 public static final String LEAF_ENCODING_ACCESS_NAME = "encoding";
197 public static final QName LEAF_ENCODING_ACCESS_QNAME = QName.create(MODULE_QNAME, LEAF_ENCODING_ACCESS_NAME)
200 public static final String LEAF_LOCATION_ACCESS_NAME = "location";
201 public static final QName LEAF_LOCATION_ACCESS_QNAME = QName.create(MODULE_QNAME, LEAF_LOCATION_ACCESS_NAME)
205 * Constants for capabilities.
207 public static final class QueryParams {
209 private QueryParams() {
210 throw new UnsupportedOperationException("Util class");
213 public static final String URI_BASE = "urn:ietf:params:restconf:capability:";
215 public static final String DEPTH = URI_BASE + "depth:1.0";
216 public static final String FIELDS = URI_BASE + "fields:1.0";
217 public static final String FILTER = URI_BASE + "filter:1.0";
218 public static final String REPLAY = URI_BASE + "replay:1.0";
219 public static final String WITH_DEFAULTS = URI_BASE + "with-defaults:1.0";