common/src/main/java/org/opendaylight/transportpce/common/converter/JSONDataObjectConverter.java

   1 /*
   2  * Copyright © 2016 AT&T and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.transportpce.common.converter;
   9
  10 import com.google.gson.stream.JsonReader;
  11 import com.google.gson.stream.JsonWriter;
  12 import java.io.IOException;
  13 import java.io.InputStream;
  14 import java.io.InputStreamReader;
  15 import java.io.Reader;
  16 import java.io.StringWriter;
  17 import java.io.Writer;
  18 import java.nio.charset.StandardCharsets;
  19 import java.util.Optional;
  20 import javax.annotation.Nonnull;
  21 import org.opendaylight.mdsal.binding.dom.codec.impl.BindingNormalizedNodeCodecRegistry;
  22 import org.opendaylight.transportpce.common.DataStoreContext;
  23 import org.opendaylight.transportpce.common.converter.api.DataObjectConverter;
  24 import org.opendaylight.yangtools.yang.binding.DataObject;
  25 import org.opendaylight.yangtools.yang.common.QName;
  26 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  27 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  28 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  29 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeWriter;
  30 import org.opendaylight.yangtools.yang.data.codec.gson.JSONCodecFactory;
  31 import org.opendaylight.yangtools.yang.data.codec.gson.JSONCodecFactorySupplier;
  32 import org.opendaylight.yangtools.yang.data.codec.gson.JSONNormalizedNodeStreamWriter;
  33 import org.opendaylight.yangtools.yang.data.codec.gson.JsonParserStream;
  34 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNormalizedNodeStreamWriter;
  35 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedNodeResult;
  36 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  37 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  38 import org.slf4j.Logger;
  39 import org.slf4j.LoggerFactory;
  40
  41 public final class JSONDataObjectConverter extends AbstractDataObjectConverter {
  42
  43     private static final Logger LOG = LoggerFactory.getLogger(JSONDataObjectConverter.class);
  44
  45     private JSONDataObjectConverter(SchemaContext schemaContext, BindingNormalizedNodeCodecRegistry codecRegistry) {
  46         super(schemaContext, codecRegistry);
  47     }
  48
  49     /**
  50      * extracts codec and schema context (?).
  51      *
  52      * @param dataStoreContextUtil datastore context util used to extract codec and schema context
  53      * @return {@link AbstractDataObjectConverter}
  54      */
  55     public static DataObjectConverter createWithDataStoreUtil(@Nonnull DataStoreContext dataStoreContextUtil) {
  56         return new JSONDataObjectConverter(dataStoreContextUtil.getSchemaContext(),
  57                 dataStoreContextUtil.getBindingToNormalizedNodeCodec());
  58     }
  59
  60     /**
  61      * extracts codec and schema context (?).
  62      *
  63      * @param schemaContext schema context for converter
  64      * @param codecRegistry codec registry used for converting
  65      * @return converter
  66      */
  67     public static DataObjectConverter createWithSchemaContext(@Nonnull SchemaContext schemaContext,
  68             @Nonnull BindingNormalizedNodeCodecRegistry codecRegistry) {
  69         return new JSONDataObjectConverter(schemaContext, codecRegistry);
  70     }
  71
  72     /**
  73      * Transforms the JSON input stream into normalized nodes.
  74      *
  75      * @param inputStream of the given JSON
  76      * @return {@link Optional} instance of {@link NormalizedNode}.
  77      */
  78     @Override
  79     public Optional<NormalizedNode<? extends YangInstanceIdentifier.PathArgument, ?>> transformIntoNormalizedNode(
  80             @Nonnull InputStream inputStream) {
  81         JsonReader reader = new JsonReader(new InputStreamReader(inputStream, StandardCharsets.UTF_8));
  82         return parseInputJSON(reader);
  83     }
  84
  85     @Override
  86     public Optional<NormalizedNode<? extends YangInstanceIdentifier.PathArgument, ?>> transformIntoNormalizedNode(
  87             @Nonnull Reader inputReader, SchemaNode parentSchema) {
  88         throw new UnsupportedOperationException("Not Implemented yet");
  89     }
  90
  91     @Override
  92     public Optional<NormalizedNode<? extends YangInstanceIdentifier.PathArgument, ?>> transformIntoNormalizedNode(
  93             @Nonnull Reader inputReader) {
  94         JsonReader reader = new JsonReader(inputReader);
  95         return parseInputJSON(reader);
  96     }
  97
  98     @Override
  99     public <T extends DataObject> Writer writerFromDataObject(@Nonnull DataObject object, Class<T> dataObjectClass,
 100             ConvertType<T> convertType) {
 101         Writer writer = new StringWriter();
 102         JsonWriter jsonWriter = new JsonWriter(writer);
 103         JSONCodecFactory jsonCodecFactory =
 104             JSONCodecFactorySupplier.DRAFT_LHOTKA_NETMOD_YANG_JSON_02.createLazy(getSchemaContext());
 105         NormalizedNodeStreamWriter create =
 106             JSONNormalizedNodeStreamWriter.createExclusiveWriter(jsonCodecFactory,
 107             (org.opendaylight.yangtools.yang.model.api.DataNodeContainer)null, null, jsonWriter);
 108
 109         try (NormalizedNodeWriter normalizedNodeWriter = NormalizedNodeWriter.forStreamWriter(create);) {
 110             normalizedNodeWriter
 111                     .write(convertType.toNormalizedNodes(dataObjectClass.cast(object), dataObjectClass).get());
 112         } catch (IOException ioe) {
 113             throw new IllegalStateException(ioe);
 114         }
 115         return writer;
 116     }
 117
 118     @Override
 119     public <T extends DataObject> Writer writerFromRpcDataObject(@Nonnull DataObject object, Class<T> dataObjectClass,
 120             ConvertType<T> convertType, QName rpcOutputQName, String rpcName) {
 121         return null;
 122     }
 123
 124     /**
 125      * Parses the input json with concrete implementation of {@link JsonParserStream}.
 126      *
 127      * @param reader of the given JSON
 128      *
 129      */
 130     private Optional<NormalizedNode<? extends YangInstanceIdentifier.PathArgument, ?>> parseInputJSON(
 131             JsonReader reader) {
 132         NormalizedNodeResult result = new NormalizedNodeResult();
 133         try (NormalizedNodeStreamWriter streamWriter = ImmutableNormalizedNodeStreamWriter.from(result);
 134             JsonParserStream jsonParser = JsonParserStream.create(streamWriter,
 135                 JSONCodecFactorySupplier.DRAFT_LHOTKA_NETMOD_YANG_JSON_02.getShared(getSchemaContext()),
 136                 getSchemaContext())) {
 137             jsonParser.parse(reader);
 138         } catch (IOException e) {
 139             LOG.warn("An error occured during parsing Json input stream", e);
 140             return Optional.empty();
 141         }
 142         return Optional.ofNullable(result.getResult());
 143     }
 144
 145 }