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