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.jersey.providers.patch;
10 import static com.google.common.base.Preconditions.checkArgument;
11 import static java.util.Objects.requireNonNull;
13 import com.google.common.collect.ImmutableList;
14 import com.google.gson.stream.JsonReader;
15 import com.google.gson.stream.JsonToken;
16 import java.io.IOException;
17 import java.io.InputStream;
18 import java.io.InputStreamReader;
19 import java.io.StringReader;
20 import java.nio.charset.StandardCharsets;
21 import java.util.ArrayList;
22 import java.util.List;
23 import java.util.Locale;
24 import java.util.Optional;
25 import java.util.concurrent.atomic.AtomicReference;
26 import javax.ws.rs.Consumes;
27 import javax.ws.rs.WebApplicationException;
28 import javax.ws.rs.ext.Provider;
29 import org.eclipse.jdt.annotation.NonNull;
30 import org.opendaylight.restconf.common.context.InstanceIdentifierContext;
31 import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
32 import org.opendaylight.restconf.common.errors.RestconfError.ErrorTag;
33 import org.opendaylight.restconf.common.errors.RestconfError.ErrorType;
34 import org.opendaylight.restconf.common.patch.PatchContext;
35 import org.opendaylight.restconf.common.patch.PatchEditOperation;
36 import org.opendaylight.restconf.common.patch.PatchEntity;
37 import org.opendaylight.restconf.nb.rfc8040.Rfc8040;
38 import org.opendaylight.restconf.nb.rfc8040.codecs.StringModuleInstanceIdentifierCodec;
39 import org.opendaylight.restconf.nb.rfc8040.handlers.DOMMountPointServiceHandler;
40 import org.opendaylight.restconf.nb.rfc8040.handlers.SchemaContextHandler;
41 import org.opendaylight.restconf.nb.rfc8040.utils.RestconfConstants;
42 import org.opendaylight.restconf.nb.rfc8040.utils.parser.ParserIdentifier;
43 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
44 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
45 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
46 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
47 import org.opendaylight.yangtools.yang.data.codec.gson.JSONCodecFactorySupplier;
48 import org.opendaylight.yangtools.yang.data.codec.gson.JsonParserStream;
49 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNormalizedNodeStreamWriter;
50 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedNodeResult;
51 import org.opendaylight.yangtools.yang.data.impl.schema.ResultAlreadySetException;
52 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
53 import org.opendaylight.yangtools.yang.model.util.SchemaContextUtil;
54 import org.slf4j.Logger;
55 import org.slf4j.LoggerFactory;
59 Rfc8040.MediaTypes.YANG_PATCH + RestconfConstants.JSON,
60 Rfc8040.MediaTypes.YANG_PATCH_RFC8072 + RestconfConstants.JSON
62 public class JsonToPatchBodyReader extends AbstractToPatchBodyReader {
63 private static final Logger LOG = LoggerFactory.getLogger(JsonToPatchBodyReader.class);
65 public JsonToPatchBodyReader(final SchemaContextHandler schemaContextHandler,
66 final DOMMountPointServiceHandler mountPointServiceHandler) {
67 super(schemaContextHandler, mountPointServiceHandler);
70 @SuppressWarnings("checkstyle:IllegalCatch")
72 protected PatchContext readBody(final InstanceIdentifierContext<?> path, final InputStream entityStream)
73 throws WebApplicationException {
75 return readFrom(path, entityStream);
76 } catch (final Exception e) {
77 throw propagateExceptionAs(e);
81 private PatchContext readFrom(final InstanceIdentifierContext<?> path, final InputStream entityStream)
83 final JsonReader jsonReader = new JsonReader(new InputStreamReader(entityStream, StandardCharsets.UTF_8));
84 AtomicReference<String> patchId = new AtomicReference<>();
85 final List<PatchEntity> resultList = read(jsonReader, path, patchId);
88 return new PatchContext(path, resultList, patchId.get());
91 @SuppressWarnings("checkstyle:IllegalCatch")
92 public PatchContext readFrom(final String uriPath, final InputStream entityStream) throws
93 RestconfDocumentedException {
96 ParserIdentifier.toInstanceIdentifier(uriPath, getSchemaContext(),
97 Optional.ofNullable(getMountPointService())), entityStream);
98 } catch (final Exception e) {
99 propagateExceptionAs(e);
100 return null; // no-op
104 private static RuntimeException propagateExceptionAs(final Exception exception) throws RestconfDocumentedException {
105 if (exception instanceof RestconfDocumentedException) {
106 throw (RestconfDocumentedException)exception;
109 if (exception instanceof ResultAlreadySetException) {
110 LOG.debug("Error parsing json input:", exception);
111 throw new RestconfDocumentedException("Error parsing json input: Failed to create new parse result data. ");
114 throw new RestconfDocumentedException("Error parsing json input: " + exception.getMessage(), ErrorType.PROTOCOL,
115 ErrorTag.MALFORMED_MESSAGE, exception);
118 private List<PatchEntity> read(final JsonReader in, final InstanceIdentifierContext<?> path,
119 final AtomicReference<String> patchId) throws IOException {
120 final List<PatchEntity> resultCollection = new ArrayList<>();
121 final StringModuleInstanceIdentifierCodec codec = new StringModuleInstanceIdentifierCodec(
122 path.getSchemaContext());
123 final JsonToPatchBodyReader.PatchEdit edit = new JsonToPatchBodyReader.PatchEdit();
125 while (in.hasNext()) {
132 Boolean.toString(in.nextBoolean());
146 parseByName(in.nextName(), edit, in, path, codec, resultCollection, patchId);
160 return ImmutableList.copyOf(resultCollection);
164 * Switch value of parsed JsonToken.NAME and read edit definition or patch id.
166 * @param name value of token
167 * @param edit PatchEdit instance
168 * @param in JsonReader reader
169 * @param path InstanceIdentifierContext context
170 * @param codec Draft11StringModuleInstanceIdentifierCodec codec
171 * @param resultCollection collection of parsed edits
172 * @throws IOException if operation fails
174 private void parseByName(final @NonNull String name, final @NonNull PatchEdit edit,
175 final @NonNull JsonReader in, final @NonNull InstanceIdentifierContext<?> path,
176 final @NonNull StringModuleInstanceIdentifierCodec codec,
177 final @NonNull List<PatchEntity> resultCollection,
178 final @NonNull AtomicReference<String> patchId) throws IOException {
181 if (in.peek() == JsonToken.BEGIN_ARRAY) {
184 while (in.hasNext()) {
185 readEditDefinition(edit, in, path, codec);
186 resultCollection.add(prepareEditOperation(edit));
192 readEditDefinition(edit, in, path, codec);
193 resultCollection.add(prepareEditOperation(edit));
199 patchId.set(in.nextString());
207 * Read one patch edit object from Json input.
209 * @param edit PatchEdit instance to be filled with read data
210 * @param in JsonReader reader
211 * @param path InstanceIdentifierContext path context
212 * @param codec Draft11StringModuleInstanceIdentifierCodec codec
213 * @throws IOException if operation fails
215 private void readEditDefinition(final @NonNull PatchEdit edit, final @NonNull JsonReader in,
216 final @NonNull InstanceIdentifierContext<?> path,
217 final @NonNull StringModuleInstanceIdentifierCodec codec) throws IOException {
218 String deferredValue = null;
221 while (in.hasNext()) {
222 final String editDefinition = in.nextName();
223 switch (editDefinition) {
225 edit.setId(in.nextString());
228 edit.setOperation(PatchEditOperation.valueOf(in.nextString().toUpperCase(Locale.ROOT)));
231 // target can be specified completely in request URI
232 final String target = in.nextString();
233 if (target.equals("/")) {
234 edit.setTarget(path.getInstanceIdentifier());
235 edit.setTargetSchemaNode(path.getSchemaContext());
237 edit.setTarget(codec.deserialize(codec.serialize(path.getInstanceIdentifier()).concat(target)));
238 edit.setTargetSchemaNode(SchemaContextUtil.findDataSchemaNode(path.getSchemaContext(),
239 codec.getDataContextTree().findChild(edit.getTarget()).orElseThrow().getDataSchemaNode()
240 .getPath().getParent()));
245 checkArgument(edit.getData() == null && deferredValue == null, "Multiple value entries found");
247 if (edit.getTargetSchemaNode() == null) {
248 final StringBuilder sb = new StringBuilder();
250 // save data defined in value node for next (later) processing, because target needs to be read
251 // always first and there is no ordering in Json input
252 readValueNode(sb, in);
253 deferredValue = sb.toString();
255 // We have a target schema node, reuse this reader without buffering the value.
256 edit.setData(readEditData(in, edit.getTargetSchemaNode(), path));
260 // FIXME: this does not look right, as it can wreck our logic
267 if (deferredValue != null) {
268 // read saved data to normalized node when target schema is already known
269 edit.setData(readEditData(new JsonReader(new StringReader(deferredValue)), edit.getTargetSchemaNode(),
275 * Parse data defined in value node and saves it to buffer.
276 * @param sb Buffer to read value node
277 * @param in JsonReader reader
278 * @throws IOException if operation fails
280 private void readValueNode(final @NonNull StringBuilder sb, final @NonNull JsonReader in) throws IOException {
283 sb.append("{\"").append(in.nextName()).append("\":");
290 while (in.hasNext()) {
291 if (in.peek() == JsonToken.STRING) {
292 sb.append('"').append(in.nextString()).append('"');
294 readValueObject(sb, in);
296 if (in.peek() != JsonToken.END_ARRAY) {
305 readValueObject(sb, in);
314 * Parse one value object of data and saves it to buffer.
315 * @param sb Buffer to read value object
316 * @param in JsonReader reader
317 * @throws IOException if operation fails
319 private void readValueObject(final @NonNull StringBuilder sb, final @NonNull JsonReader in) throws IOException {
320 // read simple leaf value
321 if (in.peek() == JsonToken.STRING) {
322 sb.append('"').append(in.nextString()).append('"');
329 while (in.hasNext()) {
330 sb.append('"').append(in.nextName()).append("\":");
334 sb.append('"').append(in.nextString()).append('"');
340 while (in.hasNext()) {
341 if (in.peek() == JsonToken.STRING) {
342 sb.append('"').append(in.nextString()).append('"');
344 readValueObject(sb, in);
347 if (in.peek() != JsonToken.END_ARRAY) {
356 readValueObject(sb, in);
359 if (in.peek() != JsonToken.END_OBJECT) {
369 * Read patch edit data defined in value node to NormalizedNode.
370 * @param in reader JsonReader reader
371 * @return NormalizedNode representing data
373 private static NormalizedNode<?, ?> readEditData(final @NonNull JsonReader in,
374 final @NonNull SchemaNode targetSchemaNode, final @NonNull InstanceIdentifierContext<?> path) {
375 final NormalizedNodeResult resultHolder = new NormalizedNodeResult();
376 final NormalizedNodeStreamWriter writer = ImmutableNormalizedNodeStreamWriter.from(resultHolder);
377 JsonParserStream.create(writer, JSONCodecFactorySupplier.RFC7951.getShared(path.getSchemaContext()),
378 targetSchemaNode).parse(in);
380 return resultHolder.getResult();
384 * Prepare PatchEntity from PatchEdit instance when it satisfies conditions, otherwise throws exception.
385 * @param edit Instance of PatchEdit
386 * @return PatchEntity Patch entity
388 private static PatchEntity prepareEditOperation(final @NonNull PatchEdit edit) {
389 if (edit.getOperation() != null && edit.getTargetSchemaNode() != null
390 && checkDataPresence(edit.getOperation(), edit.getData() != null)) {
391 if (!edit.getOperation().isWithValue()) {
392 return new PatchEntity(edit.getId(), edit.getOperation(), edit.getTarget());
395 // for lists allow to manipulate with list items through their parent
396 final YangInstanceIdentifier targetNode;
397 if (edit.getTarget().getLastPathArgument() instanceof NodeIdentifierWithPredicates) {
398 targetNode = edit.getTarget().getParent();
400 targetNode = edit.getTarget();
403 return new PatchEntity(edit.getId(), edit.getOperation(), targetNode, edit.getData());
406 throw new RestconfDocumentedException("Error parsing input", ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
410 * Check if data is present when operation requires it and not present when operation data is not allowed.
411 * @param operation Name of operation
412 * @param hasData Data in edit are present/not present
413 * @return true if data is present when operation requires it or if there are no data when operation does not
414 * allow it, false otherwise
416 private static boolean checkDataPresence(final @NonNull PatchEditOperation operation, final boolean hasData) {
417 return operation.isWithValue() == hasData;
421 * Helper class representing one patch edit.
423 private static final class PatchEdit {
425 private PatchEditOperation operation;
426 private YangInstanceIdentifier target;
427 private SchemaNode targetSchemaNode;
428 private NormalizedNode<?, ?> data;
434 void setId(final String id) {
435 this.id = requireNonNull(id);
438 PatchEditOperation getOperation() {
442 void setOperation(final PatchEditOperation operation) {
443 this.operation = requireNonNull(operation);
446 YangInstanceIdentifier getTarget() {
450 void setTarget(final YangInstanceIdentifier target) {
451 this.target = requireNonNull(target);
454 SchemaNode getTargetSchemaNode() {
455 return targetSchemaNode;
458 void setTargetSchemaNode(final SchemaNode targetSchemaNode) {
459 this.targetSchemaNode = requireNonNull(targetSchemaNode);
462 NormalizedNode<?, ?> getData() {
466 void setData(final NormalizedNode<?, ?> data) {
467 this.data = requireNonNull(data);
474 targetSchemaNode = null;