binding/mdsal-binding-spec-util/src/main/java/org/opendaylight/mdsal/binding/spec/reflect/AugmentationFieldGetter.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.spec.reflect;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.cache.CacheBuilder;
  13 import com.google.common.cache.CacheLoader;
  14 import com.google.common.cache.LoadingCache;
  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.Field;
  20 import java.util.Collections;
  21 import java.util.Map;
  22 import org.opendaylight.mdsal.binding.spec.naming.BindingMapping;
  23 import org.opendaylight.yangtools.yang.binding.Augmentation;
  24 import org.opendaylight.yangtools.yang.binding.AugmentationHolder;
  25 import org.slf4j.Logger;
  26 import org.slf4j.LoggerFactory;
  27
  28 abstract class AugmentationFieldGetter {
  29
  30     private static final Logger LOG = LoggerFactory.getLogger(AugmentationFieldGetter.class);
  31
  32     private static final AugmentationFieldGetter DUMMY = new AugmentationFieldGetter() {
  33         @Override
  34         protected Map<Class<? extends Augmentation<?>>, Augmentation<?>> getAugmentations(final Object input) {
  35             return Collections.emptyMap();
  36         }
  37     };
  38
  39     private static final AugmentationFieldGetter AUGMENTATION_HOLDER_GETTER = new AugmentationFieldGetter() {
  40         @Override
  41         @SuppressWarnings({"unchecked", "rawtypes"})
  42         protected Map<Class<? extends Augmentation<?>>, Augmentation<?>> getAugmentations(final Object input) {
  43             return (Map) ((AugmentationHolder<?>) input).augmentations();
  44         }
  45     };
  46
  47     private static final LoadingCache<Class<?>, AugmentationFieldGetter> AUGMENTATION_GETTERS =
  48             CacheBuilder.newBuilder().weakKeys().build(new AugmentationGetterLoader());
  49
  50     /**
  51      * Retrieves augmentations from supplied object.
  52      *
  53      * @param input Input Data object, from which augmentations should be extracted
  54      * @return Map of Augmentation class to augmentation
  55      */
  56     protected abstract Map<Class<? extends Augmentation<?>>, Augmentation<?>> getAugmentations(Object input);
  57
  58     public static AugmentationFieldGetter getGetter(final Class<? extends Object> clz) {
  59         if (AugmentationHolder.class.isAssignableFrom(clz)) {
  60             return AUGMENTATION_HOLDER_GETTER;
  61         }
  62         return AUGMENTATION_GETTERS.getUnchecked(clz);
  63     }
  64
  65     private static final class AugmentationGetterLoader extends CacheLoader<Class<?>, AugmentationFieldGetter> {
  66         private static final MethodType GETTER_TYPE = MethodType.methodType(Map.class, Object.class);
  67         private static final Lookup LOOKUP = MethodHandles.lookup();
  68
  69         @Override
  70         public AugmentationFieldGetter load(final Class<?> key) throws IllegalAccessException {
  71             final Field field;
  72             try {
  73                 field = key.getDeclaredField(BindingMapping.AUGMENTATION_FIELD);
  74                 field.setAccessible(true);
  75             } catch (NoSuchFieldException | SecurityException e) {
  76                 LOG.warn("Failed to acquire augmentation field {}, ignoring augmentations in class {}",
  77                     BindingMapping.AUGMENTATION_FIELD, key, e);
  78                 return DUMMY;
  79             }
  80             if (!Map.class.isAssignableFrom(field.getType())) {
  81                 LOG.warn("Class {} field {} is not a Map, ignoring augmentations", key,
  82                     BindingMapping.AUGMENTATION_FIELD);
  83                 return DUMMY;
  84             }
  85
  86             return new ReflectionAugmentationFieldGetter(LOOKUP.unreflectGetter(field).asType(GETTER_TYPE));
  87         }
  88     }
  89
  90     private static final class ReflectionAugmentationFieldGetter extends AugmentationFieldGetter {
  91         private final MethodHandle fieldGetter;
  92
  93         ReflectionAugmentationFieldGetter(final MethodHandle mh) {
  94             this.fieldGetter = requireNonNull(mh);
  95         }
  96
  97         @Override
  98         @SuppressWarnings("checkstyle:illegalCatch")
  99         protected Map<Class<? extends Augmentation<?>>, Augmentation<?>> getAugmentations(final Object input) {
 100             try {
 101                 return (Map<Class<? extends Augmentation<?>>, Augmentation<?>>) fieldGetter.invokeExact(input);
 102             } catch (Throwable e) {
 103                 throw new IllegalStateException("Failed to access augmentation field on " + input, e);
 104             }
 105         }
 106     }
 107 }