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