2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.mdsal.binding.dom.codec.impl;
10 import static com.google.common.base.Preconditions.checkArgument;
11 import static java.util.Objects.requireNonNull;
12 import static org.opendaylight.mdsal.binding.spec.naming.BindingMapping.AUGMENTABLE_AUGMENTATION_NAME;
13 import static org.opendaylight.mdsal.binding.spec.naming.BindingMapping.DATA_CONTAINER_GET_IMPLEMENTED_INTERFACE_NAME;
15 import com.google.common.base.MoreObjects;
16 import com.google.common.base.MoreObjects.ToStringHelper;
17 import com.google.common.collect.ImmutableMap;
18 import java.lang.reflect.InvocationHandler;
19 import java.lang.reflect.InvocationTargetException;
20 import java.lang.reflect.Method;
21 import java.lang.reflect.Proxy;
22 import java.util.Arrays;
24 import java.util.Objects;
25 import java.util.Optional;
26 import java.util.concurrent.ConcurrentHashMap;
27 import java.util.concurrent.atomic.AtomicReferenceFieldUpdater;
28 import org.opendaylight.mdsal.binding.dom.codec.util.AugmentationReader;
29 import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
30 import org.opendaylight.yangtools.yang.binding.Augmentable;
31 import org.opendaylight.yangtools.yang.binding.Augmentation;
32 import org.opendaylight.yangtools.yang.binding.DataObject;
33 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
34 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
35 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNodeContainer;
36 import org.slf4j.Logger;
37 import org.slf4j.LoggerFactory;
39 class LazyDataObject<D extends DataObject> implements InvocationHandler, AugmentationReader {
41 private static final Logger LOG = LoggerFactory.getLogger(LazyDataObject.class);
42 private static final String TO_STRING = "toString";
43 private static final String EQUALS = "equals";
44 private static final String HASHCODE = "hashCode";
45 private static final String AUGMENTATIONS = "augmentations";
46 private static final Object NULL_VALUE = new Object();
48 private final ConcurrentHashMap<String, Object> cachedData = new ConcurrentHashMap<>();
49 private final NormalizedNodeContainer<?, PathArgument, NormalizedNode<?, ?>> data;
50 private final DataObjectCodecContext<D,?> context;
52 @SuppressWarnings("rawtypes")
53 private static final AtomicReferenceFieldUpdater<LazyDataObject, ImmutableMap> CACHED_AUGMENTATIONS_UPDATER =
54 AtomicReferenceFieldUpdater.newUpdater(LazyDataObject.class, ImmutableMap.class, "cachedAugmentations");
55 private volatile ImmutableMap<Class<? extends Augmentation<?>>, Augmentation<?>> cachedAugmentations = null;
56 private volatile Integer cachedHashcode = null;
58 @SuppressWarnings({ "rawtypes", "unchecked" })
59 LazyDataObject(final DataObjectCodecContext<D,?> ctx, final NormalizedNodeContainer data) {
60 this.context = requireNonNull(ctx, "Context must not be null");
61 this.data = requireNonNull(data, "Data must not be null");
65 public Object invoke(final Object proxy, final Method method, final Object[] args) {
66 switch (method.getParameterCount()) {
68 switch (method.getName()) {
69 case DATA_CONTAINER_GET_IMPLEMENTED_INTERFACE_NAME:
70 return context.getBindingClass();
72 return bindingToString();
74 return bindingHashCode();
76 return getAugmentationsImpl();
78 return getBindingData(method);
81 switch (method.getName()) {
82 case AUGMENTABLE_AUGMENTATION_NAME:
83 return getAugmentationImpl((Class<?>) args[0]);
85 return bindingEquals(args[0]);
94 throw new UnsupportedOperationException("Unsupported method " + method);
97 private boolean bindingEquals(final Object other) {
101 final Class<D> bindingClass = context.getBindingClass();
102 if (!bindingClass.isAssignableFrom(other.getClass())) {
106 for (final Method m : context.getHashCodeAndEqualsMethods()) {
107 final Object thisValue = getBindingData(m);
108 final Object otherValue = m.invoke(other);
110 * added for valid byte array comparison, when list key type is binary
111 * deepEquals is not used since it does excessive amount of instanceof calls.
113 if (thisValue instanceof byte[] && otherValue instanceof byte[]) {
114 if (!Arrays.equals((byte[]) thisValue, (byte[]) otherValue)) {
117 } else if (!Objects.equals(thisValue, otherValue)) {
122 if (Augmentable.class.isAssignableFrom(bindingClass)) {
123 if (!getAugmentationsImpl().equals(getAllAugmentations(other))) {
127 } catch (IllegalAccessException | IllegalArgumentException | InvocationTargetException e) {
128 LOG.warn("Can not determine equality of {} and {}", this, other, e);
134 private static Map<Class<? extends Augmentation<?>>, Augmentation<?>> getAllAugmentations(final Object dataObject) {
135 if (dataObject instanceof AugmentationReader) {
136 return ((AugmentationReader) dataObject).getAugmentations(dataObject);
137 } else if (dataObject instanceof Augmentable<?>) {
138 return BindingReflections.getAugmentations((Augmentable<?>) dataObject);
141 throw new IllegalArgumentException("Unable to get all augmentations from " + dataObject);
144 private Integer bindingHashCode() {
145 final Integer ret = cachedHashcode;
150 final int prime = 31;
152 for (final Method m : context.getHashCodeAndEqualsMethods()) {
153 final Object value = getBindingData(m);
154 result = prime * result + Objects.hashCode(value);
156 if (Augmentable.class.isAssignableFrom(context.getBindingClass())) {
157 result = prime * result + getAugmentationsImpl().hashCode();
159 cachedHashcode = result;
163 private Object getBindingData(final Method method) {
164 // Guaranteed to be interned and since method has zero arguments, name is sufficient to identify the data,
165 // skipping Method.hashCode() computation.
166 final String methodName = method.getName();
167 Object cached = cachedData.get(methodName);
168 if (cached == null) {
169 final Object readedValue = context.getBindingChildValue(method, data);
170 cached = readedValue == null ? NULL_VALUE : readedValue;
172 final Object raced = cachedData.putIfAbsent(methodName, cached);
174 // Load/store raced, we should return the stored value
179 return cached == NULL_VALUE ? null : cached;
182 private Map<Class<? extends Augmentation<?>>, Augmentation<?>> getAugmentationsImpl() {
183 ImmutableMap<Class<? extends Augmentation<?>>, Augmentation<?>> local = cachedAugmentations;
188 local = ImmutableMap.copyOf(context.getAllAugmentationsFrom(data));
189 return CACHED_AUGMENTATIONS_UPDATER.compareAndSet(this, null, local) ? local : cachedAugmentations;
193 public Map<Class<? extends Augmentation<?>>, Augmentation<?>> getAugmentations(final Object obj) {
194 checkArgument(this == Proxy.getInvocationHandler(obj),
195 "Supplied object is not associated with this proxy handler");
197 return getAugmentationsImpl();
200 private Object getAugmentationImpl(final Class<?> cls) {
201 requireNonNull(cls, "Supplied augmentation must not be null.");
203 final ImmutableMap<Class<? extends Augmentation<?>>, Augmentation<?>> aug = cachedAugmentations;
208 @SuppressWarnings({"unchecked","rawtypes"})
209 final Optional<DataContainerCodecContext<?, ?>> optAugCtx = context.possibleStreamChild((Class) cls);
210 if (optAugCtx.isPresent()) {
211 final DataContainerCodecContext<?, ?> augCtx = optAugCtx.get();
212 // Due to binding specification not representing grouping instantiations we can end up having the same
213 // augmentation applied to a grouping multiple times. While these augmentations have the same shape, they
214 // are still represented by distinct binding classes and therefore we need to make sure the result matches
215 // the augmentation the user is requesting -- otherwise a strict receiver would end up with a cryptic
216 // ClassCastException.
217 if (cls.isAssignableFrom(augCtx.getBindingClass())) {
218 final Optional<NormalizedNode<?, ?>> augData = data.getChild(augCtx.getDomPathArgument());
219 if (augData.isPresent()) {
220 return augCtx.deserialize(augData.get());
227 public String bindingToString() {
228 final Class<D> bindingClass = context.getBindingClass();
229 final ToStringHelper helper = MoreObjects.toStringHelper(bindingClass).omitNullValues();
231 for (final Method m : context.getHashCodeAndEqualsMethods()) {
232 helper.add(m.getName(), getBindingData(m));
234 if (Augmentable.class.isAssignableFrom(bindingClass)) {
235 helper.add("augmentations", getAugmentationsImpl());
237 return helper.toString();
241 public int hashCode() {
242 final int prime = 31;
244 result = prime * result + context.hashCode();
245 result = prime * result + data.hashCode();
250 public boolean equals(final Object obj) {
257 if (getClass() != obj.getClass()) {
260 final LazyDataObject<?> other = (LazyDataObject<?>) obj;
261 return Objects.equals(context, other.context) && Objects.equals(data, other.data);