binding/mdsal-binding-spec-util/src/main/java/org/opendaylight/mdsal/binding/spec/reflect/BindingReflections.java

   1 /*
   2  * Copyright (c) 2013 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 com.google.common.base.Preconditions.checkArgument;
  11 import static com.google.common.base.Preconditions.checkState;
  12 import static com.google.common.base.Verify.verifyNotNull;
  13 import static java.util.Objects.requireNonNull;
  14
  15 import com.google.common.annotations.Beta;
  16 import com.google.common.cache.CacheBuilder;
  17 import com.google.common.cache.CacheLoader;
  18 import com.google.common.cache.LoadingCache;
  19 import com.google.common.collect.ImmutableSet;
  20 import com.google.common.collect.ImmutableSet.Builder;
  21 import com.google.common.util.concurrent.ListenableFuture;
  22 import java.lang.reflect.Field;
  23 import java.lang.reflect.Method;
  24 import java.lang.reflect.Modifier;
  25 import java.lang.reflect.ParameterizedType;
  26 import java.lang.reflect.Type;
  27 import java.util.Arrays;
  28 import java.util.HashMap;
  29 import java.util.HashSet;
  30 import java.util.LinkedList;
  31 import java.util.List;
  32 import java.util.Map;
  33 import java.util.Optional;
  34 import java.util.ServiceLoader;
  35 import java.util.Set;
  36 import java.util.concurrent.TimeUnit;
  37 import java.util.regex.Matcher;
  38 import java.util.regex.Pattern;
  39 import org.checkerframework.checker.regex.qual.Regex;
  40 import org.eclipse.jdt.annotation.NonNull;
  41 import org.opendaylight.mdsal.binding.spec.naming.BindingMapping;
  42 import org.opendaylight.yangtools.util.ClassLoaderUtils;
  43 import org.opendaylight.yangtools.yang.binding.Action;
  44 import org.opendaylight.yangtools.yang.binding.Augmentable;
  45 import org.opendaylight.yangtools.yang.binding.Augmentation;
  46 import org.opendaylight.yangtools.yang.binding.BaseIdentity;
  47 import org.opendaylight.yangtools.yang.binding.ChildOf;
  48 import org.opendaylight.yangtools.yang.binding.DataContainer;
  49 import org.opendaylight.yangtools.yang.binding.DataObject;
  50 import org.opendaylight.yangtools.yang.binding.Notification;
  51 import org.opendaylight.yangtools.yang.binding.RpcService;
  52 import org.opendaylight.yangtools.yang.binding.YangModelBindingProvider;
  53 import org.opendaylight.yangtools.yang.binding.YangModuleInfo;
  54 import org.opendaylight.yangtools.yang.common.QName;
  55 import org.opendaylight.yangtools.yang.common.QNameModule;
  56 import org.opendaylight.yangtools.yang.common.YangConstants;
  57 import org.slf4j.Logger;
  58 import org.slf4j.LoggerFactory;
  59
  60 public final class BindingReflections {
  61
  62     private static final long EXPIRATION_TIME = 60;
  63
  64     @Regex
  65     private static final String ROOT_PACKAGE_PATTERN_STRING =
  66             "(org.opendaylight.yang.gen.v1.[a-z0-9_\\.]*\\.(?:rev[0-9][0-9][0-1][0-9][0-3][0-9]|norev))";
  67     private static final Pattern ROOT_PACKAGE_PATTERN = Pattern.compile(ROOT_PACKAGE_PATTERN_STRING);
  68     private static final Logger LOG = LoggerFactory.getLogger(BindingReflections.class);
  69
  70     private static final LoadingCache<Class<?>, Optional<QName>> CLASS_TO_QNAME = CacheBuilder.newBuilder()
  71             .weakKeys()
  72             .expireAfterAccess(EXPIRATION_TIME, TimeUnit.SECONDS)
  73             .build(new ClassToQNameLoader());
  74
  75     private static final LoadingCache<ClassLoader, ImmutableSet<YangModuleInfo>> MODULE_INFO_CACHE =
  76             CacheBuilder.newBuilder().weakKeys().weakValues().build(
  77                 new CacheLoader<ClassLoader, ImmutableSet<YangModuleInfo>>() {
  78                     @Override
  79                     public ImmutableSet<YangModuleInfo> load(final ClassLoader key) {
  80                         return loadModuleInfos(key);
  81                     }
  82                 });
  83
  84     private BindingReflections() {
  85         // Hidden on purpose
  86     }
  87
  88     /**
  89      * Find augmentation target class from concrete Augmentation class. This method uses first generic argument of
  90      * implemented {@link Augmentation} interface.
  91      *
  92      * @param augmentation
  93      *            {@link Augmentation} subclass for which we want to determine
  94      *            augmentation target.
  95      * @return Augmentation target - class which augmentation provides additional extensions.
  96      */
  97     public static Class<? extends Augmentable<?>> findAugmentationTarget(
  98             final Class<? extends Augmentation<?>> augmentation) {
  99         final Optional<Class<Augmentable<?>>> opt = ClassLoaderUtils.findFirstGenericArgument(augmentation,
 100             Augmentation.class);
 101         return opt.orElse(null);
 102     }
 103
 104     /**
 105      * Find data hierarchy parent from concrete Data class. This method uses first generic argument of implemented
 106      * {@link ChildOf} interface.
 107      *
 108      * @param childClass
 109      *            child class for which we want to find the parent class.
 110      * @return Parent class, e.g. class of which the childClass is ChildOf.
 111      */
 112     public static Class<?> findHierarchicalParent(final Class<? extends ChildOf<?>> childClass) {
 113         return ClassLoaderUtils.findFirstGenericArgument(childClass, ChildOf.class).orElse(null);
 114     }
 115
 116     /**
 117      * Find data hierarchy parent from concrete Data class. This method is shorthand which gets DataObject class by
 118      * invoking {@link DataObject#implementedInterface()} and uses {@link #findHierarchicalParent(Class)}.
 119      *
 120      * @param child
 121      *            Child object for which the parent needs to be located.
 122      * @return Parent class, or null if a parent is not found.
 123      */
 124     public static Class<?> findHierarchicalParent(final DataObject child) {
 125         if (child instanceof ChildOf) {
 126             return ClassLoaderUtils.findFirstGenericArgument(child.implementedInterface(), ChildOf.class).orElse(null);
 127         }
 128         return null;
 129     }
 130
 131     /**
 132      * Returns a QName associated to supplied type.
 133      *
 134      * @param dataType Data type class
 135      * @return QName associated to supplied dataType. If dataType is Augmentation method does not return canonical
 136      *         QName, but QName with correct namespace revision, but virtual local name, since augmentations do not
 137      *         have name. May return null if QName is not present.
 138      */
 139     public static QName findQName(final Class<?> dataType) {
 140         return CLASS_TO_QNAME.getUnchecked(dataType).orElse(null);
 141     }
 142
 143     /**
 144      * Checks if method is RPC invocation.
 145      *
 146      * @param possibleMethod
 147      *            Method to check
 148      * @return true if method is RPC invocation, false otherwise.
 149      */
 150     public static boolean isRpcMethod(final Method possibleMethod) {
 151         return possibleMethod != null && RpcService.class.isAssignableFrom(possibleMethod.getDeclaringClass())
 152                 && ListenableFuture.class.isAssignableFrom(possibleMethod.getReturnType())
 153                 // length <= 2: it seemed to be impossible to get correct RpcMethodInvoker because of
 154                 // resolveRpcInputClass() check.While RpcMethodInvoker counts with one argument for
 155                 // non input type and two arguments for input type, resolveRpcInputClass() counting
 156                 // with zero for non input and one for input type
 157                 && possibleMethod.getParameterCount() <= 2;
 158     }
 159
 160     /**
 161      * Extracts Output class for RPC method.
 162      *
 163      * @param targetMethod
 164      *            method to scan
 165      * @return Optional.empty() if result type could not be get, or return type is Void.
 166      */
 167     @SuppressWarnings("rawtypes")
 168     public static Optional<Class<?>> resolveRpcOutputClass(final Method targetMethod) {
 169         checkState(isRpcMethod(targetMethod), "Supplied method is not a RPC invocation method");
 170         Type futureType = targetMethod.getGenericReturnType();
 171         Type rpcResultType = ClassLoaderUtils.getFirstGenericParameter(futureType).orElse(null);
 172         Type rpcResultArgument = ClassLoaderUtils.getFirstGenericParameter(rpcResultType).orElse(null);
 173         if (rpcResultArgument instanceof Class && !Void.class.equals(rpcResultArgument)) {
 174             return Optional.of((Class) rpcResultArgument);
 175         }
 176         return Optional.empty();
 177     }
 178
 179     /**
 180      * Extracts input class for RPC method.
 181      *
 182      * @param targetMethod
 183      *            method to scan
 184      * @return Optional.empty() if RPC has no input, RPC input type otherwise.
 185      */
 186     @SuppressWarnings("rawtypes")
 187     public static Optional<Class<? extends DataContainer>> resolveRpcInputClass(final Method targetMethod) {
 188         for (Class clazz : targetMethod.getParameterTypes()) {
 189             if (DataContainer.class.isAssignableFrom(clazz)) {
 190                 return Optional.of(clazz);
 191             }
 192         }
 193         return Optional.empty();
 194     }
 195
 196     public static @NonNull QName getQName(final Class<? extends BaseIdentity> bindingClass) {
 197         final Optional<QName> qname = CLASS_TO_QNAME.getUnchecked(requireNonNull(bindingClass));
 198         checkState(qname.isPresent(), "Failed to resolve QName of %s", bindingClass);
 199         return qname.get();
 200     }
 201
 202     /**
 203      * Checks if class is child of augmentation.
 204      */
 205     public static boolean isAugmentationChild(final Class<?> clazz) {
 206         // FIXME: Current resolver could be still confused when child node was added by grouping
 207         checkArgument(clazz != null);
 208
 209         @SuppressWarnings({ "rawtypes", "unchecked" })
 210         Class<?> parent = findHierarchicalParent((Class) clazz);
 211         if (parent == null) {
 212             LOG.debug("Did not find a parent for class {}", clazz);
 213             return false;
 214         }
 215
 216         String clazzModelPackage = getModelRootPackageName(clazz.getPackage());
 217         String parentModelPackage = getModelRootPackageName(parent.getPackage());
 218
 219         return !clazzModelPackage.equals(parentModelPackage);
 220     }
 221
 222     /**
 223      * Returns root package name for supplied package.
 224      *
 225      * @param pkg
 226      *            Package for which find model root package.
 227      * @return Package of model root.
 228      */
 229     public static String getModelRootPackageName(final Package pkg) {
 230         return getModelRootPackageName(pkg.getName());
 231     }
 232
 233     /**
 234      * Returns root package name for supplied package name.
 235      *
 236      * @param name
 237      *            Package for which find model root package.
 238      * @return Package of model root.
 239      */
 240     public static String getModelRootPackageName(final String name) {
 241         checkArgument(name != null, "Package name should not be null.");
 242         checkArgument(name.startsWith(BindingMapping.PACKAGE_PREFIX), "Package name not starting with %s, is: %s",
 243                 BindingMapping.PACKAGE_PREFIX, name);
 244         Matcher match = ROOT_PACKAGE_PATTERN.matcher(name);
 245         checkArgument(match.find(), "Package name '%s' does not match required pattern '%s'", name,
 246                 ROOT_PACKAGE_PATTERN_STRING);
 247         return match.group(0);
 248     }
 249
 250     @SuppressWarnings("checkstyle:illegalCatch")
 251     public static QNameModule getQNameModule(final Class<?> clz) {
 252         if (DataContainer.class.isAssignableFrom(clz) || BaseIdentity.class.isAssignableFrom(clz)
 253                 || Action.class.isAssignableFrom(clz)) {
 254             return findQName(clz).getModule();
 255         }
 256         try {
 257             return getModuleInfo(clz).getName().getModule();
 258         } catch (Exception e) {
 259             throw new IllegalStateException("Unable to get QName of defining model.", e);
 260         }
 261     }
 262
 263     /**
 264      * Returns instance of {@link YangModuleInfo} of declaring model for specific class.
 265      *
 266      * @param cls data object class
 267      * @return Instance of {@link YangModuleInfo} associated with model, from
 268      *         which this class was derived.
 269      */
 270     // FIXME: 8.0.0: do not throw Exception here
 271     public static @NonNull YangModuleInfo getModuleInfo(final Class<?> cls) throws Exception {
 272         checkArgument(cls != null);
 273         String packageName = getModelRootPackageName(cls.getPackage());
 274         final String potentialClassName = getModuleInfoClassName(packageName);
 275         return ClassLoaderUtils.callWithClassLoader(cls.getClassLoader(), () -> {
 276             Class<?> moduleInfoClass = Thread.currentThread().getContextClassLoader().loadClass(potentialClassName);
 277             return (YangModuleInfo) verifyNotNull(moduleInfoClass.getMethod("getInstance").invoke(null));
 278         });
 279     }
 280
 281     public static @NonNull String getModuleInfoClassName(final String packageName) {
 282         return packageName + "." + BindingMapping.MODULE_INFO_CLASS_NAME;
 283     }
 284
 285     /**
 286      * Check if supplied class is derived from YANG model.
 287      *
 288      * @param cls
 289      *            Class to check
 290      * @return true if class is derived from YANG model.
 291      */
 292     public static boolean isBindingClass(final Class<?> cls) {
 293         if (DataContainer.class.isAssignableFrom(cls) || Augmentation.class.isAssignableFrom(cls)) {
 294             return true;
 295         }
 296         return cls.getName().startsWith(BindingMapping.PACKAGE_PREFIX);
 297     }
 298
 299     /**
 300      * Checks if supplied method is callback for notifications.
 301      *
 302      * @param method method to check
 303      * @return true if method is notification callback.
 304      */
 305     public static boolean isNotificationCallback(final Method method) {
 306         checkArgument(method != null);
 307         if (method.getName().startsWith("on") && method.getParameterCount() == 1) {
 308             Class<?> potentialNotification = method.getParameterTypes()[0];
 309             if (isNotification(potentialNotification)
 310                     && method.getName().equals("on" + potentialNotification.getSimpleName())) {
 311                 return true;
 312             }
 313         }
 314         return false;
 315     }
 316
 317     /**
 318      * Checks is supplied class is a {@link Notification}.
 319      *
 320      * @param potentialNotification class to examine
 321      * @return True if the class represents a Notification.
 322      */
 323     public static boolean isNotification(final Class<?> potentialNotification) {
 324         checkArgument(potentialNotification != null, "potentialNotification must not be null.");
 325         return Notification.class.isAssignableFrom(potentialNotification);
 326     }
 327
 328     /**
 329      * Loads {@link YangModuleInfo} infos available on current classloader. This method is shorthand for
 330      * {@link #loadModuleInfos(ClassLoader)} with {@link Thread#getContextClassLoader()} for current thread.
 331      *
 332      * @return Set of {@link YangModuleInfo} available for current classloader.
 333      */
 334     public static @NonNull ImmutableSet<YangModuleInfo> loadModuleInfos() {
 335         return loadModuleInfos(Thread.currentThread().getContextClassLoader());
 336     }
 337
 338     /**
 339      * Loads {@link YangModuleInfo} infos available on supplied classloader.
 340      *
 341      * <p>
 342      * {@link YangModuleInfo} are discovered using {@link ServiceLoader} for {@link YangModelBindingProvider}.
 343      * {@link YangModelBindingProvider} are simple classes which holds only pointers to actual instance
 344      * {@link YangModuleInfo}.
 345      *
 346      * <p>
 347      * When {@link YangModuleInfo} is available, all dependencies are recursively collected into returning set by
 348      * collecting results of {@link YangModuleInfo#getImportedModules()}.
 349      *
 350      * <p>
 351      * Consider using {@link #cacheModuleInfos(ClassLoader)} if the classloader is known to be immutable.
 352      *
 353      * @param loader Classloader for which {@link YangModuleInfo} should be retrieved.
 354      * @return Set of {@link YangModuleInfo} available for supplied classloader.
 355      */
 356     public static @NonNull ImmutableSet<YangModuleInfo> loadModuleInfos(final ClassLoader loader) {
 357         Builder<YangModuleInfo> moduleInfoSet = ImmutableSet.builder();
 358         ServiceLoader<YangModelBindingProvider> serviceLoader = ServiceLoader.load(YangModelBindingProvider.class,
 359                 loader);
 360         for (YangModelBindingProvider bindingProvider : serviceLoader) {
 361             YangModuleInfo moduleInfo = bindingProvider.getModuleInfo();
 362             checkState(moduleInfo != null, "Module Info for %s is not available.", bindingProvider.getClass());
 363             collectYangModuleInfo(bindingProvider.getModuleInfo(), moduleInfoSet);
 364         }
 365         return moduleInfoSet.build();
 366     }
 367
 368     /**
 369      * Loads {@link YangModuleInfo} instances available on supplied {@link ClassLoader}, assuming the set of available
 370      * information does not change. Subsequent accesses may return cached values.
 371      *
 372      * <p>
 373      * {@link YangModuleInfo} are discovered using {@link ServiceLoader} for {@link YangModelBindingProvider}.
 374      * {@link YangModelBindingProvider} are simple classes which holds only pointers to actual instance
 375      * {@link YangModuleInfo}.
 376      *
 377      * <p>
 378      * When {@link YangModuleInfo} is available, all dependencies are recursively collected into returning set by
 379      * collecting results of {@link YangModuleInfo#getImportedModules()}.
 380      *
 381      * @param loader Class loader for which {@link YangModuleInfo} should be retrieved.
 382      * @return Set of {@link YangModuleInfo} available for supplied classloader.
 383      */
 384     @Beta
 385     public static @NonNull ImmutableSet<YangModuleInfo> cacheModuleInfos(final ClassLoader loader) {
 386         return MODULE_INFO_CACHE.getUnchecked(loader);
 387     }
 388
 389     private static void collectYangModuleInfo(final YangModuleInfo moduleInfo,
 390             final Builder<YangModuleInfo> moduleInfoSet) {
 391         moduleInfoSet.add(moduleInfo);
 392         for (YangModuleInfo dependency : moduleInfo.getImportedModules()) {
 393             collectYangModuleInfo(dependency, moduleInfoSet);
 394         }
 395     }
 396
 397     /**
 398      * Checks if supplied class represents RPC Input / RPC Output.
 399      *
 400      * @param targetType
 401      *            Class to be checked
 402      * @return true if class represents RPC Input or RPC Output class.
 403      */
 404     public static boolean isRpcType(final Class<? extends DataObject> targetType) {
 405         return DataContainer.class.isAssignableFrom(targetType)
 406                 && !ChildOf.class.isAssignableFrom(targetType)
 407                 && !Notification.class.isAssignableFrom(targetType)
 408                 && (targetType.getName().endsWith("Input") || targetType.getName().endsWith("Output"));
 409     }
 410
 411     /**
 412      * Scans supplied class and returns an iterable of all data children classes.
 413      *
 414      * @param type
 415      *            YANG Modeled Entity derived from DataContainer
 416      * @return Iterable of all data children, which have YANG modeled entity
 417      */
 418     @SuppressWarnings("unchecked")
 419     public static Iterable<Class<? extends DataObject>> getChildrenClasses(final Class<? extends DataContainer> type) {
 420         checkArgument(type != null, "Target type must not be null");
 421         checkArgument(DataContainer.class.isAssignableFrom(type), "Supplied type must be derived from DataContainer");
 422         List<Class<? extends DataObject>> ret = new LinkedList<>();
 423         for (Method method : type.getMethods()) {
 424             Optional<Class<? extends DataContainer>> entity = getYangModeledReturnType(method,
 425                 BindingMapping.GETTER_PREFIX);
 426             if (entity.isPresent()) {
 427                 ret.add((Class<? extends DataObject>) entity.get());
 428             }
 429         }
 430         return ret;
 431     }
 432
 433     /**
 434      * Scans supplied class and returns an iterable of all data children classes.
 435      *
 436      * @param type
 437      *            YANG Modeled Entity derived from DataContainer
 438      * @return Iterable of all data children, which have YANG modeled entity
 439      */
 440     public static Map<Class<?>, Method> getChildrenClassToMethod(final Class<?> type) {
 441         return getChildrenClassToMethod(type, BindingMapping.GETTER_PREFIX);
 442     }
 443
 444     private static Map<Class<?>, Method> getChildrenClassToMethod(final Class<?> type, final String prefix) {
 445         checkArgument(type != null, "Target type must not be null");
 446         checkArgument(DataContainer.class.isAssignableFrom(type), "Supplied type %s must be derived from DataContainer",
 447             type);
 448         Map<Class<?>, Method> ret = new HashMap<>();
 449         for (Method method : type.getMethods()) {
 450             Optional<Class<? extends DataContainer>> entity = getYangModeledReturnType(method, prefix);
 451             if (entity.isPresent()) {
 452                 ret.put(entity.get(), method);
 453             }
 454         }
 455         return ret;
 456     }
 457
 458     @Beta
 459     public static Map<Class<?>, Method> getChildrenClassToNonnullMethod(final Class<?> type) {
 460         return getChildrenClassToMethod(type, BindingMapping.NONNULL_PREFIX);
 461     }
 462
 463     private static Optional<Class<? extends DataContainer>> getYangModeledReturnType(final Method method,
 464             final String prefix) {
 465         final String methodName = method.getName();
 466         if ("getClass".equals(methodName) || !methodName.startsWith(prefix) || method.getParameterCount() > 0) {
 467             return Optional.empty();
 468         }
 469
 470         final Class<?> returnType = method.getReturnType();
 471         if (DataContainer.class.isAssignableFrom(returnType)) {
 472             return optionalDataContainer(returnType);
 473         } else if (List.class.isAssignableFrom(returnType)) {
 474             return getYangModeledReturnType(method, 0);
 475         } else if (Map.class.isAssignableFrom(returnType)) {
 476             return getYangModeledReturnType(method, 1);
 477         }
 478         return Optional.empty();
 479     }
 480
 481     @SuppressWarnings("checkstyle:illegalCatch")
 482     private static Optional<Class<? extends DataContainer>> getYangModeledReturnType(final Method method,
 483             final int parameterOffset) {
 484         try {
 485             return ClassLoaderUtils.callWithClassLoader(method.getDeclaringClass().getClassLoader(), () -> {
 486                 return genericParameter(method.getGenericReturnType(), parameterOffset).flatMap(
 487                     result -> result instanceof Class ? optionalCast((Class<?>) result) : Optional.empty());
 488             });
 489         } catch (Exception e) {
 490             /*
 491              * It is safe to log this this exception on debug, since this
 492              * method should not fail. Only failures are possible if the
 493              * runtime / backing.
 494              */
 495             LOG.debug("Unable to find YANG modeled return type for {}", method, e);
 496         }
 497         return Optional.empty();
 498     }
 499
 500     private static Optional<Class<? extends DataContainer>> optionalCast(final Class<?> type) {
 501         return DataContainer.class.isAssignableFrom(type) ? optionalDataContainer(type) : Optional.empty();
 502     }
 503
 504     private static Optional<Class<? extends DataContainer>> optionalDataContainer(final Class<?> type) {
 505         return Optional.of(type.asSubclass(DataContainer.class));
 506     }
 507
 508     private static Optional<Type> genericParameter(final Type type, final int offset) {
 509         if (type instanceof ParameterizedType) {
 510             final Type[] parameters = ((ParameterizedType) type).getActualTypeArguments();
 511             if (parameters.length > offset) {
 512                 return Optional.of(parameters[offset]);
 513             }
 514         }
 515         return Optional.empty();
 516     }
 517
 518     private static class ClassToQNameLoader extends CacheLoader<Class<?>, Optional<QName>> {
 519
 520         @Override
 521         public Optional<QName> load(@SuppressWarnings("NullableProblems") final Class<?> key) throws Exception {
 522             return resolveQNameNoCache(key);
 523         }
 524
 525         /**
 526          * Tries to resolve QName for supplied class. Looks up for static field with name from constant
 527          * {@link BindingMapping#QNAME_STATIC_FIELD_NAME} and returns value if present. If field is not present uses
 528          * {@link #computeQName(Class)} to compute QName for missing types.
 529          */
 530         private static Optional<QName> resolveQNameNoCache(final Class<?> key) {
 531             try {
 532                 final Field field;
 533                 try {
 534                     field = key.getField(BindingMapping.QNAME_STATIC_FIELD_NAME);
 535                 } catch (NoSuchFieldException e) {
 536                     LOG.debug("{} does not have a {} field, falling back to computation", key,
 537                         BindingMapping.QNAME_STATIC_FIELD_NAME, e);
 538                     return Optional.of(computeQName(key));
 539                 }
 540
 541                 final Object obj = field.get(null);
 542                 if (obj instanceof QName) {
 543                     return Optional.of((QName) obj);
 544                 }
 545             } catch (SecurityException | IllegalArgumentException | IllegalAccessException e) {
 546                 /*
 547                  * It is safe to log this this exception on debug, since this method should not fail. Only failures are
 548                  * possible if the runtime / backing is inconsistent.
 549                  */
 550                 LOG.debug("Unexpected exception during extracting QName for {}", key, e);
 551             }
 552             return Optional.empty();
 553         }
 554
 555         /**
 556          * Computes QName for supplied class. Namespace and revision are same as {@link YangModuleInfo} associated with
 557          * supplied class.
 558          *
 559          * <p>
 560          * If class is
 561          * <ul>
 562          * <li>rpc input: local name is "input".
 563          * <li>rpc output: local name is "output".
 564          * <li>augmentation: local name is "module name".
 565          * </ul>
 566          *
 567          * <p>
 568          * There is also fallback, if it is not possible to compute QName using following algorithm returns module
 569          * QName.
 570          *
 571          * @throws IllegalStateException If YangModuleInfo could not be resolved
 572          * @throws IllegalArgumentException If supplied class was not derived from YANG model.
 573          */
 574         // FIXME: Extend this algorithm to also provide QName for YANG modeled simple types.
 575         @SuppressWarnings({ "rawtypes", "unchecked", "checkstyle:illegalCatch" })
 576         private static QName computeQName(final Class key) {
 577             checkArgument(isBindingClass(key), "Supplied class %s is not derived from YANG.", key);
 578
 579             YangModuleInfo moduleInfo;
 580             try {
 581                 moduleInfo = getModuleInfo(key);
 582             } catch (Exception e) {
 583                 throw new IllegalStateException("Unable to get QName for " + key + ". YangModuleInfo was not found.",
 584                     e);
 585             }
 586             final QName module = moduleInfo.getName();
 587             if (Augmentation.class.isAssignableFrom(key)) {
 588                 return module;
 589             } else if (isRpcType(key)) {
 590                 final String className = key.getSimpleName();
 591                 if (className.endsWith(BindingMapping.RPC_OUTPUT_SUFFIX)) {
 592                     return YangConstants.operationOutputQName(module.getModule()).intern();
 593                 }
 594
 595                 return YangConstants.operationInputQName(module.getModule()).intern();
 596             }
 597
 598             /*
 599              * Fallback for Binding types which do not have QNAME field
 600              */
 601             return module;
 602         }
 603     }
 604
 605     /**
 606      * Extracts augmentation from Binding DTO field using reflection.
 607      *
 608      * @param input Instance of DataObject which is augmentable and may contain augmentation
 609      * @return Map of augmentations if read was successful, otherwise empty map.
 610      * @deprecated Use {@link Augmentable#augmentations()} instead.
 611      */
 612     @SuppressWarnings("unchecked")
 613     @Deprecated(forRemoval = true)
 614     public static Map<Class<? extends Augmentation<?>>, Augmentation<?>> getAugmentations(final Augmentable<?> input) {
 615         return (Map) input.augmentations();
 616     }
 617
 618     /**
 619      * Determines if two augmentation classes or case classes represents same
 620      * data.
 621      *
 622      * <p>
 623      * Two augmentations or cases could be substituted only if and if:
 624      * <ul>
 625      * <li>Both implements same interfaces</li>
 626      * <li>Both have same children</li>
 627      * <li>If augmentations: Both have same augmentation target class. Target
 628      * class was generated for data node in grouping.</li>
 629      * <li>If cases: Both are from same choice. Choice class was generated for
 630      * data node in grouping.</li>
 631      * </ul>
 632      *
 633      * <p>
 634      * <b>Explanation:</b> Binding Specification reuses classes generated for
 635      * groupings as part of normal data tree, this classes from grouping could
 636      * be used at various locations and user may not be aware of it and may use
 637      * incorrect case or augmentation in particular subtree (via copy
 638      * constructors, etc).
 639      *
 640      * @param potential
 641      *            Class which is potential substitution
 642      * @param target
 643      *            Class which should be used at particular subtree
 644      * @return true if and only if classes represents same data.
 645      */
 646     @SuppressWarnings({ "rawtypes", "unchecked" })
 647     public static boolean isSubstitutionFor(final Class potential, final Class target) {
 648         Set<Class> subImplemented = new HashSet<>(Arrays.asList(potential.getInterfaces()));
 649         Set<Class> targetImplemented = new HashSet<>(Arrays.asList(target.getInterfaces()));
 650         if (!subImplemented.equals(targetImplemented)) {
 651             return false;
 652         }
 653         if (Augmentation.class.isAssignableFrom(potential)
 654                 && !BindingReflections.findAugmentationTarget(potential).equals(
 655                         BindingReflections.findAugmentationTarget(target))) {
 656             return false;
 657         }
 658         for (Method potentialMethod : potential.getMethods()) {
 659             if (Modifier.isStatic(potentialMethod.getModifiers())) {
 660                 // Skip any static methods, as we are not interested in those
 661                 continue;
 662             }
 663
 664             try {
 665                 Method targetMethod = target.getMethod(potentialMethod.getName(), potentialMethod.getParameterTypes());
 666                 if (!potentialMethod.getReturnType().equals(targetMethod.getReturnType())) {
 667                     return false;
 668                 }
 669             } catch (NoSuchMethodException e) {
 670                 // Counterpart method is missing, so classes could not be substituted.
 671                 return false;
 672             } catch (SecurityException e) {
 673                 throw new IllegalStateException("Could not compare methods", e);
 674             }
 675         }
 676         return true;
 677     }
 678 }