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