code-generator/binding-data-codec/src/main/java/org/opendaylight/yangtools/binding/data/codec/impl/DataObjectCodecContext.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.base.Preconditions;
  12 import com.google.common.base.Throwables;
  13 import com.google.common.collect.ImmutableMap;
  14 import com.google.common.collect.ImmutableSortedMap;
  15 import java.lang.invoke.MethodHandle;
  16 import java.lang.invoke.MethodHandles;
  17 import java.lang.invoke.MethodHandles.Lookup;
  18 import java.lang.invoke.MethodType;
  19 import java.lang.reflect.InvocationHandler;
  20 import java.lang.reflect.Method;
  21 import java.lang.reflect.Proxy;
  22 import java.util.Collection;
  23 import java.util.Comparator;
  24 import java.util.HashMap;
  25 import java.util.List;
  26 import java.util.Map;
  27 import java.util.Map.Entry;
  28 import java.util.SortedMap;
  29 import java.util.TreeMap;
  30 import org.opendaylight.yangtools.sal.binding.generator.api.ClassLoadingStrategy;
  31 import org.opendaylight.yangtools.sal.binding.model.api.Type;
  32 import org.opendaylight.yangtools.yang.binding.Augmentable;
  33 import org.opendaylight.yangtools.yang.binding.Augmentation;
  34 import org.opendaylight.yangtools.yang.binding.DataObject;
  35 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  36 import org.opendaylight.yangtools.yang.binding.util.BindingReflections;
  37 import org.opendaylight.yangtools.yang.common.QName;
  38 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  39 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
  40 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  41 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  42 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  43 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  44 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNodeContainer;
  45 import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
  46 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
  47 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  48 import org.opendaylight.yangtools.yang.model.util.SchemaNodeUtils;
  49 import org.slf4j.Logger;
  50 import org.slf4j.LoggerFactory;
  51
  52 abstract class DataObjectCodecContext<D extends DataObject,T extends DataNodeContainer> extends DataContainerCodecContext<D,T> {
  53     private static final Logger LOG = LoggerFactory.getLogger(DataObjectCodecContext.class);
  54     private static final Lookup LOOKUP = MethodHandles.publicLookup();
  55     private static final MethodType CONSTRUCTOR_TYPE = MethodType.methodType(void.class, InvocationHandler.class);
  56     private static final MethodType DATAOBJECT_TYPE = MethodType.methodType(DataObject.class, InvocationHandler.class);
  57     private static final Comparator<Method> METHOD_BY_ALPHABET = new Comparator<Method>() {
  58         @Override
  59         public int compare(final Method o1, final Method o2) {
  60             return o1.getName().compareTo(o2.getName());
  61         }
  62     };
  63
  64     private final ImmutableMap<String, LeafNodeCodecContext<?>> leafChild;
  65     private final ImmutableMap<YangInstanceIdentifier.PathArgument, NodeContextSupplier> byYang;
  66     private final ImmutableSortedMap<Method, NodeContextSupplier> byMethod;
  67     private final ImmutableMap<Class<?>, DataContainerCodecPrototype<?>> byStreamClass;
  68     private final ImmutableMap<Class<?>, DataContainerCodecPrototype<?>> byBindingArgClass;
  69     private final MethodHandle proxyConstructor;
  70
  71     protected DataObjectCodecContext(final DataContainerCodecPrototype<T> prototype) {
  72         super(prototype);
  73
  74         this.leafChild = factory().getLeafNodes(getBindingClass(), schema());
  75
  76         final Map<Class<?>, Method> clsToMethod = BindingReflections.getChildrenClassToMethod(getBindingClass());
  77
  78         final Map<YangInstanceIdentifier.PathArgument, NodeContextSupplier> byYangBuilder = new HashMap<>();
  79         final SortedMap<Method, NodeContextSupplier> byMethodBuilder = new TreeMap<>(METHOD_BY_ALPHABET);
  80         final Map<Class<?>, DataContainerCodecPrototype<?>> byStreamClassBuilder = new HashMap<>();
  81         final Map<Class<?>, DataContainerCodecPrototype<?>> byBindingArgClassBuilder = new HashMap<>();
  82
  83         // Adds leaves to mapping
  84         for (final LeafNodeCodecContext<?> leaf : leafChild.values()) {
  85             byMethodBuilder.put(leaf.getGetter(), leaf);
  86             byYangBuilder.put(leaf.getDomPathArgument(), leaf);
  87         }
  88
  89         for (final Entry<Class<?>, Method> childDataObj : clsToMethod.entrySet()) {
  90             final DataContainerCodecPrototype<?> childProto = loadChildPrototype(childDataObj.getKey());
  91             byMethodBuilder.put(childDataObj.getValue(), childProto);
  92             byStreamClassBuilder.put(childProto.getBindingClass(), childProto);
  93             byYangBuilder.put(childProto.getYangArg(), childProto);
  94             if (childProto.isChoice()) {
  95                 final ChoiceNodeCodecContext<?> choice = (ChoiceNodeCodecContext<?>) childProto.get();
  96                 for(final Class<?> cazeChild : choice.getCaseChildrenClasses()) {
  97                     byBindingArgClassBuilder.put(cazeChild, childProto);
  98                 }
  99             }
 100         }
 101         this.byMethod = ImmutableSortedMap.copyOfSorted(byMethodBuilder);
 102         if (Augmentable.class.isAssignableFrom(getBindingClass())) {
 103             final ImmutableMap<AugmentationIdentifier, Type> augmentations = factory().getRuntimeContext()
 104                     .getAvailableAugmentationTypes(schema());
 105             for (final Entry<AugmentationIdentifier, Type> augment : augmentations.entrySet()) {
 106                 final DataContainerCodecPrototype<?> augProto = getAugmentationPrototype(augment.getValue());
 107                 if (augProto != null) {
 108                     byYangBuilder.put(augProto.getYangArg(), augProto);
 109                     byStreamClassBuilder.put(augProto.getBindingClass(), augProto);
 110                 }
 111             }
 112         }
 113
 114         this.byYang = ImmutableMap.copyOf(byYangBuilder);
 115         this.byStreamClass = ImmutableMap.copyOf(byStreamClassBuilder);
 116         byBindingArgClassBuilder.putAll(byStreamClass);
 117         this.byBindingArgClass = ImmutableMap.copyOf(byBindingArgClassBuilder);
 118
 119         final Class<?> proxyClass = Proxy.getProxyClass(getBindingClass().getClassLoader(),  new Class[] { getBindingClass() });
 120         try {
 121             proxyConstructor = LOOKUP.findConstructor(proxyClass, CONSTRUCTOR_TYPE).asType(DATAOBJECT_TYPE);
 122         } catch (NoSuchMethodException | IllegalAccessException e) {
 123             throw new IllegalStateException("Failed to find contructor for class " + proxyClass);
 124         }
 125     }
 126
 127
 128     @SuppressWarnings("unchecked")
 129     @Override
 130     public <DV extends DataObject> DataContainerCodecContext<DV, ?> streamChild(final Class<DV> childClass) {
 131         DataContainerCodecPrototype<?> childProto = byStreamClass.get(childClass);
 132         if (childProto != null) {
 133             return (DataContainerCodecContext<DV,?>) childProto.get();
 134         }
 135
 136         if (Augmentation.class.isAssignableFrom(childClass))  {
 137             /*
 138              * It is potentially mismatched valid augmentation - we look up equivalent augmentation
 139              * using reflection and walk all stream child and compare augmenations classes
 140              * if they are equivalent.
 141              *
 142              * FIXME: Cache mapping of mismatched augmentation to real one, to speed up lookup.
 143              */
 144             @SuppressWarnings("rawtypes")
 145             final Class<?> augTarget = BindingReflections.findAugmentationTarget((Class) childClass);
 146             if ((getBindingClass().equals(augTarget))) {
 147                 for (final DataContainerCodecPrototype<?> realChild : byStreamClass.values()) {
 148                     if (Augmentation.class.isAssignableFrom(realChild.getBindingClass())
 149                             && BindingReflections.isSubstitutionFor(childClass,realChild.getBindingClass())) {
 150                         childProto = realChild;
 151                         break;
 152                     }
 153                 }
 154             }
 155         }
 156         Preconditions.checkArgument(childProto != null, " Child %s is not valid child.",childClass);
 157         return (DataContainerCodecContext<DV, ?>) childProto.get();
 158     }
 159
 160
 161     @SuppressWarnings("unchecked")
 162     @Override
 163     public <DV extends DataObject> Optional<DataContainerCodecContext<DV, ?>> possibleStreamChild(
 164             Class<DV> childClass) {
 165         final DataContainerCodecPrototype<?> childProto = byStreamClass.get(childClass);
 166         if(childProto != null) {
 167             return Optional.<DataContainerCodecContext<DV,?>>of((DataContainerCodecContext<DV,?>) childProto.get());
 168         }
 169         return Optional.absent();
 170     }
 171
 172     @Override
 173     public DataContainerCodecContext<?,?> bindingPathArgumentChild(final InstanceIdentifier.PathArgument arg,
 174             final List<YangInstanceIdentifier.PathArgument> builder) {
 175
 176         final Class<? extends DataObject> argType = arg.getType();
 177         final DataContainerCodecPrototype<?> ctxProto = byBindingArgClass.get(argType);
 178         if(ctxProto != null) {
 179             final DataContainerCodecContext<?,?> context = ctxProto.get();
 180             if(context instanceof ChoiceNodeCodecContext) {
 181                 final ChoiceNodeCodecContext<?> choice = (ChoiceNodeCodecContext<?>) context;
 182                 final DataContainerCodecContext<?,?> caze = choice.getCazeByChildClass(arg.getType());
 183                 if(caze != null) {
 184                     choice.addYangPathArgument(arg, builder);
 185                     caze.addYangPathArgument(arg, builder);
 186                     return caze.bindingPathArgumentChild(arg, builder);
 187                 }
 188                 return null;
 189             }
 190             context.addYangPathArgument(arg, builder);
 191             return context;
 192         }
 193         // Argument is not valid child.
 194         return null;
 195     }
 196
 197     @SuppressWarnings("unchecked")
 198     @Override
 199     public NodeCodecContext<D> yangPathArgumentChild(YangInstanceIdentifier.PathArgument arg) {
 200         if(arg instanceof NodeIdentifierWithPredicates) {
 201             arg = new NodeIdentifier(arg.getNodeType());
 202         }
 203         final NodeContextSupplier childSupplier = byYang.get(arg);
 204         Preconditions.checkArgument(childSupplier != null, "Argument %s is not valid child of %s", arg, schema());
 205         return (NodeCodecContext<D>) childSupplier.get();
 206     }
 207
 208     protected final LeafNodeCodecContext<?> getLeafChild(final String name) {
 209         final LeafNodeCodecContext<?> value = leafChild.get(name);
 210         Preconditions.checkArgument(value != null, "Leaf %s is not valid for %s", name, getBindingClass());
 211         return value;
 212     }
 213
 214     private DataContainerCodecPrototype<?> loadChildPrototype(final Class<?> childClass) {
 215         final DataSchemaNode origDef = factory().getRuntimeContext().getSchemaDefinition(childClass);
 216         // Direct instantiation or use in same module in which grouping
 217         // was defined.
 218         DataSchemaNode sameName;
 219         try {
 220             sameName = schema().getDataChildByName(origDef.getQName());
 221         } catch (final IllegalArgumentException e) {
 222             sameName = null;
 223         }
 224         final DataSchemaNode childSchema;
 225         if (sameName != null) {
 226             // Exactly same schema node
 227             if (origDef.equals(sameName)) {
 228                 childSchema = sameName;
 229                 // We check if instantiated node was added via uses
 230                 // statement and is instantiation of same grouping
 231             } else if (origDef.equals(SchemaNodeUtils.getRootOriginalIfPossible(sameName))) {
 232                 childSchema = sameName;
 233             } else {
 234                 // Node has same name, but clearly is different
 235                 childSchema = null;
 236             }
 237         } else {
 238             // We are looking for instantiation via uses in other module
 239             final QName instantiedName = QName.create(namespace(), origDef.getQName().getLocalName());
 240             final DataSchemaNode potential = schema().getDataChildByName(instantiedName);
 241             // We check if it is really instantiated from same
 242             // definition as class was derived
 243             if (potential != null && origDef.equals(SchemaNodeUtils.getRootOriginalIfPossible(potential))) {
 244                 childSchema = potential;
 245             } else {
 246                 childSchema = null;
 247             }
 248         }
 249         Preconditions.checkArgument(childSchema != null, "Node %s does not have child named %s", schema(), childClass);
 250         return DataContainerCodecPrototype.from(childClass, childSchema, factory());
 251     }
 252
 253     private DataContainerCodecPrototype<?> getAugmentationPrototype(final Type value) {
 254         final ClassLoadingStrategy loader = factory().getRuntimeContext().getStrategy();
 255         @SuppressWarnings("rawtypes")
 256         final Class augClass;
 257         try {
 258             augClass = loader.loadClass(value);
 259         } catch (final ClassNotFoundException e) {
 260             LOG.warn("Failed to load augmentation prototype for {}", value, e);
 261             return null;
 262         }
 263
 264         @SuppressWarnings("unchecked")
 265         final Entry<AugmentationIdentifier, AugmentationSchema> augSchema = factory().getRuntimeContext()
 266                 .getResolvedAugmentationSchema(schema(), augClass);
 267         return DataContainerCodecPrototype.from(augClass, augSchema.getKey(), augSchema.getValue(), factory());
 268     }
 269
 270     @SuppressWarnings("rawtypes")
 271     Object getBindingChildValue(final Method method, final NormalizedNodeContainer domData) {
 272         final NodeCodecContext<?> childContext = byMethod.get(method).get();
 273         @SuppressWarnings("unchecked")
 274         final Optional<NormalizedNode<?, ?>> domChild = domData.getChild(childContext.getDomPathArgument());
 275         if (domChild.isPresent()) {
 276             return childContext.deserializeObject(domChild.get());
 277         }
 278         return null;
 279     }
 280
 281     protected final D createBindingProxy(final NormalizedNodeContainer<?, ?, ?> node) {
 282         try {
 283             return (D) proxyConstructor.invokeExact((InvocationHandler)new LazyDataObject<>(this, node));
 284         } catch (final Throwable e) {
 285             throw Throwables.propagate(e);
 286         }
 287     }
 288
 289     @SuppressWarnings("unchecked")
 290     public Map<Class<? extends Augmentation<?>>, Augmentation<?>> getAllAugmentationsFrom(
 291             final NormalizedNodeContainer<?, PathArgument, NormalizedNode<?, ?>> data) {
 292
 293         @SuppressWarnings("rawtypes")
 294         final Map map = new HashMap<>();
 295
 296         for(final DataContainerCodecPrototype<?> value : byStreamClass.values()) {
 297             if(Augmentation.class.isAssignableFrom(value.getBindingClass())) {
 298                 final Optional<NormalizedNode<?, ?>> augData = data.getChild(value.getYangArg());
 299                 if(augData.isPresent()) {
 300                     map.put(value.getBindingClass(), value.get().deserializeObject(augData.get()));
 301                 }
 302             }
 303         }
 304         return map;
 305     }
 306
 307     public Collection<Method> getHashCodeAndEqualsMethods() {
 308         // FIXME: Sort method in same order as in hashCode for generated class.
 309         return byMethod.keySet();
 310     }
 311
 312 }