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