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