binding/mdsal-binding-dom-codec/src/main/java/org/opendaylight/mdsal/binding/dom/codec/impl/LazyDataObject.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 com.google.common.base.Preconditions.checkArgument;
  11 import static java.util.Objects.requireNonNull;
  12
  13 import com.google.common.base.MoreObjects;
  14 import com.google.common.base.MoreObjects.ToStringHelper;
  15 import com.google.common.collect.ImmutableMap;
  16 import java.lang.reflect.InvocationHandler;
  17 import java.lang.reflect.InvocationTargetException;
  18 import java.lang.reflect.Method;
  19 import java.lang.reflect.Proxy;
  20 import java.util.Arrays;
  21 import java.util.Map;
  22 import java.util.Objects;
  23 import java.util.Optional;
  24 import java.util.concurrent.ConcurrentHashMap;
  25 import org.opendaylight.mdsal.binding.dom.codec.util.AugmentationReader;
  26 import org.opendaylight.mdsal.binding.spec.naming.BindingMapping;
  27 import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
  28 import org.opendaylight.yangtools.yang.binding.Augmentable;
  29 import org.opendaylight.yangtools.yang.binding.Augmentation;
  30 import org.opendaylight.yangtools.yang.binding.DataObject;
  31 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  32 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  33 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNodeContainer;
  34 import org.slf4j.Logger;
  35 import org.slf4j.LoggerFactory;
  36
  37 class LazyDataObject<D extends DataObject> implements InvocationHandler, AugmentationReader {
  38
  39     private static final Logger LOG = LoggerFactory.getLogger(LazyDataObject.class);
  40     private static final String GET_IMPLEMENTED_INTERFACE = "getImplementedInterface";
  41     private static final String TO_STRING = "toString";
  42     private static final String EQUALS = "equals";
  43     private static final String HASHCODE = "hashCode";
  44     private static final String AUGMENTATIONS = "augmentations";
  45     private static final Object NULL_VALUE = new Object();
  46
  47     private final ConcurrentHashMap<Method, Object> cachedData = new ConcurrentHashMap<>();
  48     private final NormalizedNodeContainer<?, PathArgument, NormalizedNode<?, ?>> data;
  49     private final DataObjectCodecContext<D,?> context;
  50
  51     private volatile ImmutableMap<Class<? extends Augmentation<?>>, Augmentation<?>> cachedAugmentations = null;
  52     private volatile Integer cachedHashcode = null;
  53
  54     @SuppressWarnings({ "rawtypes", "unchecked" })
  55     LazyDataObject(final DataObjectCodecContext<D,?> ctx, final NormalizedNodeContainer data) {
  56         this.context = requireNonNull(ctx, "Context must not be null");
  57         this.data = requireNonNull(data, "Data must not be null");
  58     }
  59
  60     @Override
  61     public Object invoke(final Object proxy, final Method method, final Object[] args) throws Throwable {
  62         if (method.getParameterTypes().length == 0) {
  63             final String name = method.getName();
  64             if (GET_IMPLEMENTED_INTERFACE.equals(name)) {
  65                 return context.getBindingClass();
  66             } else if (TO_STRING.equals(name)) {
  67                 return bindingToString();
  68             } else if (HASHCODE.equals(name)) {
  69                 return bindingHashCode();
  70             } else if (AUGMENTATIONS.equals(name)) {
  71                 return getAugmentationsImpl();
  72             }
  73             return getBindingData(method);
  74         } else if (BindingMapping.AUGMENTABLE_AUGMENTATION_NAME.equals(method.getName())) {
  75             return getAugmentationImpl((Class<?>) args[0]);
  76         } else if (EQUALS.equals(method.getName())) {
  77             return bindingEquals(args[0]);
  78         }
  79         throw new UnsupportedOperationException("Unsupported method " + method);
  80     }
  81
  82     private boolean bindingEquals(final Object other) {
  83         if (other == null) {
  84             return false;
  85         }
  86         if (!context.getBindingClass().isAssignableFrom(other.getClass())) {
  87             return false;
  88         }
  89         try {
  90             for (final Method m : context.getHashCodeAndEqualsMethods()) {
  91                 final Object thisValue = getBindingData(m);
  92                 final Object otherValue = m.invoke(other);
  93                 /*
  94                 *   added for valid byte array comparison, when list key type is binary
  95                 *   deepEquals is not used since it does excessive amount of instanceof calls.
  96                 */
  97                 if (thisValue instanceof byte[] && otherValue instanceof byte[]) {
  98                     if (!Arrays.equals((byte[]) thisValue, (byte[]) otherValue)) {
  99                         return false;
 100                     }
 101                 } else if (!Objects.equals(thisValue, otherValue)) {
 102                     return false;
 103                 }
 104             }
 105
 106             if (Augmentable.class.isAssignableFrom(context.getBindingClass())) {
 107                 if (!getAugmentationsImpl().equals(getAllAugmentations(other))) {
 108                     return false;
 109                 }
 110             }
 111         } catch (IllegalAccessException | IllegalArgumentException | InvocationTargetException e) {
 112             LOG.warn("Can not determine equality of {} and {}", this, other, e);
 113             return false;
 114         }
 115         return true;
 116     }
 117
 118     private static Map<Class<? extends Augmentation<?>>, Augmentation<?>> getAllAugmentations(final Object dataObject) {
 119         if (dataObject instanceof AugmentationReader) {
 120             return ((AugmentationReader) dataObject).getAugmentations(dataObject);
 121         } else if (dataObject instanceof Augmentable<?>) {
 122             return BindingReflections.getAugmentations((Augmentable<?>) dataObject);
 123         }
 124
 125         throw new IllegalArgumentException("Unable to get all augmentations from " + dataObject);
 126     }
 127
 128     private Integer bindingHashCode() {
 129         final Integer ret = cachedHashcode;
 130         if (ret != null) {
 131             return ret;
 132         }
 133
 134         final int prime = 31;
 135         int result = 1;
 136         for (final Method m : context.getHashCodeAndEqualsMethods()) {
 137             final Object value = getBindingData(m);
 138             result = prime * result + Objects.hashCode(value);
 139         }
 140         if (Augmentable.class.isAssignableFrom(context.getBindingClass())) {
 141             result = prime * result + getAugmentationsImpl().hashCode();
 142         }
 143         cachedHashcode = result;
 144         return result;
 145     }
 146
 147     private Object getBindingData(final Method method) {
 148         Object cached = cachedData.get(method);
 149         if (cached == null) {
 150             final Object readedValue = context.getBindingChildValue(method, data);
 151             cached = readedValue == null ? NULL_VALUE : readedValue;
 152
 153             final Object raced = cachedData.putIfAbsent(method, cached);
 154             if (raced != null) {
 155                 // Load/store raced, we should return the stored value
 156                 cached = raced;
 157             }
 158         }
 159
 160         return cached == NULL_VALUE ? null : cached;
 161     }
 162
 163     private Map<Class<? extends Augmentation<?>>, Augmentation<?>> getAugmentationsImpl() {
 164         ImmutableMap<Class<? extends Augmentation<?>>, Augmentation<?>> ret = cachedAugmentations;
 165         if (ret == null) {
 166             synchronized (this) {
 167                 ret = cachedAugmentations;
 168                 if (ret == null) {
 169                     ret = ImmutableMap.copyOf(context.getAllAugmentationsFrom(data));
 170                     cachedAugmentations = ret;
 171                 }
 172             }
 173         }
 174
 175         return ret;
 176     }
 177
 178     @Override
 179     public Map<Class<? extends Augmentation<?>>, Augmentation<?>> getAugmentations(final Object obj) {
 180         checkArgument(this == Proxy.getInvocationHandler(obj),
 181                 "Supplied object is not associated with this proxy handler");
 182
 183         return getAugmentationsImpl();
 184     }
 185
 186     private Object getAugmentationImpl(final Class<?> cls) {
 187         requireNonNull(cls, "Supplied augmentation must not be null.");
 188
 189         final ImmutableMap<Class<? extends Augmentation<?>>, Augmentation<?>> aug = cachedAugmentations;
 190         if (aug != null) {
 191             return aug.get(cls);
 192         }
 193
 194         @SuppressWarnings({"unchecked","rawtypes"})
 195         final Optional<DataContainerCodecContext<?, ?>> optAugCtx = context.possibleStreamChild((Class) cls);
 196         if (optAugCtx.isPresent()) {
 197             final DataContainerCodecContext<?, ?> augCtx = optAugCtx.get();
 198             // Due to binding specification not representing grouping instantiations we can end up having the same
 199             // augmentation applied to a grouping multiple times. While these augmentations have the same shape, they
 200             // are still represented by distinct binding classes and therefore we need to make sure the result matches
 201             // the augmentation the user is requesting -- otherwise a strict receiver would end up with a cryptic
 202             // ClassCastException.
 203             if (cls.isAssignableFrom(augCtx.getBindingClass())) {
 204                 final java.util.Optional<NormalizedNode<?, ?>> augData = data.getChild(augCtx.getDomPathArgument());
 205                 if (augData.isPresent()) {
 206                     return augCtx.deserialize(augData.get());
 207                 }
 208             }
 209         }
 210         return null;
 211     }
 212
 213     public String bindingToString() {
 214         final ToStringHelper helper = MoreObjects.toStringHelper(context.getBindingClass()).omitNullValues();
 215
 216         for (final Method m : context.getHashCodeAndEqualsMethods()) {
 217             helper.add(m.getName(), getBindingData(m));
 218         }
 219         if (Augmentable.class.isAssignableFrom(context.getBindingClass())) {
 220             helper.add("augmentations", getAugmentationsImpl());
 221         }
 222         return helper.toString();
 223     }
 224
 225     @Override
 226     public int hashCode() {
 227         final int prime = 31;
 228         int result = 1;
 229         result = prime * result + context.hashCode();
 230         result = prime * result + data.hashCode();
 231         return result;
 232     }
 233
 234     @Override
 235     public boolean equals(final Object obj) {
 236         if (this == obj) {
 237             return true;
 238         }
 239         if (obj == null) {
 240             return false;
 241         }
 242         if (getClass() != obj.getClass()) {
 243             return false;
 244         }
 245         final LazyDataObject<?> other = (LazyDataObject<?>) obj;
 246         return Objects.equals(context, other.context) && Objects.equals(data, other.data);
 247     }
 248 }