binding/mdsal-binding-dom-codec/src/main/java/org/opendaylight/mdsal/binding/dom/codec/impl/IdentifiableItemCodec.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.mdsal.binding.dom.codec.impl;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.base.Throwables;
  13 import com.google.common.collect.ImmutableList;
  14 import java.lang.invoke.MethodHandle;
  15 import java.lang.invoke.MethodHandles;
  16 import java.lang.invoke.MethodType;
  17 import java.lang.reflect.Constructor;
  18 import java.util.ArrayList;
  19 import java.util.Comparator;
  20 import java.util.List;
  21 import java.util.Map;
  22 import java.util.Map.Entry;
  23 import org.eclipse.jdt.annotation.NonNull;
  24 import org.opendaylight.mdsal.binding.spec.naming.BindingMapping;
  25 import org.opendaylight.yangtools.concepts.Codec;
  26 import org.opendaylight.yangtools.util.ImmutableOffsetMap;
  27 import org.opendaylight.yangtools.util.ImmutableOffsetMapTemplate;
  28 import org.opendaylight.yangtools.util.SharedSingletonMapTemplate;
  29 import org.opendaylight.yangtools.yang.binding.Identifiable;
  30 import org.opendaylight.yangtools.yang.binding.Identifier;
  31 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.IdentifiableItem;
  32 import org.opendaylight.yangtools.yang.common.QName;
  33 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  34 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  35
  36 /**
  37  * Codec support for extracting the {@link Identifiable#key()} method return from a MapEntryNode.
  38  */
  39 abstract class IdentifiableItemCodec implements Codec<NodeIdentifierWithPredicates, IdentifiableItem<?, ?>> {
  40     private static final class SingleKey extends IdentifiableItemCodec {
  41         private static final MethodType CTOR_TYPE = MethodType.methodType(Identifier.class, Object.class);
  42
  43         private final SharedSingletonMapTemplate<QName> predicateTemplate;
  44         private final ValueContext keyContext;
  45         private final MethodHandle ctor;
  46         private final QName keyName;
  47
  48         SingleKey(final ListSchemaNode schema, final Class<? extends Identifier<?>> keyClass,
  49                 final Class<?> identifiable, final QName keyName, final ValueContext keyContext) {
  50             super(schema, keyClass, identifiable);
  51             this.keyContext = requireNonNull(keyContext);
  52             this.keyName = requireNonNull(keyName);
  53             predicateTemplate = SharedSingletonMapTemplate.ordered(keyName);
  54             ctor = getConstructor(keyClass).asType(CTOR_TYPE);
  55         }
  56
  57         @Override
  58         Identifier<?> deserializeIdentifier(final Map<QName, Object> keyValues) throws Throwable {
  59             return (Identifier<?>) ctor.invokeExact(keyContext.deserialize(keyValues.get(keyName)));
  60         }
  61
  62         @Override
  63         NodeIdentifierWithPredicates serializeIdentifier(final QName qname, final Identifier<?> key) {
  64             return NodeIdentifierWithPredicates.of(qname, predicateTemplate.instantiateWithValue(
  65                 keyContext.getAndSerialize(key)));
  66         }
  67     }
  68
  69     private static final class MultiKey extends IdentifiableItemCodec {
  70         private final ImmutableOffsetMapTemplate<QName> predicateTemplate;
  71         private final ImmutableOffsetMap<QName, ValueContext> keyValueContexts;
  72         private final ImmutableList<QName> keysInBindingOrder;
  73         private final MethodHandle ctor;
  74
  75         MultiKey(final ListSchemaNode schema, final Class<? extends Identifier<?>> keyClass,
  76                 final Class<?> identifiable, final Map<QName, ValueContext> keyValueContexts) {
  77             super(schema, keyClass, identifiable);
  78
  79             final MethodHandle tmpCtor = getConstructor(keyClass);
  80             final MethodHandle inv = MethodHandles.spreadInvoker(tmpCtor.type(), 0);
  81             this.ctor = inv.asType(inv.type().changeReturnType(Identifier.class)).bindTo(tmpCtor);
  82
  83             /*
  84              * We need to re-index to make sure we instantiate nodes in the order in which they are defined. We will
  85              * also need to instantiate values in the same order.
  86              */
  87             final List<QName> keyDef = schema.getKeyDefinition();
  88             predicateTemplate = ImmutableOffsetMapTemplate.ordered(keyDef);
  89             this.keyValueContexts = predicateTemplate.instantiateTransformed(keyValueContexts, (key, value) -> value);
  90
  91             /*
  92              * When instantiating binding objects we need to specify constructor arguments in alphabetic order. If the
  93              * order matches definition order, we try to reuse the key definition.
  94              *
  95              * BUG-2755: remove this if order is made declaration-order-dependent
  96              */
  97             final List<QName> tmp = new ArrayList<>(keyDef);
  98             // This is not terribly efficient but gets the job done
  99             tmp.sort(Comparator.comparing(qname -> BindingMapping.getPropertyName(qname.getLocalName())));
 100             this.keysInBindingOrder = ImmutableList.copyOf(tmp.equals(keyDef) ? keyDef : tmp);
 101         }
 102
 103         @Override
 104         Identifier<?> deserializeIdentifier(final Map<QName, Object> keyValues) throws Throwable {
 105             final Object[] bindingValues = new Object[keysInBindingOrder.size()];
 106             int offset = 0;
 107             for (final QName key : keysInBindingOrder) {
 108                 bindingValues[offset++] = keyValueContexts.get(key).deserialize(keyValues.get(key));
 109             }
 110
 111             return (Identifier<?>) ctor.invokeExact(bindingValues);
 112         }
 113
 114         @Override
 115         NodeIdentifierWithPredicates serializeIdentifier(final QName qname, final Identifier<?> key) {
 116             final Object[] values = new Object[keyValueContexts.size()];
 117             int offset = 0;
 118             for (final ValueContext valueCtx : keyValueContexts.values()) {
 119                 values[offset++] = valueCtx.getAndSerialize(key);
 120             }
 121
 122             return NodeIdentifierWithPredicates.of(qname, predicateTemplate.instantiateWithValues(values));
 123         }
 124     }
 125
 126     private final Class<?> identifiable;
 127     private final QName qname;
 128
 129     IdentifiableItemCodec(final ListSchemaNode schema, final Class<? extends Identifier<?>> keyClass,
 130             final Class<?> identifiable) {
 131         this.identifiable = requireNonNull(identifiable);
 132         this.qname = schema.getQName();
 133     }
 134
 135     static IdentifiableItemCodec of(final ListSchemaNode schema,
 136             final Class<? extends Identifier<?>> keyClass, final Class<?> identifiable,
 137                     final Map<QName, ValueContext> keyValueContexts) {
 138         switch (keyValueContexts.size()) {
 139             case 0:
 140                 throw new IllegalArgumentException("Key " + keyClass + " of " + identifiable + " has no components");
 141             case 1:
 142                 final Entry<QName, ValueContext> entry = keyValueContexts.entrySet().iterator().next();
 143                 return new SingleKey(schema, keyClass, identifiable, entry.getKey(), entry.getValue());
 144             default:
 145                 return new MultiKey(schema, keyClass, identifiable, keyValueContexts);
 146         }
 147     }
 148
 149     @Override
 150     @SuppressWarnings({ "rawtypes", "unchecked", "checkstyle:illegalCatch" })
 151     public final IdentifiableItem<?, ?> deserialize(final NodeIdentifierWithPredicates input) {
 152         final Identifier<?> identifier = deserializeIdentifier(input);
 153         return IdentifiableItem.of((Class) identifiable, (Identifier) identifier);
 154     }
 155
 156     @Override
 157     public final NodeIdentifierWithPredicates serialize(final IdentifiableItem<?, ?> input) {
 158         return serializeIdentifier(qname, input.getKey());
 159     }
 160
 161     @SuppressWarnings("checkstyle:illegalCatch")
 162     final @NonNull Identifier<?> deserializeIdentifier(final NodeIdentifierWithPredicates input) {
 163         try {
 164             return deserializeIdentifier(input.asMap());
 165         } catch (Throwable e) {
 166             Throwables.throwIfUnchecked(e);
 167             throw new IllegalStateException("Failed to deserialize " + input, e);
 168         }
 169     }
 170
 171     @SuppressWarnings("checkstyle:illegalThrows")
 172     abstract @NonNull Identifier<?> deserializeIdentifier(Map<QName, Object> keyValues) throws Throwable;
 173
 174     abstract @NonNull NodeIdentifierWithPredicates serializeIdentifier(QName qname, Identifier<?> key);
 175
 176     static MethodHandle getConstructor(final Class<? extends Identifier<?>> clazz) {
 177         for (@SuppressWarnings("rawtypes") final Constructor constr : clazz.getConstructors()) {
 178             final Class<?>[] parameters = constr.getParameterTypes();
 179             if (!clazz.equals(parameters[0])) {
 180                 // It is not copy constructor;
 181                 try {
 182                     return MethodHandles.publicLookup().unreflectConstructor(constr);
 183                 } catch (IllegalAccessException e) {
 184                     throw new IllegalStateException("Cannot access constructor " + constr + " in class " + clazz, e);
 185                 }
 186             }
 187         }
 188         throw new IllegalArgumentException("Supplied class " + clazz + "does not have required constructor.");
 189     }
 190 }