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.api.BindingNormalizedNodeSerializer;
  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.EffectiveModelContext;
  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(EffectiveModelContext schemaContext,
  46             BindingNormalizedNodeSerializer codecRegistry) {
  47         super(schemaContext, codecRegistry);
  48     }
  49
  50     /**
  51      * extracts codec and schema context (?).
  52      *
  53      * @param dataStoreContextUtil datastore context util used to extract codec and schema context
  54      * @return {@link AbstractDataObjectConverter}
  55      */
  56     public static DataObjectConverter createWithDataStoreUtil(@Nonnull DataStoreContext dataStoreContextUtil) {
  57         return new JSONDataObjectConverter(dataStoreContextUtil.getSchemaContext(),
  58                 dataStoreContextUtil.getBindingToNormalizedNodeCodec());
  59     }
  60
  61     /**
  62      * extracts codec and schema context (?).
  63      *
  64      * @param schemaContext schema context for converter
  65      * @param codecRegistry codec registry used for converting
  66      * @return converter
  67      */
  68     public static DataObjectConverter createWithSchemaContext(@Nonnull EffectiveModelContext schemaContext,
  69             @Nonnull BindingNormalizedNodeSerializer codecRegistry) {
  70         return new JSONDataObjectConverter(schemaContext, codecRegistry);
  71     }
  72
  73     /**
  74      * Transforms the JSON input stream into normalized nodes.
  75      *
  76      * @param inputStream of the given JSON
  77      * @return {@link Optional} instance of {@link NormalizedNode}.
  78      */
  79     @Override
  80     public Optional<NormalizedNode<? extends YangInstanceIdentifier.PathArgument, ?>> transformIntoNormalizedNode(
  81             @Nonnull InputStream inputStream) {
  82         JsonReader reader = new JsonReader(new InputStreamReader(inputStream, StandardCharsets.UTF_8));
  83         return parseInputJSON(reader);
  84     }
  85
  86     @Override
  87     public Optional<NormalizedNode<? extends YangInstanceIdentifier.PathArgument, ?>> transformIntoNormalizedNode(
  88             @Nonnull Reader inputReader, SchemaNode parentSchema) {
  89         throw new UnsupportedOperationException("Not Implemented yet");
  90     }
  91
  92     @Override
  93     public Optional<NormalizedNode<? extends YangInstanceIdentifier.PathArgument, ?>> transformIntoNormalizedNode(
  94             @Nonnull Reader inputReader) {
  95         JsonReader reader = new JsonReader(inputReader);
  96         return parseInputJSON(reader);
  97     }
  98
  99     @Override
 100     public <T extends DataObject> Writer writerFromDataObject(@Nonnull DataObject object, Class<T> dataObjectClass,
 101             ConvertType<T> convertType) {
 102         Writer writer = new StringWriter();
 103         JsonWriter jsonWriter = new JsonWriter(writer);
 104         JSONCodecFactory jsonCodecFactory =
 105             JSONCodecFactorySupplier.DRAFT_LHOTKA_NETMOD_YANG_JSON_02.createLazy(getSchemaContext());
 106         NormalizedNodeStreamWriter create =
 107             JSONNormalizedNodeStreamWriter.createExclusiveWriter(jsonCodecFactory,
 108             (org.opendaylight.yangtools.yang.model.api.DataNodeContainer)null, null, jsonWriter);
 109
 110         try (NormalizedNodeWriter normalizedNodeWriter = NormalizedNodeWriter.forStreamWriter(create);) {
 111             normalizedNodeWriter
 112                     .write(convertType.toNormalizedNodes(dataObjectClass.cast(object), dataObjectClass).get());
 113         } catch (IOException ioe) {
 114             throw new IllegalStateException(ioe);
 115         }
 116         return writer;
 117     }
 118
 119     @Override
 120     public <T extends DataObject> Writer writerFromRpcDataObject(@Nonnull DataObject object, Class<T> dataObjectClass,
 121             ConvertType<T> convertType, QName rpcOutputQName, String rpcName) {
 122         return null;
 123     }
 124
 125     /**
 126      * Parses the input json with concrete implementation of {@link JsonParserStream}.
 127      *
 128      * @param reader of the given JSON
 129      *
 130      */
 131     private Optional<NormalizedNode<? extends YangInstanceIdentifier.PathArgument, ?>> parseInputJSON(
 132             JsonReader reader) {
 133         NormalizedNodeResult result = new NormalizedNodeResult();
 134         try (NormalizedNodeStreamWriter streamWriter = ImmutableNormalizedNodeStreamWriter.from(result);
 135             JsonParserStream jsonParser = JsonParserStream.create(streamWriter,
 136                 JSONCodecFactorySupplier.DRAFT_LHOTKA_NETMOD_YANG_JSON_02.getShared(getSchemaContext()),
 137                 getSchemaContext())) {
 138             jsonParser.parse(reader);
 139         } catch (IOException e) {
 140             LOG.warn("An error occured during parsing Json input stream", e);
 141             return Optional.empty();
 142         }
 143         return Optional.ofNullable(result.getResult());
 144     }
 145
 146 }