Added support for discovering YangModuleInfo via ServiceLoader.

[mdsal.git] / yang / yang-binding / src / main / java / org / opendaylight / yangtools / yang / binding / util / BindingReflections.java

diff --git a/yang/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/util/BindingReflections.java b/yang/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/util/BindingReflections.java
index 137640203378d67a2a0ce78837ed01fb173c880c..48ebcdea4390a25b084fbea4a249dc4e251634c3 100644 (file)
--- a/yang/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/util/BindingReflections.java
+++ b/yang/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/util/BindingReflections.java
@@ -7,9 +7,12 @@
  */
 package org.opendaylight.yangtools.yang.binding.util;
 
+import java.beans.MethodDescriptor;
 import java.lang.reflect.Field;
 import java.lang.reflect.Method;
 import java.lang.reflect.Type;
+import java.util.ServiceLoader;
+import java.util.concurrent.Callable;
 import java.util.concurrent.Future;
 import java.util.concurrent.TimeUnit;
 import java.util.regex.MatchResult;
@@ -24,15 +27,23 @@ import org.opendaylight.yangtools.yang.binding.BindingMapping;
 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.annotations.ModuleQName;
 import org.opendaylight.yangtools.yang.common.QName;
 
 import static com.google.common.base.Preconditions.*;
+import static org.opendaylight.yangtools.concepts.util.ClassLoaderUtils.*;
 
 import com.google.common.base.Optional;
+import com.google.common.base.Preconditions;
 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;
 
 public class BindingReflections {
 
@@ -107,20 +118,19 @@ public class BindingReflections {
     }
 
     public static boolean isRpcMethod(Method possibleMethod) {
-        return possibleMethod != null &&
-        RpcService.class.isAssignableFrom(possibleMethod.getDeclaringClass())
-        && Future.class.isAssignableFrom(possibleMethod.getReturnType())
-        && possibleMethod.getParameterTypes().length <= 1;
+        return possibleMethod != null && RpcService.class.isAssignableFrom(possibleMethod.getDeclaringClass())
+                && Future.class.isAssignableFrom(possibleMethod.getReturnType())
+                && possibleMethod.getParameterTypes().length <= 1;
     }
 
     @SuppressWarnings("rawtypes")
     public static Optional<Class<?>> resolveRpcOutputClass(Method targetMethod) {
-        checkState(isRpcMethod(targetMethod),"Supplied method is not Rpc invocation method");
+        checkState(isRpcMethod(targetMethod), "Supplied method is not 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.<Class<?>>of((Class) rpcResultArgument);
+        if (rpcResultArgument instanceof Class && !Void.class.equals(rpcResultArgument)) {
+            return Optional.<Class<?>> of((Class) rpcResultArgument);
         }
         return Optional.absent();
     }
@@ -129,11 +139,11 @@ public class BindingReflections {
     public static Optional<Class<? extends DataContainer>> resolveRpcInputClass(Method targetMethod) {
         @SuppressWarnings("rawtypes")
         Class[] types = targetMethod.getParameterTypes();
-        if(types.length == 0) {
+        if (types.length == 0) {
             return Optional.absent();
         }
-        if(types.length == 1) {
-            return Optional.<Class<? extends DataContainer>>of(types[0]);
+        if (types.length == 1) {
+            return Optional.<Class<? extends DataContainer>> of(types[0]);
         }
         throw new IllegalArgumentException("Method has 2 or more arguments.");
     }
@@ -141,7 +151,7 @@ public class BindingReflections {
     public static QName getQName(Class<? extends BaseIdentity> context) {
         return findQName(context);
     }
-    
+
     public static boolean isAugmentationChild(Class<?> clazz) {
         // FIXME: Current resolver could be still confused when
         // child node was added by grouping
@@ -167,4 +177,66 @@ public class BindingReflections {
         return rootPackage;
     }
 
+    public static YangModuleInfo getModuleInfo(final Class<?> cls) throws Exception {
+        checkArgument(cls != null);
+        String packageName = getModelRootPackageName(cls.getPackage());
+        final String potentialClassName = getModuleInfoClassName(packageName);
+        return withClassLoader(cls.getClassLoader(), new Callable<YangModuleInfo>() {
+
+            @Override
+            public YangModuleInfo call() throws Exception {
+                Class<?> moduleInfoClass = Thread.currentThread().getContextClassLoader().loadClass(potentialClassName);
+                return (YangModuleInfo) moduleInfoClass.getMethod("getInstance").invoke(null);
+            }
+        });
+    }
+
+    public static String getModuleInfoClassName(String packageName) {
+        return packageName + "." + BindingMapping.MODULE_INFO_CLASS_NAME;
+    }
+
+    public static boolean isBindingClass(Class<?> cls) {
+        if (DataContainer.class.isAssignableFrom(cls) || Augmentation.class.isAssignableFrom(cls)) {
+            return true;
+        }
+        return (cls.getName().startsWith(BindingMapping.PACKAGE_PREFIX));
+    }
+
+    public static boolean isNotificationCallback(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;
+    }
+
+    public static boolean isNotification(Class<?> potentialNotification) {
+        checkArgument(potentialNotification != null);
+        return Notification.class.isAssignableFrom(potentialNotification);
+    }
+    
+    public static ImmutableSet<YangModuleInfo> loadModuleInfos() {
+        return loadModuleInfos(Thread.currentThread().getContextClassLoader());
+    }
+    
+    public static ImmutableSet<YangModuleInfo> loadModuleInfos(ClassLoader loader) {
+        Builder<YangModuleInfo> moduleInfoSet = ImmutableSet.<YangModuleInfo>builder();
+        ServiceLoader<YangModelBindingProvider> serviceLoader = ServiceLoader.load(YangModelBindingProvider.class, loader);
+        for(YangModelBindingProvider bindingProvider : serviceLoader) {
+            collectYangModuleInfo(bindingProvider.getModuleInfo(),moduleInfoSet);
+        }
+        return  moduleInfoSet.build();
+    }
+
+    private static void collectYangModuleInfo(YangModuleInfo moduleInfo, Builder<YangModuleInfo> moduleInfoSet) {
+        moduleInfoSet.add(moduleInfo);
+        for(YangModuleInfo dependency : moduleInfo.getImportedModules()) {
+            collectYangModuleInfo(dependency, moduleInfoSet);
+        }
+    }
+
 }