binding/mdsal-binding-dom-codec/src/main/java/org/opendaylight/yangtools/binding/data/codec/impl/DataContainerCodecContext.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. 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.yangtools.binding.data.codec.impl;
   9
  10 import com.google.common.base.Optional;
  11 import com.google.common.collect.ImmutableCollection;
  12 import com.google.common.collect.ImmutableSet;
  13 import java.io.IOException;
  14 import java.util.List;
  15 import javax.annotation.Nonnull;
  16 import javax.annotation.Nullable;
  17 import org.opendaylight.yangtools.binding.data.codec.api.BindingNormalizedNodeCachingCodec;
  18 import org.opendaylight.yangtools.yang.binding.BindingStreamEventWriter;
  19 import org.opendaylight.yangtools.yang.binding.DataObject;
  20 import org.opendaylight.yangtools.yang.binding.DataObjectSerializer;
  21 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  22 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.PathArgument;
  23 import org.opendaylight.yangtools.yang.common.QName;
  24 import org.opendaylight.yangtools.yang.common.QNameModule;
  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.impl.schema.ImmutableNormalizedNodeStreamWriter;
  29 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedNodeResult;
  30
  31 abstract class DataContainerCodecContext<D extends DataObject,T> extends NodeCodecContext<D>  {
  32
  33     private final DataContainerCodecPrototype<T> prototype;
  34     private volatile DataObjectSerializer eventStreamSerializer;
  35
  36     protected DataContainerCodecContext(final DataContainerCodecPrototype<T> prototype) {
  37         this.prototype = prototype;
  38     }
  39
  40     @Override
  41     public final T getSchema() {
  42         return prototype.getSchema();
  43     }
  44
  45     protected final QNameModule namespace() {
  46         return prototype.getNamespace();
  47     }
  48
  49     protected final CodecContextFactory factory() {
  50         return prototype.getFactory();
  51     }
  52
  53     @Override
  54     protected YangInstanceIdentifier.PathArgument getDomPathArgument() {
  55         return prototype.getYangArg();
  56     }
  57
  58     /**
  59      * Returns nested node context using supplied YANG Instance Identifier
  60      *
  61      * @param arg Yang Instance Identifier Argument
  62      * @return Context of child
  63      * @throws IllegalArgumentException If supplied argument does not represent valid child.
  64      */
  65     @Override
  66     public abstract NodeCodecContext<?> yangPathArgumentChild(final YangInstanceIdentifier.PathArgument arg);
  67
  68     /**
  69      * Returns nested node context using supplied Binding Instance Identifier
  70      * and adds YANG instance identifiers to supplied list.
  71      *
  72      * @param arg Binding Instance Identifier Argument
  73      * @return Context of child or null if supplied {@code arg} does not represent valid child.
  74      * @throws IllegalArgumentException If supplied argument does not represent valid child.
  75      */
  76     @Override
  77     public @Nullable DataContainerCodecContext<?,?> bindingPathArgumentChild(final InstanceIdentifier.PathArgument arg,
  78             final List<YangInstanceIdentifier.PathArgument> builder) {
  79         final DataContainerCodecContext<?,?> child = streamChild(arg.getType());
  80         if(child != null) {
  81             if (builder != null) {
  82                 child.addYangPathArgument(arg,builder);
  83             }
  84             return child;
  85         }
  86         throw new IllegalArgumentException("SUpplied argument is not valid child");
  87     }
  88
  89     /**
  90      * Returns deserialized Binding Path Argument from YANG instance identifier.
  91      *
  92      * @param domArg
  93      * @return
  94      */
  95     protected PathArgument getBindingPathArgument(final YangInstanceIdentifier.PathArgument domArg) {
  96         return bindingArg();
  97     }
  98
  99     protected final PathArgument bindingArg() {
 100         return prototype.getBindingArg();
 101     }
 102
 103     @SuppressWarnings("unchecked")
 104     @Override
 105     public final Class<D> getBindingClass() {
 106         return Class.class.cast(prototype.getBindingClass());
 107     }
 108
 109     /**
 110      *
 111      * Returns child context as if it was walked by
 112      * {@link BindingStreamEventWriter}. This means that to enter case, one
 113      * must issue getChild(ChoiceClass).getChild(CaseClass).
 114      *
 115      * @param childClass
 116      * @return Context of child node or null, if supplied class is not subtree child
 117      * @throws IllegalArgumentException If supplied child class is not valid in specified context.
 118      */
 119     @Override
 120     public abstract @Nullable <DV extends DataObject> DataContainerCodecContext<DV,?> streamChild(final Class<DV> childClass) throws IllegalArgumentException;
 121
 122     /**
 123      *
 124      * Returns child context as if it was walked by
 125      * {@link BindingStreamEventWriter}. This means that to enter case, one
 126      * must issue getChild(ChoiceClass).getChild(CaseClass).
 127      *
 128      * @param childClass
 129      * @return Context of child or Optional absent is supplied class is not applicable in context.
 130      */
 131     @Override
 132     public abstract <DV extends DataObject> Optional<DataContainerCodecContext<DV,?>> possibleStreamChild(final Class<DV> childClass);
 133
 134     @Override
 135     public String toString() {
 136         return getClass().getSimpleName() + " [" + prototype.getBindingClass() + "]";
 137     }
 138
 139     @Override
 140     public BindingNormalizedNodeCachingCodec<D> createCachingCodec(
 141             final ImmutableCollection<Class<? extends DataObject>> cacheSpecifier) {
 142         if(cacheSpecifier.isEmpty()) {
 143             return new NonCachingCodec<>(this);
 144         }
 145         return new CachingNormalizedNodeCodec<D>(this,ImmutableSet.copyOf(cacheSpecifier));
 146     }
 147
 148     BindingStreamEventWriter createWriter(final NormalizedNodeStreamWriter domWriter) {
 149         return  new BindingToNormalizedStreamWriter(this, domWriter);
 150     }
 151
 152     @Nonnull
 153     protected final <V> V childNonNull(@Nullable final V nullable, final YangInstanceIdentifier.PathArgument child,
 154             final String message, final Object... args) {
 155         if (nullable != null) {
 156             return nullable;
 157         }
 158         MissingSchemaException.checkModulePresent(factory().getRuntimeContext().getSchemaContext(), child);
 159         throw IncorrectNestingException.create(message, args);
 160     }
 161
 162     @Nonnull
 163     protected final <V> V childNonNull(@Nullable final V nullable, final QName child, final String message,
 164             final Object... args) {
 165         if (nullable != null) {
 166             return nullable;
 167         }
 168         MissingSchemaException.checkModulePresent(factory().getRuntimeContext().getSchemaContext(), child);
 169         throw IncorrectNestingException.create(message, args);
 170     }
 171
 172     @Nonnull
 173     protected final <V> V childNonNull(@Nullable final V nullable, final Class<?> childClass, final String message,
 174             final Object... args) {
 175         if (nullable != null) {
 176             return nullable;
 177         }
 178         MissingSchemaForClassException.check(factory().getRuntimeContext(), childClass);
 179         MissingClassInLoadingStrategyException.check(factory().getRuntimeContext().getStrategy(), childClass);
 180         throw IncorrectNestingException.create(message, args);
 181     }
 182
 183     DataObjectSerializer eventStreamSerializer() {
 184         if(eventStreamSerializer == null) {
 185             eventStreamSerializer = factory().getEventStreamSerializer(getBindingClass());
 186         }
 187         return eventStreamSerializer;
 188     }
 189
 190     @Override
 191     public NormalizedNode<?, ?> serialize(final D data) {
 192         final NormalizedNodeResult result = new NormalizedNodeResult();
 193         // We create DOM stream writer which produces normalized nodes
 194         final NormalizedNodeStreamWriter domWriter = ImmutableNormalizedNodeStreamWriter.from(result);
 195         writeAsNormalizedNode(data, domWriter);
 196         return result.getResult();
 197     }
 198
 199     @Override
 200     public void writeAsNormalizedNode(final D data, final NormalizedNodeStreamWriter writer) {
 201         try {
 202             eventStreamSerializer().serialize(data, createWriter(writer));
 203         } catch (final IOException e) {
 204             throw new IllegalStateException("Failed to serialize Binding DTO",e);
 205         }
 206     }
 207
 208 }