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