yang/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/util/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.yangtools.yang.binding.util;
   9
  10 import java.beans.MethodDescriptor;
  11 import java.lang.reflect.Field;
  12 import java.lang.reflect.Method;
  13 import java.lang.reflect.Type;
  14 import java.util.ServiceLoader;
  15 import java.util.concurrent.Callable;
  16 import java.util.concurrent.Future;
  17 import java.util.concurrent.TimeUnit;
  18 import java.util.regex.MatchResult;
  19 import java.util.regex.Matcher;
  20 import java.util.regex.Pattern;
  21
  22 import org.opendaylight.yangtools.concepts.util.ClassLoaderUtils;
  23 import org.opendaylight.yangtools.yang.binding.Augmentable;
  24 import org.opendaylight.yangtools.yang.binding.Augmentation;
  25 import org.opendaylight.yangtools.yang.binding.BaseIdentity;
  26 import org.opendaylight.yangtools.yang.binding.BindingMapping;
  27 import org.opendaylight.yangtools.yang.binding.ChildOf;
  28 import org.opendaylight.yangtools.yang.binding.DataContainer;
  29 import org.opendaylight.yangtools.yang.binding.DataObject;
  30 import org.opendaylight.yangtools.yang.binding.Notification;
  31 import org.opendaylight.yangtools.yang.binding.RpcService;
  32 import org.opendaylight.yangtools.yang.binding.YangModelBindingProvider;
  33 import org.opendaylight.yangtools.yang.binding.YangModuleInfo;
  34 import org.opendaylight.yangtools.yang.binding.annotations.ModuleQName;
  35 import org.opendaylight.yangtools.yang.common.QName;
  36
  37 import static com.google.common.base.Preconditions.*;
  38 import static org.opendaylight.yangtools.concepts.util.ClassLoaderUtils.*;
  39
  40 import com.google.common.base.Optional;
  41 import com.google.common.base.Preconditions;
  42 import com.google.common.cache.CacheBuilder;
  43 import com.google.common.cache.CacheLoader;
  44 import com.google.common.cache.LoadingCache;
  45 import com.google.common.collect.ImmutableSet;
  46 import com.google.common.collect.ImmutableSet.Builder;
  47
  48 public class BindingReflections {
  49
  50     private static final long EXPIRATION_TIME = 60;
  51     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])";
  52     private static final Pattern ROOT_PACKAGE_PATTERN = Pattern.compile(ROOT_PACKAGE_PATTERN_STRING);
  53
  54     private static final LoadingCache<Class<?>, Optional<QName>> classToQName = CacheBuilder.newBuilder() //
  55             .weakKeys() //
  56             .expireAfterAccess(EXPIRATION_TIME, TimeUnit.SECONDS) //
  57             .build(new ClassToQNameLoader());
  58
  59     /**
  60      *
  61      * @param augmentation
  62      *            {@link Augmentation} subclass for which we want to determine
  63      *            augmentation target.
  64      * @return Augmentation target - class which augmentation provides
  65      *         additional extensions.
  66      */
  67     public static Class<? extends Augmentable<?>> findAugmentationTarget(
  68             final Class<? extends Augmentation<?>> augmentation) {
  69         return ClassLoaderUtils.findFirstGenericArgument(augmentation, Augmentation.class);
  70     }
  71
  72     /**
  73      *
  74      * @param augmentation
  75      *            {@link Augmentation} subclass for which we want to determine
  76      *            augmentation target.
  77      * @return Augmentation target - class which augmentation provides
  78      *         additional extensions.
  79      */
  80     public static Class<?> findHierarchicalParent(final Class<? extends ChildOf<?>> childClass) {
  81         return ClassLoaderUtils.findFirstGenericArgument(childClass, ChildOf.class);
  82     }
  83
  84     /**
  85      *
  86      * @param augmentation
  87      *            {@link Augmentation} subclass for which we want to determine
  88      *            augmentation target.
  89      * @return Augmentation target - class which augmentation provides
  90      *         additional extensions.
  91      */
  92     public static Class<?> findHierarchicalParent(DataObject childClass) {
  93         if (childClass instanceof ChildOf) {
  94             return ClassLoaderUtils.findFirstGenericArgument(childClass.getImplementedInterface(), ChildOf.class);
  95         }
  96         return null;
  97     }
  98
  99     public static final QName findQName(Class<?> dataType) {
 100         return classToQName.getUnchecked(dataType).orNull();
 101     }
 102
 103     private static class ClassToQNameLoader extends CacheLoader<Class<?>, Optional<QName>> {
 104
 105         @Override
 106         public Optional<QName> load(Class<?> key) throws Exception {
 107             try {
 108                 Field field = key.getField(BindingMapping.QNAME_STATIC_FIELD_NAME);
 109                 Object obj = field.get(null);
 110                 if (obj instanceof QName) {
 111                     return Optional.of((QName) obj);
 112                 }
 113             } catch (NoSuchFieldException | SecurityException | IllegalArgumentException | IllegalAccessException e) {
 114                 // NOOP
 115             }
 116             return Optional.absent();
 117         }
 118     }
 119
 120     public static boolean isRpcMethod(Method possibleMethod) {
 121         return possibleMethod != null && RpcService.class.isAssignableFrom(possibleMethod.getDeclaringClass())
 122                 && Future.class.isAssignableFrom(possibleMethod.getReturnType())
 123                 && possibleMethod.getParameterTypes().length <= 1;
 124     }
 125
 126     @SuppressWarnings("rawtypes")
 127     public static Optional<Class<?>> resolveRpcOutputClass(Method targetMethod) {
 128         checkState(isRpcMethod(targetMethod), "Supplied method is not Rpc invocation method");
 129         Type futureType = targetMethod.getGenericReturnType();
 130         Type rpcResultType = ClassLoaderUtils.getFirstGenericParameter(futureType);
 131         Type rpcResultArgument = ClassLoaderUtils.getFirstGenericParameter(rpcResultType);
 132         if (rpcResultArgument instanceof Class && !Void.class.equals(rpcResultArgument)) {
 133             return Optional.<Class<?>> of((Class) rpcResultArgument);
 134         }
 135         return Optional.absent();
 136     }
 137
 138     @SuppressWarnings("unchecked")
 139     public static Optional<Class<? extends DataContainer>> resolveRpcInputClass(Method targetMethod) {
 140         @SuppressWarnings("rawtypes")
 141         Class[] types = targetMethod.getParameterTypes();
 142         if (types.length == 0) {
 143             return Optional.absent();
 144         }
 145         if (types.length == 1) {
 146             return Optional.<Class<? extends DataContainer>> of(types[0]);
 147         }
 148         throw new IllegalArgumentException("Method has 2 or more arguments.");
 149     }
 150
 151     public static QName getQName(Class<? extends BaseIdentity> context) {
 152         return findQName(context);
 153     }
 154
 155     public static boolean isAugmentationChild(Class<?> clazz) {
 156         // FIXME: Current resolver could be still confused when
 157         // child node was added by grouping
 158         checkArgument(clazz != null);
 159         @SuppressWarnings({ "rawtypes", "unchecked" })
 160         Class<?> parent = findHierarchicalParent((Class) clazz);
 161         String clazzModelPackage = getModelRootPackageName(clazz.getPackage());
 162         String parentModelPackage = getModelRootPackageName(parent.getPackage());
 163
 164         return !clazzModelPackage.equals(parentModelPackage);
 165     }
 166
 167     public static String getModelRootPackageName(Package pkg) {
 168         return getModelRootPackageName(pkg.getName());
 169     }
 170
 171     public static String getModelRootPackageName(String name) {
 172         checkArgument(name != null, "Package name should not be null.");
 173         checkArgument(name.startsWith(BindingMapping.PACKAGE_PREFIX));
 174         Matcher match = ROOT_PACKAGE_PATTERN.matcher(name);
 175         checkArgument(match.find());
 176         String rootPackage = match.group(0);
 177         return rootPackage;
 178     }
 179
 180     public static YangModuleInfo getModuleInfo(final Class<?> cls) throws Exception {
 181         checkArgument(cls != null);
 182         String packageName = getModelRootPackageName(cls.getPackage());
 183         final String potentialClassName = getModuleInfoClassName(packageName);
 184         return withClassLoader(cls.getClassLoader(), new Callable<YangModuleInfo>() {
 185
 186             @Override
 187             public YangModuleInfo call() throws Exception {
 188                 Class<?> moduleInfoClass = Thread.currentThread().getContextClassLoader().loadClass(potentialClassName);
 189                 return (YangModuleInfo) moduleInfoClass.getMethod("getInstance").invoke(null);
 190             }
 191         });
 192     }
 193
 194     public static String getModuleInfoClassName(String packageName) {
 195         return packageName + "." + BindingMapping.MODULE_INFO_CLASS_NAME;
 196     }
 197
 198     public static boolean isBindingClass(Class<?> cls) {
 199         if (DataContainer.class.isAssignableFrom(cls) || Augmentation.class.isAssignableFrom(cls)) {
 200             return true;
 201         }
 202         return (cls.getName().startsWith(BindingMapping.PACKAGE_PREFIX));
 203     }
 204
 205     public static boolean isNotificationCallback(Method method) {
 206         checkArgument(method != null);
 207         if (method.getName().startsWith("on") && method.getParameterTypes().length == 1) {
 208             Class<?> potentialNotification = method.getParameterTypes()[0];
 209             if (isNotification(potentialNotification)
 210                     && method.getName().equals("on" + potentialNotification.getSimpleName())) {
 211                 return true;
 212             }
 213         }
 214         return false;
 215     }
 216
 217     public static boolean isNotification(Class<?> potentialNotification) {
 218         checkArgument(potentialNotification != null);
 219         return Notification.class.isAssignableFrom(potentialNotification);
 220     }
 221
 222     public static ImmutableSet<YangModuleInfo> loadModuleInfos() {
 223         return loadModuleInfos(Thread.currentThread().getContextClassLoader());
 224     }
 225
 226     public static ImmutableSet<YangModuleInfo> loadModuleInfos(ClassLoader loader) {
 227         Builder<YangModuleInfo> moduleInfoSet = ImmutableSet.<YangModuleInfo>builder();
 228         ServiceLoader<YangModelBindingProvider> serviceLoader = ServiceLoader.load(YangModelBindingProvider.class, loader);
 229         for(YangModelBindingProvider bindingProvider : serviceLoader) {
 230             collectYangModuleInfo(bindingProvider.getModuleInfo(),moduleInfoSet);
 231         }
 232         return  moduleInfoSet.build();
 233     }
 234
 235     private static void collectYangModuleInfo(YangModuleInfo moduleInfo, Builder<YangModuleInfo> moduleInfoSet) {
 236         moduleInfoSet.add(moduleInfo);
 237         for(YangModuleInfo dependency : moduleInfo.getImportedModules()) {
 238             collectYangModuleInfo(dependency, moduleInfoSet);
 239         }
 240     }
 241
 242 }