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<T extends DataNodeContainer> extends DataContainerCodecContext<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     // FIXME: this field seems to be unused
  72     private final Method augmentationGetter;
  73
  74     protected DataObjectCodecContext(final DataContainerCodecPrototype<T> prototype) {
  75         super(prototype);
  76
  77         this.leafChild = factory().getLeafNodes(bindingClass(), schema());
  78
  79         Map<Class<?>, Method> clsToMethod = BindingReflections.getChildrenClassToMethod(bindingClass());
  80
  81         Map<YangInstanceIdentifier.PathArgument, NodeContextSupplier> byYangBuilder = new HashMap<>();
  82         SortedMap<Method, NodeContextSupplier> byMethodBuilder = new TreeMap<>(METHOD_BY_ALPHABET);
  83         Map<Class<?>, DataContainerCodecPrototype<?>> byStreamClassBuilder = new HashMap<>();
  84         Map<Class<?>, DataContainerCodecPrototype<?>> byBindingArgClassBuilder = new HashMap<>();
  85
  86         // Adds leaves to mapping
  87         for (LeafNodeCodecContext leaf : leafChild.values()) {
  88             byMethodBuilder.put(leaf.getGetter(), leaf);
  89             byYangBuilder.put(leaf.getDomPathArgument(), leaf);
  90         }
  91
  92         for (Entry<Class<?>, Method> childDataObj : clsToMethod.entrySet()) {
  93             DataContainerCodecPrototype<?> childProto = loadChildPrototype(childDataObj.getKey());
  94             byMethodBuilder.put(childDataObj.getValue(), childProto);
  95             byStreamClassBuilder.put(childProto.getBindingClass(), childProto);
  96             byYangBuilder.put(childProto.getYangArg(), childProto);
  97             if (childProto.isChoice()) {
  98                 ChoiceNodeCodecContext choice = (ChoiceNodeCodecContext) childProto.get();
  99                 for(Class<?> cazeChild : choice.getCaseChildrenClasses()) {
 100                     byBindingArgClassBuilder.put(cazeChild, childProto);
 101                 }
 102             }
 103         }
 104         this.byMethod = ImmutableSortedMap.copyOfSorted(byMethodBuilder);
 105         if (Augmentable.class.isAssignableFrom(bindingClass())) {
 106             try {
 107                 augmentationGetter = bindingClass().getMethod("getAugmentation", Class.class);
 108             } catch (NoSuchMethodException | SecurityException e) {
 109                throw new IllegalStateException("Could not get required method.",e);
 110             }
 111             ImmutableMap<AugmentationIdentifier, Type> augmentations = factory().getRuntimeContext()
 112                     .getAvailableAugmentationTypes(schema());
 113             for (Entry<AugmentationIdentifier, Type> augment : augmentations.entrySet()) {
 114                 DataContainerCodecPrototype<?> augProto = getAugmentationPrototype(augment.getValue());
 115                 if (augProto != null) {
 116                     byYangBuilder.put(augProto.getYangArg(), augProto);
 117                     byStreamClassBuilder.put(augProto.getBindingClass(), augProto);
 118                 }
 119             }
 120         } else {
 121             augmentationGetter = null;
 122         }
 123
 124         this.byYang = ImmutableMap.copyOf(byYangBuilder);
 125         this.byStreamClass = ImmutableMap.copyOf(byStreamClassBuilder);
 126         byBindingArgClassBuilder.putAll(byStreamClass);
 127         this.byBindingArgClass = ImmutableMap.copyOf(byBindingArgClassBuilder);
 128
 129         final Class<?> proxyClass = Proxy.getProxyClass(bindingClass().getClassLoader(),  new Class[] { bindingClass() });
 130         try {
 131             proxyConstructor = LOOKUP.findConstructor(proxyClass, CONSTRUCTOR_TYPE).asType(DATAOBJECT_TYPE);
 132         } catch (NoSuchMethodException | IllegalAccessException e) {
 133             throw new IllegalStateException("Failed to find contructor for class " + proxyClass);
 134         }
 135     }
 136
 137     @Override
 138     protected DataContainerCodecContext<?> getStreamChild(final Class<?> childClass) {
 139         DataContainerCodecPrototype<?> childProto = byStreamClass.get(childClass);
 140         if (childProto != null) {
 141             return childProto.get();
 142         }
 143
 144         if (Augmentation.class.isAssignableFrom(childClass))  {
 145             /*
 146              * It is potentially mismatched valid augmentation - we look up equivalent augmentation
 147              * using reflection and walk all stream child and compare augmenations classes
 148              * if they are equivalent.
 149              *
 150              * FIXME: Cache mapping of mismatched augmentation to real one, to speed up lookup.
 151              */
 152             Class<?> augTarget = BindingReflections.findAugmentationTarget((Class) childClass);
 153             if ((bindingClass().equals(augTarget))) {
 154                 for (DataContainerCodecPrototype<?> realChild : byStreamClass.values()) {
 155                     if (Augmentation.class.isAssignableFrom(realChild.getBindingClass())
 156                             && BindingReflections.isSubstitutionFor(childClass,realChild.getBindingClass())) {
 157                         childProto = realChild;
 158                         break;
 159                     }
 160                 }
 161             }
 162         }
 163         Preconditions.checkArgument(childProto != null, " Child %s is not valid child.",childClass);
 164         return childProto.get();
 165     }
 166
 167     @Override
 168     protected Optional<DataContainerCodecContext<?>> getPossibleStreamChild(final Class<?> childClass) {
 169         DataContainerCodecPrototype<?> childProto = byStreamClass.get(childClass);
 170         if(childProto != null) {
 171             return Optional.<DataContainerCodecContext<?>>of(childProto.get());
 172         }
 173         return Optional.absent();
 174     }
 175
 176     @Override
 177     protected DataContainerCodecContext<?> getIdentifierChild(final InstanceIdentifier.PathArgument arg,
 178             final List<YangInstanceIdentifier.PathArgument> builder) {
 179
 180         final Class<? extends DataObject> argType = arg.getType();
 181         final DataContainerCodecPrototype<?> ctxProto = byBindingArgClass.get(argType);
 182         if(ctxProto != null) {
 183             final DataContainerCodecContext<?> context = ctxProto.get();
 184             if(context instanceof ChoiceNodeCodecContext) {
 185                 final ChoiceNodeCodecContext choice = (ChoiceNodeCodecContext) context;
 186                 final DataContainerCodecContext<?> caze = choice.getCazeByChildClass(arg.getType());
 187                 if(caze != null) {
 188                     choice.addYangPathArgument(arg, builder);
 189                     caze.addYangPathArgument(arg, builder);
 190                     return caze.getIdentifierChild(arg, builder);
 191                 }
 192                 return null;
 193             }
 194             context.addYangPathArgument(arg, builder);
 195             return context;
 196         }
 197         // Argument is not valid child.
 198         return null;
 199     }
 200
 201     @Override
 202     protected NodeCodecContext getYangIdentifierChild(YangInstanceIdentifier.PathArgument arg) {
 203         if(arg instanceof NodeIdentifierWithPredicates) {
 204             arg = new NodeIdentifier(arg.getNodeType());
 205         }
 206         NodeContextSupplier childSupplier = byYang.get(arg);
 207         Preconditions.checkArgument(childSupplier != null, "Argument %s is not valid child of %s", arg, schema());
 208         return childSupplier.get();
 209     }
 210
 211     protected final LeafNodeCodecContext getLeafChild(final String name) {
 212         final LeafNodeCodecContext value = leafChild.get(name);
 213         Preconditions.checkArgument(value != null, "Leaf %s is not valid for %s", name, bindingClass());
 214         return value;
 215     }
 216
 217     private DataContainerCodecPrototype<?> loadChildPrototype(final Class<?> childClass) {
 218         DataSchemaNode origDef = factory().getRuntimeContext().getSchemaDefinition(childClass);
 219         // Direct instantiation or use in same module in which grouping
 220         // was defined.
 221         DataSchemaNode sameName;
 222         try {
 223             sameName = schema().getDataChildByName(origDef.getQName());
 224         } catch (IllegalArgumentException e) {
 225             sameName = null;
 226         }
 227         final DataSchemaNode childSchema;
 228         if (sameName != null) {
 229             // Exactly same schema node
 230             if (origDef.equals(sameName)) {
 231                 childSchema = sameName;
 232                 // We check if instantiated node was added via uses
 233                 // statement and is instantiation of same grouping
 234             } else if (origDef.equals(SchemaNodeUtils.getRootOriginalIfPossible(sameName))) {
 235                 childSchema = sameName;
 236             } else {
 237                 // Node has same name, but clearly is different
 238                 childSchema = null;
 239             }
 240         } else {
 241             // We are looking for instantiation via uses in other module
 242             QName instantiedName = QName.create(namespace(), origDef.getQName().getLocalName());
 243             DataSchemaNode potential = schema().getDataChildByName(instantiedName);
 244             // We check if it is really instantiated from same
 245             // definition as class was derived
 246             if (potential != null && origDef.equals(SchemaNodeUtils.getRootOriginalIfPossible(potential))) {
 247                 childSchema = potential;
 248             } else {
 249                 childSchema = null;
 250             }
 251         }
 252         Preconditions.checkArgument(childSchema != null, "Node %s does not have child named %s", schema(), childClass);
 253         return DataContainerCodecPrototype.from(childClass, childSchema, factory());
 254     }
 255
 256     private DataContainerCodecPrototype<?> getAugmentationPrototype(final Type value) {
 257         ClassLoadingStrategy loader = factory().getRuntimeContext().getStrategy();
 258         @SuppressWarnings("rawtypes")
 259         final Class augClass;
 260         try {
 261             augClass = loader.loadClass(value);
 262         } catch (ClassNotFoundException e) {
 263             LOG.warn("Failed to load augmentation prototype for {}", value, e);
 264             return null;
 265         }
 266
 267         Entry<AugmentationIdentifier, AugmentationSchema> augSchema = factory().getRuntimeContext()
 268                 .getResolvedAugmentationSchema(schema(), augClass);
 269         return DataContainerCodecPrototype.from(augClass, augSchema.getKey(), augSchema.getValue(), factory());
 270     }
 271
 272     @SuppressWarnings("rawtypes")
 273     Object getBindingChildValue(final Method method, final NormalizedNodeContainer domData) {
 274         NodeCodecContext childContext = byMethod.get(method).get();
 275         Optional<NormalizedNode<?, ?>> domChild = domData.getChild(childContext.getDomPathArgument());
 276         if (domChild.isPresent()) {
 277             return childContext.dataFromNormalizedNode(domChild.get());
 278         }
 279         return null;
 280     }
 281
 282     protected final DataObject createBindingProxy(final NormalizedNodeContainer<?, ?, ?> node) {
 283         try {
 284             return (DataObject) proxyConstructor.invokeExact((InvocationHandler)new LazyDataObject(this, node));
 285         } catch (Throwable e) {
 286             throw Throwables.propagate(e);
 287         }
 288     }
 289
 290     public Map<Class<? extends Augmentation<?>>, Augmentation<?>> getAllAugmentationsFrom(
 291             final NormalizedNodeContainer<?, PathArgument, NormalizedNode<?, ?>> data) {
 292
 293         @SuppressWarnings("rawtypes")
 294         Map map = new HashMap<>();
 295
 296         for(DataContainerCodecPrototype<?> value : byStreamClass.values()) {
 297             if(Augmentation.class.isAssignableFrom(value.getBindingClass())) {
 298                 Optional<NormalizedNode<?, ?>> augData = data.getChild(value.getYangArg());
 299                 if(augData.isPresent()) {
 300                     map.put(value.getBindingClass(), value.get().dataFromNormalizedNode(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 }