X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=binding%2Fmdsal-binding-spec-util%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fmdsal%2Fbinding%2Fspec%2Freflect%2FBindingReflections.java;h=623385d8658c51906a30874e5fce2b83b639e9d2;hb=5bc3681743c768aa4cb74b0c58b525779ba7963c;hp=764d5a1b1e77060267c02afc3918b4fb26b85b1e;hpb=c241dcfa5322ac10810a1068ccd2eb57f6f2dbb2;p=mdsal.git diff --git a/binding/mdsal-binding-spec-util/src/main/java/org/opendaylight/mdsal/binding/spec/reflect/BindingReflections.java b/binding/mdsal-binding-spec-util/src/main/java/org/opendaylight/mdsal/binding/spec/reflect/BindingReflections.java index 764d5a1b1e..623385d865 100644 --- a/binding/mdsal-binding-spec-util/src/main/java/org/opendaylight/mdsal/binding/spec/reflect/BindingReflections.java +++ b/binding/mdsal-binding-spec-util/src/main/java/org/opendaylight/mdsal/binding/spec/reflect/BindingReflections.java @@ -10,40 +10,24 @@ package org.opendaylight.mdsal.binding.spec.reflect; import static com.google.common.base.Preconditions.checkArgument; import static com.google.common.base.Preconditions.checkState; +import com.google.common.annotations.VisibleForTesting; import com.google.common.cache.CacheBuilder; import com.google.common.cache.CacheLoader; import com.google.common.cache.LoadingCache; -import com.google.common.collect.ImmutableSet; -import com.google.common.collect.ImmutableSet.Builder; -import com.google.common.collect.Sets; -import com.google.common.util.concurrent.ListenableFuture; import java.lang.reflect.Field; -import java.lang.reflect.Method; -import java.lang.reflect.Type; -import java.util.HashMap; -import java.util.HashSet; -import java.util.LinkedList; -import java.util.List; -import java.util.Map; +import java.lang.reflect.InvocationTargetException; import java.util.Optional; -import java.util.ServiceLoader; import java.util.concurrent.TimeUnit; -import java.util.regex.Matcher; -import java.util.regex.Pattern; -import javax.annotation.RegEx; -import org.opendaylight.mdsal.binding.spec.naming.BindingMapping; -import org.opendaylight.yangtools.util.ClassLoaderUtils; +import org.eclipse.jdt.annotation.NonNull; import org.opendaylight.yangtools.yang.binding.Action; -import org.opendaylight.yangtools.yang.binding.Augmentable; import org.opendaylight.yangtools.yang.binding.Augmentation; import org.opendaylight.yangtools.yang.binding.BaseIdentity; import org.opendaylight.yangtools.yang.binding.ChildOf; import org.opendaylight.yangtools.yang.binding.DataContainer; import org.opendaylight.yangtools.yang.binding.DataObject; import org.opendaylight.yangtools.yang.binding.Notification; -import org.opendaylight.yangtools.yang.binding.RpcService; -import org.opendaylight.yangtools.yang.binding.YangModelBindingProvider; import org.opendaylight.yangtools.yang.binding.YangModuleInfo; +import org.opendaylight.yangtools.yang.binding.contract.Naming; import org.opendaylight.yangtools.yang.common.QName; import org.opendaylight.yangtools.yang.common.QNameModule; import org.opendaylight.yangtools.yang.common.YangConstants; @@ -51,63 +35,14 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; public final class BindingReflections { - - private static final long EXPIRATION_TIME = 60; - - @RegEx - private static final String ROOT_PACKAGE_PATTERN_STRING = - "(org.opendaylight.yang.gen.v1.[a-z0-9_\\.]*\\.(?:rev[0-9][0-9][0-1][0-9][0-3][0-9]|norev))"; - private static final Pattern ROOT_PACKAGE_PATTERN = Pattern.compile(ROOT_PACKAGE_PATTERN_STRING); private static final Logger LOG = LoggerFactory.getLogger(BindingReflections.class); - private static final LoadingCache, Optional> CLASS_TO_QNAME = CacheBuilder.newBuilder() .weakKeys() - .expireAfterAccess(EXPIRATION_TIME, TimeUnit.SECONDS) + .expireAfterAccess(60, TimeUnit.SECONDS) .build(new ClassToQNameLoader()); private BindingReflections() { - throw new UnsupportedOperationException("Utility class."); - } - - /** - * Find augmentation target class from concrete Augmentation class. This method uses first generic argument of - * implemented {@link Augmentation} interface. - * - * @param augmentation - * {@link Augmentation} subclass for which we want to determine - * augmentation target. - * @return Augmentation target - class which augmentation provides additional extensions. - */ - public static Class> findAugmentationTarget( - final Class> augmentation) { - return ClassLoaderUtils.findFirstGenericArgument(augmentation, Augmentation.class); - } - - /** - * Find data hierarchy parent from concrete Data class. This method uses first generic argument of implemented - * {@link ChildOf} interface. - * - * @param childClass - * child class for which we want to find the parent class. - * @return Parent class, e.g. class of which the childClass is ChildOf. - */ - public static Class findHierarchicalParent(final Class> childClass) { - return ClassLoaderUtils.findFirstGenericArgument(childClass, ChildOf.class); - } - - /** - * Find data hierarchy parent from concrete Data class. This method is shorthand which gets DataObject class by - * invoking {@link DataObject#getImplementedInterface()} and uses {@link #findHierarchicalParent(Class)}. - * - * @param child - * Child object for which the parent needs to be located. - * @return Parent class, or null if a parent is not found. - */ - public static Class findHierarchicalParent(final DataObject child) { - if (child instanceof ChildOf) { - return ClassLoaderUtils.findFirstGenericArgument(child.getImplementedInterface(), ChildOf.class); - } - return null; + // Hidden on purpose } /** @@ -122,143 +57,45 @@ public final class BindingReflections { return CLASS_TO_QNAME.getUnchecked(dataType).orElse(null); } - /** - * Checks if method is RPC invocation. - * - * @param possibleMethod - * Method to check - * @return true if method is RPC invocation, false otherwise. - */ - public static boolean isRpcMethod(final Method possibleMethod) { - return possibleMethod != null && RpcService.class.isAssignableFrom(possibleMethod.getDeclaringClass()) - && ListenableFuture.class.isAssignableFrom(possibleMethod.getReturnType()) - // length <= 2: it seemed to be impossible to get correct RpcMethodInvoker because of - // resolveRpcInputClass() check.While RpcMethodInvoker counts with one argument for - // non input type and two arguments for input type, resolveRpcInputClass() counting - // with zero for non input and one for input type - && possibleMethod.getParameterTypes().length <= 2; - } - - /** - * Extracts Output class for RPC method. - * - * @param targetMethod - * method to scan - * @return Optional.empty() if result type could not be get, or return type is Void. - */ - @SuppressWarnings("rawtypes") - public static Optional> resolveRpcOutputClass(final Method targetMethod) { - checkState(isRpcMethod(targetMethod), "Supplied method is not a RPC invocation method"); - Type futureType = targetMethod.getGenericReturnType(); - Type rpcResultType = ClassLoaderUtils.getFirstGenericParameter(futureType); - Type rpcResultArgument = ClassLoaderUtils.getFirstGenericParameter(rpcResultType); - if (rpcResultArgument instanceof Class && !Void.class.equals(rpcResultArgument)) { - return Optional.of((Class) rpcResultArgument); - } - return Optional.empty(); - } - - /** - * Extracts input class for RPC method. - * - * @param targetMethod - * method to scan - * @return Optional.empty() if RPC has no input, RPC input type otherwise. - */ - @SuppressWarnings("rawtypes") - public static Optional> resolveRpcInputClass(final Method targetMethod) { - for (Class clazz : targetMethod.getParameterTypes()) { - if (DataContainer.class.isAssignableFrom(clazz)) { - return Optional.of(clazz); - } - } - return Optional.empty(); + public static @NonNull QName getQName(final BaseIdentity identity) { + return CLASS_TO_QNAME.getUnchecked(identity.implementedInterface()) + .orElseThrow(() -> new IllegalStateException("Failed to resolve QName of " + identity)); } - public static QName getQName(final Class context) { - return findQName(context); - } - - /** - * Checks if class is child of augmentation. - */ - public static boolean isAugmentationChild(final Class clazz) { - // FIXME: Current resolver could be still confused when child node was added by grouping - checkArgument(clazz != null); - - @SuppressWarnings({ "rawtypes", "unchecked" }) - Class parent = findHierarchicalParent((Class) clazz); - if (parent == null) { - LOG.debug("Did not find a parent for class {}", clazz); - return false; - } - - String clazzModelPackage = getModelRootPackageName(clazz.getPackage()); - String parentModelPackage = getModelRootPackageName(parent.getPackage()); - - return !clazzModelPackage.equals(parentModelPackage); - } - - /** - * Returns root package name for suplied package. - * - * @param pkg - * Package for which find model root package. - * @return Package of model root. - */ - public static String getModelRootPackageName(final Package pkg) { - return getModelRootPackageName(pkg.getName()); - } - - /** - * Returns root package name for supplied package name. - * - * @param name - * Package for which find model root package. - * @return Package of model root. - */ - public static String getModelRootPackageName(final String name) { - checkArgument(name != null, "Package name should not be null."); - checkArgument(name.startsWith(BindingMapping.PACKAGE_PREFIX), "Package name not starting with %s, is: %s", - BindingMapping.PACKAGE_PREFIX, name); - Matcher match = ROOT_PACKAGE_PATTERN.matcher(name); - checkArgument(match.find(), "Package name '%s' does not match required pattern '%s'", name, - ROOT_PACKAGE_PATTERN_STRING); - return match.group(0); - } - - @SuppressWarnings("checkstyle:illegalCatch") public static QNameModule getQNameModule(final Class clz) { if (DataContainer.class.isAssignableFrom(clz) || BaseIdentity.class.isAssignableFrom(clz) || Action.class.isAssignableFrom(clz)) { return findQName(clz).getModule(); } - try { - return BindingReflections.getModuleInfo(clz).getName().getModule(); - } catch (Exception e) { - throw new IllegalStateException("Unable to get QName of defining model.", e); - } + + return getModuleInfo(clz).getName().getModule(); } /** * Returns instance of {@link YangModuleInfo} of declaring model for specific class. * * @param cls data object class - * @return Instance of {@link YangModuleInfo} associated with model, from - * which this class was derived. + * @return Instance of {@link YangModuleInfo} associated with model, from which this class was derived. */ - public static YangModuleInfo getModuleInfo(final Class cls) throws Exception { - checkArgument(cls != null); - String packageName = getModelRootPackageName(cls.getPackage()); - final String potentialClassName = getModuleInfoClassName(packageName); - return ClassLoaderUtils.callWithClassLoader(cls.getClassLoader(), () -> { - Class moduleInfoClass = Thread.currentThread().getContextClassLoader().loadClass(potentialClassName); - return (YangModuleInfo) moduleInfoClass.getMethod("getInstance").invoke(null); - }); - } + private static @NonNull YangModuleInfo getModuleInfo(final Class cls) { + final String potentialClassName = Naming.getModelRootPackageName(cls.getPackage().getName()) + "." + + Naming.MODULE_INFO_CLASS_NAME; + final Class moduleInfoClass; + try { + moduleInfoClass = cls.getClassLoader().loadClass(potentialClassName); + } catch (ClassNotFoundException e) { + throw new IllegalStateException("Failed to load " + potentialClassName, e); + } + + final Object infoInstance; + try { + infoInstance = moduleInfoClass.getMethod("getInstance").invoke(null); + } catch (IllegalAccessException | InvocationTargetException | NoSuchMethodException e) { + throw new IllegalStateException("Failed to get instance of " + moduleInfoClass, e); + } - public static String getModuleInfoClassName(final String packageName) { - return packageName + "." + BindingMapping.MODULE_INFO_CLASS_NAME; + checkState(infoInstance instanceof YangModuleInfo, "Unexpected instance %s", infoInstance); + return (YangModuleInfo) infoInstance; } /** @@ -272,83 +109,7 @@ public final class BindingReflections { if (DataContainer.class.isAssignableFrom(cls) || Augmentation.class.isAssignableFrom(cls)) { return true; } - return cls.getName().startsWith(BindingMapping.PACKAGE_PREFIX); - } - - /** - * Checks if supplied method is callback for notifications. - * - * @param method method to check - * @return true if method is notification callback. - */ - public static boolean isNotificationCallback(final Method method) { - checkArgument(method != null); - if (method.getName().startsWith("on") && method.getParameterTypes().length == 1) { - Class potentialNotification = method.getParameterTypes()[0]; - if (isNotification(potentialNotification) - && method.getName().equals("on" + potentialNotification.getSimpleName())) { - return true; - } - } - return false; - } - - /** - * Checks is supplied class is a {@link Notification}. - * - * @param potentialNotification class to examine - * @return True if the class represents a Notification. - */ - public static boolean isNotification(final Class potentialNotification) { - checkArgument(potentialNotification != null, "potentialNotification must not be null."); - return Notification.class.isAssignableFrom(potentialNotification); - } - - /** - * Loads {@link YangModuleInfo} infos available on current classloader. This method is shorthand for - * {@link #loadModuleInfos(ClassLoader)} with {@link Thread#getContextClassLoader()} for current thread. - * - * @return Set of {@link YangModuleInfo} available for current classloader. - */ - public static ImmutableSet loadModuleInfos() { - return loadModuleInfos(Thread.currentThread().getContextClassLoader()); - } - - /** - * Loads {@link YangModuleInfo} infos available on supplied classloader. - * - *

- * {@link YangModuleInfo} are discovered using {@link ServiceLoader} for {@link YangModelBindingProvider}. - * {@link YangModelBindingProvider} are simple classes which holds only pointers to actual instance - * {@link YangModuleInfo}. - * - *

- * When {@link YangModuleInfo} is available, all dependencies are recursively collected into returning set by - * collecting results of {@link YangModuleInfo#getImportedModules()}. - * - * @param loader - * Classloader for which {@link YangModuleInfo} should be - * retrieved. - * @return Set of {@link YangModuleInfo} available for supplied classloader. - */ - public static ImmutableSet loadModuleInfos(final ClassLoader loader) { - Builder moduleInfoSet = ImmutableSet.builder(); - ServiceLoader serviceLoader = ServiceLoader.load(YangModelBindingProvider.class, - loader); - for (YangModelBindingProvider bindingProvider : serviceLoader) { - YangModuleInfo moduleInfo = bindingProvider.getModuleInfo(); - checkState(moduleInfo != null, "Module Info for %s is not available.", bindingProvider.getClass()); - collectYangModuleInfo(bindingProvider.getModuleInfo(), moduleInfoSet); - } - return moduleInfoSet.build(); - } - - private static void collectYangModuleInfo(final YangModuleInfo moduleInfo, - final Builder moduleInfoSet) { - moduleInfoSet.add(moduleInfo); - for (YangModuleInfo dependency : moduleInfo.getImportedModules()) { - collectYangModuleInfo(dependency, moduleInfoSet); - } + return cls.getName().startsWith(Naming.PACKAGE_PREFIX); } /** @@ -358,88 +119,15 @@ public final class BindingReflections { * Class to be checked * @return true if class represents RPC Input or RPC Output class. */ - public static boolean isRpcType(final Class targetType) { + @VisibleForTesting + static boolean isRpcType(final Class targetType) { return DataContainer.class.isAssignableFrom(targetType) && !ChildOf.class.isAssignableFrom(targetType) && !Notification.class.isAssignableFrom(targetType) && (targetType.getName().endsWith("Input") || targetType.getName().endsWith("Output")); } - /** - * Scans supplied class and returns an iterable of all data children classes. - * - * @param type - * YANG Modeled Entity derived from DataContainer - * @return Iterable of all data children, which have YANG modeled entity - */ - @SuppressWarnings("unchecked") - public static Iterable> getChildrenClasses(final Class type) { - checkArgument(type != null, "Target type must not be null"); - checkArgument(DataContainer.class.isAssignableFrom(type), "Supplied type must be derived from DataContainer"); - List> ret = new LinkedList<>(); - for (Method method : type.getMethods()) { - Optional> entity = getYangModeledReturnType(method); - if (entity.isPresent()) { - ret.add((Class) entity.get()); - } - } - return ret; - } - - /** - * Scans supplied class and returns an iterable of all data children classes. - * - * @param type - * YANG Modeled Entity derived from DataContainer - * @return Iterable of all data children, which have YANG modeled entity - */ - public static Map, Method> getChildrenClassToMethod(final Class type) { - checkArgument(type != null, "Target type must not be null"); - checkArgument(DataContainer.class.isAssignableFrom(type), "Supplied type %s must be derived from DataContainer", - type); - Map, Method> ret = new HashMap<>(); - for (Method method : type.getMethods()) { - Optional> entity = getYangModeledReturnType(method); - if (entity.isPresent()) { - ret.put(entity.get(), method); - } - } - return ret; - } - - @SuppressWarnings({ "unchecked", "rawtypes", "checkstyle:illegalCatch" }) - private static Optional> getYangModeledReturnType(final Method method) { - if ("getClass".equals(method.getName()) || !method.getName().startsWith("get") - || method.getParameterTypes().length > 0) { - return Optional.empty(); - } - - Class returnType = method.getReturnType(); - if (DataContainer.class.isAssignableFrom(returnType)) { - return Optional.of(returnType); - } else if (List.class.isAssignableFrom(returnType)) { - try { - return ClassLoaderUtils.callWithClassLoader(method.getDeclaringClass().getClassLoader(), () -> { - Type listResult = ClassLoaderUtils.getFirstGenericParameter(method.getGenericReturnType()); - if (listResult instanceof Class - && DataContainer.class.isAssignableFrom((Class) listResult)) { - return Optional.of((Class) listResult); - } - return Optional.empty(); - }); - } catch (Exception e) { - /* - * It is safe to log this this exception on debug, since this - * method should not fail. Only failures are possible if the - * runtime / backing. - */ - LOG.debug("Unable to find YANG modeled return type for {}", method, e); - } - } - return Optional.empty(); - } - - private static class ClassToQNameLoader extends CacheLoader, Optional> { + private static final class ClassToQNameLoader extends CacheLoader, Optional> { @Override public Optional load(@SuppressWarnings("NullableProblems") final Class key) throws Exception { @@ -448,23 +136,23 @@ public final class BindingReflections { /** * Tries to resolve QName for supplied class. Looks up for static field with name from constant - * {@link BindingMapping#QNAME_STATIC_FIELD_NAME} and returns value if present. If field is not present uses + * {@link Naming#QNAME_STATIC_FIELD_NAME} and returns value if present. If field is not present uses * {@link #computeQName(Class)} to compute QName for missing types. */ private static Optional resolveQNameNoCache(final Class key) { try { final Field field; try { - field = key.getField(BindingMapping.QNAME_STATIC_FIELD_NAME); + field = key.getField(Naming.QNAME_STATIC_FIELD_NAME); } catch (NoSuchFieldException e) { LOG.debug("{} does not have a {} field, falling back to computation", key, - BindingMapping.QNAME_STATIC_FIELD_NAME, e); + Naming.QNAME_STATIC_FIELD_NAME, e); return Optional.of(computeQName(key)); } final Object obj = field.get(null); - if (obj instanceof QName) { - return Optional.of((QName) obj); + if (obj instanceof QName qname) { + return Optional.of(qname); } } catch (SecurityException | IllegalArgumentException | IllegalAccessException e) { /* @@ -496,23 +184,16 @@ public final class BindingReflections { * @throws IllegalArgumentException If supplied class was not derived from YANG model. */ // FIXME: Extend this algorithm to also provide QName for YANG modeled simple types. - @SuppressWarnings({ "rawtypes", "unchecked", "checkstyle:illegalCatch" }) + @SuppressWarnings({ "rawtypes", "unchecked" }) private static QName computeQName(final Class key) { checkArgument(isBindingClass(key), "Supplied class %s is not derived from YANG.", key); - YangModuleInfo moduleInfo; - try { - moduleInfo = getModuleInfo(key); - } catch (Exception e) { - throw new IllegalStateException("Unable to get QName for " + key + ". YangModuleInfo was not found.", - e); - } - final QName module = moduleInfo.getName(); + final QName module = getModuleInfo(key).getName(); if (Augmentation.class.isAssignableFrom(key)) { return module; } else if (isRpcType(key)) { final String className = key.getSimpleName(); - if (className.endsWith(BindingMapping.RPC_OUTPUT_SUFFIX)) { + if (className.endsWith(Naming.RPC_OUTPUT_SUFFIX)) { return YangConstants.operationOutputQName(module.getModule()).intern(); } @@ -525,72 +206,4 @@ public final class BindingReflections { return module; } } - - /** - * Extracts augmentation from Binding DTO field using reflection. - * - * @param input - * Instance of DataObject which is augmentable and may contain - * augmentation - * @return Map of augmentations if read was successful, otherwise empty map. - */ - public static Map>, Augmentation> getAugmentations(final Augmentable input) { - return AugmentationFieldGetter.getGetter(input.getClass()).getAugmentations(input); - } - - /** - * Determines if two augmentation classes or case classes represents same - * data. - * - *

- * Two augmentations or cases could be substituted only if and if: - *

    - *
  • Both implements same interfaces
    • - *
  • Both have same children
    • - *
  • If augmentations: Both have same augmentation target class. Target - * class was generated for data node in grouping.
    • - *
  • If cases: Both are from same choice. Choice class was generated for - * data node in grouping.
    • - *
- * - *

- * Explanation: Binding Specification reuses classes generated for - * groupings as part of normal data tree, this classes from grouping could - * be used at various locations and user may not be aware of it and may use - * incorrect case or augmentation in particular subtree (via copy - * constructors, etc). - * - * @param potential - * Class which is potential substitution - * @param target - * Class which should be used at particular subtree - * @return true if and only if classes represents same data. - */ - @SuppressWarnings({ "rawtypes", "unchecked" }) - public static boolean isSubstitutionFor(final Class potential, final Class target) { - HashSet subImplemented = Sets.newHashSet(potential.getInterfaces()); - HashSet targetImplemented = Sets.newHashSet(target.getInterfaces()); - if (!subImplemented.equals(targetImplemented)) { - return false; - } - if (Augmentation.class.isAssignableFrom(potential) - && !BindingReflections.findAugmentationTarget(potential).equals( - BindingReflections.findAugmentationTarget(target))) { - return false; - } - for (Method potentialMethod : potential.getMethods()) { - try { - Method targetMethod = target.getMethod(potentialMethod.getName(), potentialMethod.getParameterTypes()); - if (!potentialMethod.getReturnType().equals(targetMethod.getReturnType())) { - return false; - } - } catch (NoSuchMethodException e) { - // Counterpart method is missing, so classes could not be substituted. - return false; - } catch (SecurityException e) { - throw new IllegalStateException("Could not compare methods", e); - } - } - return true; - } }