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(final DataObject childClass) {
  90         if (childClass instanceof ChildOf) {
  91             return ClassLoaderUtils.findFirstGenericArgument(childClass.getImplementedInterface(), ChildOf.class);
  92         }
  93         return null;
  94     }
  95
  96     /**
  97      * Returns a QName associated to supplied type
  98      *
  99      * @param dataType
 100      * @return QName associated to supplied dataType. If dataType is Augmentation
 101      *    method does not return canonical QName, but QName with correct namespace
 102      *    revision, but virtual local name, since augmentations do not have name.
 103      */
 104     public static final QName findQName(final Class<?> dataType) {
 105         return classToQName.getUnchecked(dataType).orNull();
 106     }
 107
 108     private static class ClassToQNameLoader extends CacheLoader<Class<?>, Optional<QName>> {
 109
 110         @Override
 111         public Optional<QName> load(final Class<?> key) throws Exception {
 112             try {
 113                 Field field = key.getField(BindingMapping.QNAME_STATIC_FIELD_NAME);
 114                 Object obj = field.get(null);
 115                 if (obj instanceof QName) {
 116                     return Optional.of((QName) obj);
 117                 }
 118             } catch (NoSuchFieldException e) {
 119                 if(Augmentation.class.isAssignableFrom(key)) {
 120                     YangModuleInfo moduleInfo = getModuleInfo(key);
 121                     return Optional.of(QName.create(moduleInfo.getNamespace(), moduleInfo.getRevision(), moduleInfo.getName()));
 122                 }
 123
 124             } catch (SecurityException | IllegalArgumentException | IllegalAccessException e) {
 125                 // NOOP
 126             }
 127             return Optional.absent();
 128         }
 129     }
 130
 131     public static boolean isRpcMethod(final Method possibleMethod) {
 132         return possibleMethod != null && RpcService.class.isAssignableFrom(possibleMethod.getDeclaringClass())
 133                 && Future.class.isAssignableFrom(possibleMethod.getReturnType())
 134                 && possibleMethod.getParameterTypes().length <= 1;
 135     }
 136
 137     @SuppressWarnings("rawtypes")
 138     public static Optional<Class<?>> resolveRpcOutputClass(final Method targetMethod) {
 139         checkState(isRpcMethod(targetMethod), "Supplied method is not Rpc invocation method");
 140         Type futureType = targetMethod.getGenericReturnType();
 141         Type rpcResultType = ClassLoaderUtils.getFirstGenericParameter(futureType);
 142         Type rpcResultArgument = ClassLoaderUtils.getFirstGenericParameter(rpcResultType);
 143         if (rpcResultArgument instanceof Class && !Void.class.equals(rpcResultArgument)) {
 144             return Optional.<Class<?>> of((Class) rpcResultArgument);
 145         }
 146         return Optional.absent();
 147     }
 148
 149     @SuppressWarnings("unchecked")
 150     public static Optional<Class<? extends DataContainer>> resolveRpcInputClass(final Method targetMethod) {
 151         @SuppressWarnings("rawtypes")
 152         Class[] types = targetMethod.getParameterTypes();
 153         if (types.length == 0) {
 154             return Optional.absent();
 155         }
 156         if (types.length == 1) {
 157             return Optional.<Class<? extends DataContainer>> of(types[0]);
 158         }
 159         throw new IllegalArgumentException("Method has 2 or more arguments.");
 160     }
 161
 162     public static QName getQName(final Class<? extends BaseIdentity> context) {
 163         return findQName(context);
 164     }
 165
 166     public static boolean isAugmentationChild(final Class<?> clazz) {
 167         // FIXME: Current resolver could be still confused when
 168         // child node was added by grouping
 169         checkArgument(clazz != null);
 170         @SuppressWarnings({ "rawtypes", "unchecked" })
 171         Class<?> parent = findHierarchicalParent((Class) clazz);
 172         String clazzModelPackage = getModelRootPackageName(clazz.getPackage());
 173         String parentModelPackage = getModelRootPackageName(parent.getPackage());
 174
 175         return !clazzModelPackage.equals(parentModelPackage);
 176     }
 177
 178     public static String getModelRootPackageName(final Package pkg) {
 179         return getModelRootPackageName(pkg.getName());
 180     }
 181
 182     public static String getModelRootPackageName(final String name) {
 183         checkArgument(name != null, "Package name should not be null.");
 184         checkArgument(name.startsWith(BindingMapping.PACKAGE_PREFIX), "Package name not starting with %s, is: %s",
 185                 BindingMapping.PACKAGE_PREFIX, name);
 186         Matcher match = ROOT_PACKAGE_PATTERN.matcher(name);
 187         checkArgument(match.find(),"Package name '%s' does not match required pattern '%s'",name,ROOT_PACKAGE_PATTERN_STRING);
 188         return match.group(0);
 189     }
 190
 191     public static YangModuleInfo getModuleInfo(final Class<?> cls) throws Exception {
 192         checkArgument(cls != null);
 193         String packageName = getModelRootPackageName(cls.getPackage());
 194         final String potentialClassName = getModuleInfoClassName(packageName);
 195         return withClassLoader(cls.getClassLoader(), new Callable<YangModuleInfo>() {
 196
 197             @Override
 198             public YangModuleInfo call() throws Exception {
 199                 Class<?> moduleInfoClass = Thread.currentThread().getContextClassLoader().loadClass(potentialClassName);
 200                 return (YangModuleInfo) moduleInfoClass.getMethod("getInstance").invoke(null);
 201             }
 202         });
 203     }
 204
 205     public static String getModuleInfoClassName(final String packageName) {
 206         return packageName + "." + BindingMapping.MODULE_INFO_CLASS_NAME;
 207     }
 208
 209     public static boolean isBindingClass(final Class<?> cls) {
 210         if (DataContainer.class.isAssignableFrom(cls) || Augmentation.class.isAssignableFrom(cls)) {
 211             return true;
 212         }
 213         return (cls.getName().startsWith(BindingMapping.PACKAGE_PREFIX));
 214     }
 215
 216     public static boolean isNotificationCallback(final Method method) {
 217         checkArgument(method != null);
 218         if (method.getName().startsWith("on") && method.getParameterTypes().length == 1) {
 219             Class<?> potentialNotification = method.getParameterTypes()[0];
 220             if (isNotification(potentialNotification)
 221                     && method.getName().equals("on" + potentialNotification.getSimpleName())) {
 222                 return true;
 223             }
 224         }
 225         return false;
 226     }
 227
 228     public static boolean isNotification(final Class<?> potentialNotification) {
 229         checkArgument(potentialNotification != null);
 230         return Notification.class.isAssignableFrom(potentialNotification);
 231     }
 232
 233     public static ImmutableSet<YangModuleInfo> loadModuleInfos() {
 234         return loadModuleInfos(Thread.currentThread().getContextClassLoader());
 235     }
 236
 237     public static ImmutableSet<YangModuleInfo> loadModuleInfos(final ClassLoader loader) {
 238         Builder<YangModuleInfo> moduleInfoSet = ImmutableSet.<YangModuleInfo>builder();
 239         ServiceLoader<YangModelBindingProvider> serviceLoader = ServiceLoader.load(YangModelBindingProvider.class, loader);
 240         for(YangModelBindingProvider bindingProvider : serviceLoader) {
 241             YangModuleInfo moduleInfo = bindingProvider.getModuleInfo();
 242             checkState(moduleInfo != null, "Module Info for %s is not available.",bindingProvider.getClass());
 243             collectYangModuleInfo(bindingProvider.getModuleInfo(),moduleInfoSet);
 244         }
 245         return  moduleInfoSet.build();
 246     }
 247
 248     private static void collectYangModuleInfo(final YangModuleInfo moduleInfo, final Builder<YangModuleInfo> moduleInfoSet) {
 249         moduleInfoSet.add(moduleInfo);
 250         for(YangModuleInfo dependency : moduleInfo.getImportedModules()) {
 251             collectYangModuleInfo(dependency, moduleInfoSet);
 252         }
 253     }
 254
 255     public static boolean isRpcType(final Class<? extends DataObject> targetType) {
 256         return  DataContainer.class.isAssignableFrom(targetType) //
 257                 && !ChildOf.class.isAssignableFrom(targetType) //
 258                 && !Notification.class.isAssignableFrom(targetType) //
 259                 && (targetType.getName().endsWith("Input") || targetType.getName().endsWith("Output"));
 260     }
 261
 262 }