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.jaxrs;
10 import static java.util.Objects.requireNonNull;
12 import java.io.IOException;
13 import java.io.InputStream;
14 import java.io.Reader;
15 import java.lang.annotation.Annotation;
16 import java.lang.reflect.Type;
17 import java.text.ParseException;
18 import java.util.Date;
19 import java.util.List;
20 import javax.inject.Singleton;
21 import javax.ws.rs.Consumes;
22 import javax.ws.rs.DELETE;
23 import javax.ws.rs.Encoded;
24 import javax.ws.rs.GET;
25 import javax.ws.rs.PATCH;
26 import javax.ws.rs.POST;
27 import javax.ws.rs.PUT;
28 import javax.ws.rs.Path;
29 import javax.ws.rs.PathParam;
30 import javax.ws.rs.Produces;
31 import javax.ws.rs.QueryParam;
32 import javax.ws.rs.container.AsyncResponse;
33 import javax.ws.rs.container.Suspended;
34 import javax.ws.rs.core.CacheControl;
35 import javax.ws.rs.core.Context;
36 import javax.ws.rs.core.EntityTag;
37 import javax.ws.rs.core.MediaType;
38 import javax.ws.rs.core.Response;
39 import javax.ws.rs.core.Response.ResponseBuilder;
40 import javax.ws.rs.core.Response.Status;
41 import javax.ws.rs.core.UriInfo;
42 import javax.ws.rs.ext.ParamConverter;
43 import javax.ws.rs.ext.ParamConverterProvider;
44 import org.eclipse.jdt.annotation.NonNull;
45 import org.eclipse.jdt.annotation.Nullable;
46 import org.opendaylight.restconf.api.ApiPath;
47 import org.opendaylight.restconf.api.FormattableBody;
48 import org.opendaylight.restconf.api.MediaTypes;
49 import org.opendaylight.restconf.api.query.PrettyPrintParam;
50 import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
51 import org.opendaylight.restconf.common.errors.RestconfError;
52 import org.opendaylight.restconf.common.errors.RestconfFuture;
53 import org.opendaylight.restconf.nb.rfc8040.URLConstants;
54 import org.opendaylight.restconf.nb.rfc8040.databind.jaxrs.QueryParams;
55 import org.opendaylight.restconf.nb.rfc8040.legacy.ErrorTags;
56 import org.opendaylight.restconf.nb.rfc8040.legacy.NormalizedNodePayload;
57 import org.opendaylight.restconf.server.api.ConfigurationMetadata;
58 import org.opendaylight.restconf.server.api.CreateResourceResult;
59 import org.opendaylight.restconf.server.api.DataGetResult;
60 import org.opendaylight.restconf.server.api.DataPatchResult;
61 import org.opendaylight.restconf.server.api.DataPostResult;
62 import org.opendaylight.restconf.server.api.DataPutResult;
63 import org.opendaylight.restconf.server.api.DataYangPatchResult;
64 import org.opendaylight.restconf.server.api.InvokeResult;
65 import org.opendaylight.restconf.server.api.JsonChildBody;
66 import org.opendaylight.restconf.server.api.JsonDataPostBody;
67 import org.opendaylight.restconf.server.api.JsonOperationInputBody;
68 import org.opendaylight.restconf.server.api.JsonPatchBody;
69 import org.opendaylight.restconf.server.api.JsonResourceBody;
70 import org.opendaylight.restconf.server.api.ModulesGetResult;
71 import org.opendaylight.restconf.server.api.OperationInputBody;
72 import org.opendaylight.restconf.server.api.PatchStatusContext;
73 import org.opendaylight.restconf.server.api.RestconfServer;
74 import org.opendaylight.restconf.server.api.XmlChildBody;
75 import org.opendaylight.restconf.server.api.XmlDataPostBody;
76 import org.opendaylight.restconf.server.api.XmlOperationInputBody;
77 import org.opendaylight.restconf.server.api.XmlPatchBody;
78 import org.opendaylight.restconf.server.api.XmlResourceBody;
79 import org.opendaylight.restconf.server.spi.YangPatchStatusBody;
80 import org.opendaylight.yangtools.yang.common.Empty;
81 import org.opendaylight.yangtools.yang.common.YangConstants;
82 import org.slf4j.Logger;
83 import org.slf4j.LoggerFactory;
86 * Baseline RESTCONF implementation with JAX-RS. Interfaces to a {@link RestconfServer}. Since we need {@link ApiPath}
87 * arguments, we also implement {@link ParamConverterProvider} and provide the appropriate converter. This has the nice
88 * side-effect of suppressing <a href="https://github.com/eclipse-ee4j/jersey/issues/3700">Jersey warnings</a>.
92 public final class JaxRsRestconf implements ParamConverterProvider {
93 private static final Logger LOG = LoggerFactory.getLogger(JaxRsRestconf.class);
94 private static final CacheControl NO_CACHE = CacheControl.valueOf("no-cache");
95 private static final ParamConverter<ApiPath> API_PATH_CONVERTER = new ParamConverter<>() {
97 public ApiPath fromString(final String value) {
98 final var str = nonnull(value);
100 return ApiPath.parseUrl(str);
101 } catch (ParseException e) {
102 throw new IllegalArgumentException(e.getMessage(), e);
107 public String toString(final ApiPath value) {
108 return nonnull(value).toString();
111 private static <T> @NonNull T nonnull(final @Nullable T value) {
113 throw new IllegalArgumentException("value must not be null");
119 private final RestconfServer server;
121 public JaxRsRestconf(final RestconfServer server) {
122 this.server = requireNonNull(server);
126 @SuppressWarnings("unchecked")
127 public <T> ParamConverter<T> getConverter(final Class<T> rawType, final Type genericType,
128 final Annotation[] annotations) {
129 return ApiPath.class.equals(rawType) ? (ParamConverter<T>) API_PATH_CONVERTER : null;
133 * Delete the target data resource.
135 * @param identifier path to target
136 * @param ar {@link AsyncResponse} which needs to be completed
139 @Path("/data/{identifier:.+}")
140 @SuppressWarnings("checkstyle:abbreviationAsWordInName")
141 public void dataDELETE(@Encoded @PathParam("identifier") final ApiPath identifier,
142 @Suspended final AsyncResponse ar) {
143 server.dataDELETE(identifier).addCallback(new JaxRsRestconfCallback<>(ar) {
145 Response transform(final Empty result) {
146 return Response.noContent().build();
152 * Get target data resource from data root.
154 * @param uriInfo URI info
155 * @param ar {@link AsyncResponse} which needs to be completed
160 MediaTypes.APPLICATION_YANG_DATA_JSON,
161 MediaTypes.APPLICATION_YANG_DATA_XML,
162 MediaType.APPLICATION_JSON,
163 MediaType.APPLICATION_XML,
166 public void dataGET(@Context final UriInfo uriInfo, @Suspended final AsyncResponse ar) {
167 completeDataGET(server.dataGET(QueryParams.newDataGetParams(uriInfo)), ar);
171 * Get target data resource.
173 * @param identifier path to target
174 * @param uriInfo URI info
175 * @param ar {@link AsyncResponse} which needs to be completed
178 @Path("/data/{identifier:.+}")
180 MediaTypes.APPLICATION_YANG_DATA_JSON,
181 MediaTypes.APPLICATION_YANG_DATA_XML,
182 MediaType.APPLICATION_JSON,
183 MediaType.APPLICATION_XML,
186 public void dataGET(@Encoded @PathParam("identifier") final ApiPath identifier, @Context final UriInfo uriInfo,
187 @Suspended final AsyncResponse ar) {
188 completeDataGET(server.dataGET(identifier, QueryParams.newDataGetParams(uriInfo)), ar);
191 private static void completeDataGET(final RestconfFuture<DataGetResult> future, final AsyncResponse ar) {
192 future.addCallback(new JaxRsRestconfCallback<>(ar) {
194 Response transform(final DataGetResult result) {
195 final var builder = Response.ok().entity(result.payload()).cacheControl(NO_CACHE);
196 fillConfigurationMetadata(builder, result);
197 return builder.build();
202 private static void fillConfigurationMetadata(final ResponseBuilder builder, final ConfigurationMetadata metadata) {
203 final var etag = metadata.entityTag();
205 builder.tag(new EntityTag(etag.value(), etag.weak()));
207 final var lastModified = metadata.lastModified();
208 if (lastModified != null) {
209 builder.lastModified(Date.from(lastModified));
214 * Partially modify the target data store, as defined in
215 * <a href="https://www.rfc-editor.org/rfc/rfc8040#section-4.6.1">RFC8040, section 4.6.1</a>.
217 * @param body data node for put to config DS
218 * @param ar {@link AsyncResponse} which needs to be completed
223 MediaTypes.APPLICATION_YANG_DATA_XML,
224 MediaType.APPLICATION_XML,
227 public void dataXmlPATCH(final InputStream body, @Suspended final AsyncResponse ar) {
228 try (var xmlBody = new XmlResourceBody(body)) {
229 completeDataPATCH(server.dataPATCH(xmlBody), ar);
234 * Partially modify the target data resource, as defined in
235 * <a href="https://www.rfc-editor.org/rfc/rfc8040#section-4.6.1">RFC8040, section 4.6.1</a>.
237 * @param identifier path to target
238 * @param body data node for put to config DS
239 * @param ar {@link AsyncResponse} which needs to be completed
242 @Path("/data/{identifier:.+}")
244 MediaTypes.APPLICATION_YANG_DATA_XML,
245 MediaType.APPLICATION_XML,
248 public void dataXmlPATCH(@Encoded @PathParam("identifier") final ApiPath identifier, final InputStream body,
249 @Suspended final AsyncResponse ar) {
250 try (var xmlBody = new XmlResourceBody(body)) {
251 completeDataPATCH(server.dataPATCH(identifier, xmlBody), ar);
256 * Partially modify the target data store, as defined in
257 * <a href="https://www.rfc-editor.org/rfc/rfc8040#section-4.6.1">RFC8040, section 4.6.1</a>.
259 * @param body data node for put to config DS
260 * @param ar {@link AsyncResponse} which needs to be completed
265 MediaTypes.APPLICATION_YANG_DATA_JSON,
266 MediaType.APPLICATION_JSON,
268 public void dataJsonPATCH(final InputStream body, @Suspended final AsyncResponse ar) {
269 try (var jsonBody = new JsonResourceBody(body)) {
270 completeDataPATCH(server.dataPATCH(jsonBody), ar);
275 * Partially modify the target data resource, as defined in
276 * <a href="https://www.rfc-editor.org/rfc/rfc8040#section-4.6.1">RFC8040, section 4.6.1</a>.
278 * @param identifier path to target
279 * @param body data node for put to config DS
280 * @param ar {@link AsyncResponse} which needs to be completed
283 @Path("/data/{identifier:.+}")
285 MediaTypes.APPLICATION_YANG_DATA_JSON,
286 MediaType.APPLICATION_JSON,
288 public void dataJsonPATCH(@Encoded @PathParam("identifier") final ApiPath identifier, final InputStream body,
289 @Suspended final AsyncResponse ar) {
290 try (var jsonBody = new JsonResourceBody(body)) {
291 completeDataPATCH(server.dataPATCH(identifier, jsonBody), ar);
295 private static void completeDataPATCH(final RestconfFuture<DataPatchResult> future, final AsyncResponse ar) {
296 future.addCallback(new JaxRsRestconfCallback<>(ar) {
298 Response transform(final DataPatchResult result) {
299 final var builder = Response.ok();
300 fillConfigurationMetadata(builder, result);
301 return builder.build();
307 * Ordered list of edits that are applied to the datastore by the server, as defined in
308 * <a href="https://www.rfc-editor.org/rfc/rfc8072#section-2">RFC8072, section 2</a>.
310 * @param body YANG Patch body
311 * @param ar {@link AsyncResponse} which needs to be completed with a {@link PatchStatusContext}
315 @Consumes(MediaTypes.APPLICATION_YANG_PATCH_JSON)
317 MediaTypes.APPLICATION_YANG_DATA_JSON,
318 MediaTypes.APPLICATION_YANG_DATA_XML
320 public void dataYangJsonPATCH(final InputStream body, @Suspended final AsyncResponse ar) {
321 try (var jsonBody = new JsonPatchBody(body)) {
322 completeDataYangPATCH(server.dataPATCH(jsonBody), ar);
327 * Ordered list of edits that are applied to the target datastore by the server, as defined in
328 * <a href="https://www.rfc-editor.org/rfc/rfc8072#section-2">RFC8072, section 2</a>.
330 * @param identifier path to target
331 * @param body YANG Patch body
332 * @param ar {@link AsyncResponse} which needs to be completed with a {@link PatchStatusContext}
335 @Path("/data/{identifier:.+}")
336 @Consumes(MediaTypes.APPLICATION_YANG_PATCH_JSON)
338 MediaTypes.APPLICATION_YANG_DATA_JSON,
339 MediaTypes.APPLICATION_YANG_DATA_XML
341 public void dataYangJsonPATCH(@Encoded @PathParam("identifier") final ApiPath identifier, final InputStream body,
342 @Suspended final AsyncResponse ar) {
343 try (var jsonBody = new JsonPatchBody(body)) {
344 completeDataYangPATCH(server.dataPATCH(identifier, jsonBody), ar);
349 * Ordered list of edits that are applied to the datastore by the server, as defined in
350 * <a href="https://www.rfc-editor.org/rfc/rfc8072#section-2">RFC8072, section 2</a>.
352 * @param body YANG Patch body
353 * @param ar {@link AsyncResponse} which needs to be completed with a {@link PatchStatusContext}
357 @Consumes(MediaTypes.APPLICATION_YANG_PATCH_XML)
359 MediaTypes.APPLICATION_YANG_DATA_JSON,
360 MediaTypes.APPLICATION_YANG_DATA_XML
362 public void dataYangXmlPATCH(final InputStream body, @Suspended final AsyncResponse ar) {
363 try (var xmlBody = new XmlPatchBody(body)) {
364 completeDataYangPATCH(server.dataPATCH(xmlBody), ar);
369 * Ordered list of edits that are applied to the target datastore by the server, as defined in
370 * <a href="https://www.rfc-editor.org/rfc/rfc8072#section-2">RFC8072, section 2</a>.
372 * @param identifier path to target
373 * @param body YANG Patch body
374 * @param ar {@link AsyncResponse} which needs to be completed with a {@link PatchStatusContext}
377 @Path("/data/{identifier:.+}")
378 @Consumes(MediaTypes.APPLICATION_YANG_PATCH_XML)
380 MediaTypes.APPLICATION_YANG_DATA_JSON,
381 MediaTypes.APPLICATION_YANG_DATA_XML
383 public void dataYangXmlPATCH(@Encoded @PathParam("identifier") final ApiPath identifier, final InputStream body,
384 @Suspended final AsyncResponse ar) {
385 try (var xmlBody = new XmlPatchBody(body)) {
386 completeDataYangPATCH(server.dataPATCH(identifier, xmlBody), ar);
390 private static void completeDataYangPATCH(final RestconfFuture<DataYangPatchResult> future,
391 final AsyncResponse ar) {
392 future.addCallback(new JaxRsRestconfCallback<>(ar) {
394 Response transform(final DataYangPatchResult result) {
395 final var status = result.status();
396 final var builder = Response.status(statusOf(status))
397 .entity(new YangPatchStatusBody(() -> PrettyPrintParam.FALSE, status));
398 fillConfigurationMetadata(builder, result);
399 return builder.build();
402 private static Status statusOf(final PatchStatusContext result) {
406 final var globalErrors = result.globalErrors();
407 if (globalErrors != null && !globalErrors.isEmpty()) {
408 return statusOfFirst(globalErrors);
410 for (var edit : result.editCollection()) {
412 final var editErrors = edit.getEditErrors();
413 if (editErrors != null && !editErrors.isEmpty()) {
414 return statusOfFirst(editErrors);
418 return Status.INTERNAL_SERVER_ERROR;
421 private static Status statusOfFirst(final List<RestconfError> error) {
422 return ErrorTags.statusOf(error.get(0).getErrorTag());
428 * Create a top-level data resource.
430 * @param body data node for put to config DS
431 * @param uriInfo URI info
432 * @param ar {@link AsyncResponse} which needs to be completed
437 MediaTypes.APPLICATION_YANG_DATA_JSON,
438 MediaType.APPLICATION_JSON,
440 public void postDataJSON(final InputStream body, @Context final UriInfo uriInfo,
441 @Suspended final AsyncResponse ar) {
442 try (var jsonBody = new JsonChildBody(body)) {
443 completeDataPOST(server.dataPOST(jsonBody, QueryParams.normalize(uriInfo)), uriInfo, ar);
448 * Create a data resource in target.
450 * @param identifier path to target
451 * @param body data node for put to config DS
452 * @param uriInfo URI info
453 * @param ar {@link AsyncResponse} which needs to be completed
456 @Path("/data/{identifier:.+}")
458 MediaTypes.APPLICATION_YANG_DATA_JSON,
459 MediaType.APPLICATION_JSON,
461 public void postDataJSON(@Encoded @PathParam("identifier") final ApiPath identifier, final InputStream body,
462 @Context final UriInfo uriInfo, @Suspended final AsyncResponse ar) {
463 completeDataPOST(server.dataPOST(identifier, new JsonDataPostBody(body), QueryParams.normalize(uriInfo)),
468 * Create a top-level data resource.
470 * @param body data node for put to config DS
471 * @param uriInfo URI info
472 * @param ar {@link AsyncResponse} which needs to be completed
477 MediaTypes.APPLICATION_YANG_DATA_XML,
478 MediaType.APPLICATION_XML,
481 public void postDataXML(final InputStream body, @Context final UriInfo uriInfo, @Suspended final AsyncResponse ar) {
482 try (var xmlBody = new XmlChildBody(body)) {
483 completeDataPOST(server.dataPOST(xmlBody, QueryParams.normalize(uriInfo)), uriInfo, ar);
488 * Create a data resource in target.
490 * @param identifier path to target
491 * @param body data node for put to config DS
492 * @param uriInfo URI info
493 * @param ar {@link AsyncResponse} which needs to be completed
496 @Path("/data/{identifier:.+}")
498 MediaTypes.APPLICATION_YANG_DATA_XML,
499 MediaType.APPLICATION_XML,
502 public void postDataXML(@Encoded @PathParam("identifier") final ApiPath identifier, final InputStream body,
503 @Context final UriInfo uriInfo, @Suspended final AsyncResponse ar) {
504 completeDataPOST(server.dataPOST(identifier, new XmlDataPostBody(body), QueryParams.normalize(uriInfo)),
508 private static void completeDataPOST(final RestconfFuture<? extends DataPostResult> future, final UriInfo uriInfo,
509 final AsyncResponse ar) {
510 future.addCallback(new JaxRsRestconfCallback<DataPostResult>(ar) {
512 Response transform(final DataPostResult result) {
513 if (result instanceof CreateResourceResult createResource) {
514 final var builder = Response.created(uriInfo.getBaseUriBuilder()
516 .path(createResource.createdPath().toString())
518 fillConfigurationMetadata(builder, createResource);
519 return builder.build();
521 if (result instanceof InvokeResult invokeOperation) {
522 final var output = invokeOperation.output();
523 return output == null ? Response.noContent().build() : Response.ok().entity(output).build();
525 LOG.error("Unhandled result {}", result);
526 return Response.serverError().build();
532 * Replace the data store.
534 * @param uriInfo request URI information
535 * @param body data node for put to config DS
536 * @param ar {@link AsyncResponse} which needs to be completed
541 MediaTypes.APPLICATION_YANG_DATA_JSON,
542 MediaType.APPLICATION_JSON,
544 public void dataJsonPUT(@Context final UriInfo uriInfo, final InputStream body, @Suspended final AsyncResponse ar) {
545 try (var jsonBody = new JsonResourceBody(body)) {
546 completeDataPUT(server.dataPUT(jsonBody, QueryParams.normalize(uriInfo)), ar);
551 * Create or replace the target data resource.
553 * @param identifier path to target
554 * @param uriInfo request URI information
555 * @param body data node for put to config DS
556 * @param ar {@link AsyncResponse} which needs to be completed
559 @Path("/data/{identifier:.+}")
561 MediaTypes.APPLICATION_YANG_DATA_JSON,
562 MediaType.APPLICATION_JSON,
564 public void dataJsonPUT(@Encoded @PathParam("identifier") final ApiPath identifier, @Context final UriInfo uriInfo,
565 final InputStream body, @Suspended final AsyncResponse ar) {
566 try (var jsonBody = new JsonResourceBody(body)) {
567 completeDataPUT(server.dataPUT(identifier, jsonBody, QueryParams.normalize(uriInfo)), ar);
572 * Replace the data store.
574 * @param uriInfo request URI information
575 * @param body data node for put to config DS
576 * @param ar {@link AsyncResponse} which needs to be completed
581 MediaTypes.APPLICATION_YANG_DATA_XML,
582 MediaType.APPLICATION_XML,
585 public void dataXmlPUT(@Context final UriInfo uriInfo, final InputStream body, @Suspended final AsyncResponse ar) {
586 try (var xmlBody = new XmlResourceBody(body)) {
587 completeDataPUT(server.dataPUT(xmlBody, QueryParams.normalize(uriInfo)), ar);
592 * Create or replace the target data resource.
594 * @param identifier path to target
595 * @param uriInfo request URI information
596 * @param body data node for put to config DS
597 * @param ar {@link AsyncResponse} which needs to be completed
600 @Path("/data/{identifier:.+}")
602 MediaTypes.APPLICATION_YANG_DATA_XML,
603 MediaType.APPLICATION_XML,
606 public void dataXmlPUT(@Encoded @PathParam("identifier") final ApiPath identifier, @Context final UriInfo uriInfo,
607 final InputStream body, @Suspended final AsyncResponse ar) {
608 try (var xmlBody = new XmlResourceBody(body)) {
609 completeDataPUT(server.dataPUT(identifier, xmlBody, QueryParams.normalize(uriInfo)), ar);
613 private static void completeDataPUT(final RestconfFuture<DataPutResult> future, final AsyncResponse ar) {
614 future.addCallback(new JaxRsRestconfCallback<>(ar) {
616 Response transform(final DataPutResult result) {
617 // Note: no Location header, as it matches the request path
618 final var builder = result.created() ? Response.created(null) : Response.noContent();
619 fillConfigurationMetadata(builder, result);
620 return builder.build();
626 * List RPC and action operations.
628 * @param ar {@link AsyncResponse} which needs to be completed
633 MediaTypes.APPLICATION_YANG_DATA_XML, MediaType.APPLICATION_XML, MediaType.TEXT_XML,
634 MediaTypes.APPLICATION_YANG_DATA_JSON, MediaType.APPLICATION_JSON
636 public void operationsGET(@Suspended final AsyncResponse ar) {
637 completeOperationsGet(server.operationsGET(), ar);
641 * Retrieve list of operations and actions supported by the server or device.
643 * @param operation path parameter to identify device and/or operation
644 * @param ar {@link AsyncResponse} which needs to be completed
647 @Path("/operations/{operation:.+}")
649 MediaTypes.APPLICATION_YANG_DATA_XML, MediaType.APPLICATION_XML, MediaType.TEXT_XML,
650 MediaTypes.APPLICATION_YANG_DATA_JSON, MediaType.APPLICATION_JSON
652 public void operationsGET(@PathParam("operation") final ApiPath operation, @Suspended final AsyncResponse ar) {
653 completeOperationsGet(server.operationsGET(operation), ar);
656 private static void completeOperationsGet(final RestconfFuture<FormattableBody> future, final AsyncResponse ar) {
657 future.addCallback(new JaxRsRestconfCallback<FormattableBody>(ar) {
659 Response transform(final FormattableBody result) {
660 return Response.ok().entity(result).build();
666 * Invoke RPC operation.
668 * @param identifier module name and rpc identifier string for the desired operation
669 * @param body the body of the operation
670 * @param uriInfo URI info
671 * @param ar {@link AsyncResponse} which needs to be completed with a {@link NormalizedNodePayload} output
674 // FIXME: identifier is just a *single* QName
675 @Path("/operations/{identifier:.+}")
677 MediaTypes.APPLICATION_YANG_DATA_XML,
678 MediaType.APPLICATION_XML,
682 MediaTypes.APPLICATION_YANG_DATA_JSON,
683 MediaTypes.APPLICATION_YANG_DATA_XML,
684 MediaType.APPLICATION_JSON,
685 MediaType.APPLICATION_XML,
688 public void operationsXmlPOST(@Encoded @PathParam("identifier") final ApiPath identifier, final InputStream body,
689 @Context final UriInfo uriInfo, @Suspended final AsyncResponse ar) {
690 try (var xmlBody = new XmlOperationInputBody(body)) {
691 operationsPOST(identifier, uriInfo, ar, xmlBody);
696 * Invoke RPC operation.
698 * @param identifier module name and rpc identifier string for the desired operation
699 * @param body the body of the operation
700 * @param uriInfo URI info
701 * @param ar {@link AsyncResponse} which needs to be completed with a {@link NormalizedNodePayload} output
704 // FIXME: identifier is just a *single* QName
705 @Path("/operations/{identifier:.+}")
707 MediaTypes.APPLICATION_YANG_DATA_JSON,
708 MediaType.APPLICATION_JSON,
711 MediaTypes.APPLICATION_YANG_DATA_JSON,
712 MediaTypes.APPLICATION_YANG_DATA_XML,
713 MediaType.APPLICATION_JSON,
714 MediaType.APPLICATION_XML,
717 public void operationsJsonPOST(@Encoded @PathParam("identifier") final ApiPath identifier, final InputStream body,
718 @Context final UriInfo uriInfo, @Suspended final AsyncResponse ar) {
719 try (var jsonBody = new JsonOperationInputBody(body)) {
720 operationsPOST(identifier, uriInfo, ar, jsonBody);
724 private void operationsPOST(final ApiPath identifier, final UriInfo uriInfo, final AsyncResponse ar,
725 final OperationInputBody body) {
726 server.operationsPOST(uriInfo.getBaseUri(), identifier, QueryParams.normalize(uriInfo), body)
727 .addCallback(new JaxRsRestconfCallback<>(ar) {
729 Response transform(final InvokeResult result) {
730 final var body = result.output();
731 return body == null ? Response.noContent().build()
732 : Response.ok().entity(body).build();
738 * Get revision of IETF YANG Library module.
740 * @param ar {@link AsyncResponse} which needs to be completed
743 @Path("/yang-library-version")
745 MediaTypes.APPLICATION_YANG_DATA_JSON,
746 MediaTypes.APPLICATION_YANG_DATA_XML,
747 MediaType.APPLICATION_JSON,
748 MediaType.APPLICATION_XML,
751 public void yangLibraryVersionGET(@Suspended final AsyncResponse ar) {
752 server.yangLibraryVersionGET().addCallback(new JaxRsRestconfCallback<NormalizedNodePayload>(ar) {
754 Response transform(final NormalizedNodePayload result) {
755 return Response.ok().entity(result).build();
760 // FIXME: References to these resources are generated by our yang-library implementation. That means:
761 // - We really need to formalize the parameter structure so we get some help from JAX-RS during matching
763 // - optional yang-ext:mount prefix(es)
764 // - mandatory module name
765 // - optional module revision
766 // - We really should use /yang-library-module/{name}(/{revision})?
767 // - We seem to be lacking explicit support for submodules in there -- and those locations should then point
768 // to /yang-library-submodule/{moduleName}(/{moduleRevision})?/{name}(/{revision})? so as to look the
769 // submodule up efficiently and allow for the weird case where there are two submodules with the same name
770 // (that is currently not supported by the parser, but it will be in the future)
771 // - It does not make sense to support yang-ext:mount, unless we also intercept mount points and rewrite
772 // yang-library locations. We most likely want to do that to ensure users are not tempted to connect to
776 * Get schema of specific module.
778 * @param fileName source file name
779 * @param revision source revision
780 * @param ar {@link AsyncResponse} which needs to be completed
783 @Produces(YangConstants.RFC6020_YANG_MEDIA_TYPE)
784 @Path("/" + URLConstants.MODULES_SUBPATH + "/{fileName : [^/]+}")
785 public void modulesYangGET(@PathParam("fileName") final String fileName,
786 @QueryParam("revision") final String revision, @Suspended final AsyncResponse ar) {
787 completeModulesGET(server.modulesYangGET(fileName, revision), ar);
791 * Get schema of specific module.
793 * @param mountPath mount point path
794 * @param fileName source file name
795 * @param revision source revision
796 * @param ar {@link AsyncResponse} which needs to be completed
799 @Produces(YangConstants.RFC6020_YANG_MEDIA_TYPE)
800 @Path("/" + URLConstants.MODULES_SUBPATH + "/{mountPath:.+}/{fileName : [^/]+}")
801 public void modulesYangGET(@Encoded @PathParam("mountPath") final ApiPath mountPath,
802 @PathParam("fileName") final String fileName, @QueryParam("revision") final String revision,
803 @Suspended final AsyncResponse ar) {
804 completeModulesGET(server.modulesYangGET(mountPath, fileName, revision), ar);
808 * Get schema of specific module.
810 * @param fileName source file name
811 * @param revision source revision
812 * @param ar {@link AsyncResponse} which needs to be completed
815 @Produces(YangConstants.RFC6020_YIN_MEDIA_TYPE)
816 @Path("/" + URLConstants.MODULES_SUBPATH + "/{fileName : [^/]+}")
817 public void modulesYinGET(@PathParam("fileName") final String fileName,
818 @QueryParam("revision") final String revision, @Suspended final AsyncResponse ar) {
819 completeModulesGET(server.modulesYinGET(fileName, revision), ar);
823 * Get schema of specific module.
825 * @param mountPath mount point path
826 * @param fileName source file name
827 * @param revision source revision
828 * @param ar {@link AsyncResponse} which needs to be completed
831 @Produces(YangConstants.RFC6020_YIN_MEDIA_TYPE)
832 @Path("/" + URLConstants.MODULES_SUBPATH + "/{mountPath:.+}/{fileName : [^/]+}")
833 public void modulesYinGET(@Encoded @PathParam("mountPath") final ApiPath mountPath,
834 @PathParam("fileName") final String fileName, @QueryParam("revision") final String revision,
835 @Suspended final AsyncResponse ar) {
836 completeModulesGET(server.modulesYinGET(mountPath, fileName, revision), ar);
839 private static void completeModulesGET(final RestconfFuture<ModulesGetResult> future, final AsyncResponse ar) {
840 future.addCallback(new JaxRsRestconfCallback<>(ar) {
842 Response transform(final ModulesGetResult result) {
845 reader = result.source().openStream();
846 } catch (IOException e) {
847 throw new RestconfDocumentedException("Cannot open source", e);
849 return Response.ok(reader).build();