2 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.yangtools.yang.binding.util;
10 import static com.google.common.base.Preconditions.checkArgument;
11 import static com.google.common.base.Preconditions.checkState;
13 import java.lang.reflect.Field;
14 import java.lang.reflect.InvocationTargetException;
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;
24 import org.opendaylight.yangtools.yang.binding.Augmentable;
25 import org.opendaylight.yangtools.yang.binding.Augmentation;
26 import org.opendaylight.yangtools.yang.binding.BaseIdentity;
27 import org.opendaylight.yangtools.yang.binding.BindingMapping;
28 import org.opendaylight.yangtools.yang.binding.ChildOf;
29 import org.opendaylight.yangtools.yang.binding.DataContainer;
30 import org.opendaylight.yangtools.yang.binding.DataObject;
31 import org.opendaylight.yangtools.yang.binding.Notification;
32 import org.opendaylight.yangtools.yang.binding.RpcService;
33 import org.opendaylight.yangtools.yang.binding.YangModelBindingProvider;
34 import org.opendaylight.yangtools.yang.binding.YangModuleInfo;
35 import org.opendaylight.yangtools.yang.common.QName;
36 import org.slf4j.Logger;
37 import org.slf4j.LoggerFactory;
39 import com.google.common.base.Optional;
40 import com.google.common.cache.CacheBuilder;
41 import com.google.common.cache.CacheLoader;
42 import com.google.common.cache.LoadingCache;
43 import com.google.common.collect.ImmutableSet;
44 import com.google.common.collect.ImmutableSet.Builder;
46 public class BindingReflections {
48 private static final long EXPIRATION_TIME = 60;
49 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])";
50 private static final Pattern ROOT_PACKAGE_PATTERN = Pattern.compile(ROOT_PACKAGE_PATTERN_STRING);
51 private static final Logger LOG = LoggerFactory.getLogger(BindingReflections.class);
53 private static final LoadingCache<Class<?>, Optional<QName>> classToQName = CacheBuilder.newBuilder() //
55 .expireAfterAccess(EXPIRATION_TIME, TimeUnit.SECONDS) //
56 .build(new ClassToQNameLoader());
61 * {@link Augmentation} subclass for which we want to determine
62 * augmentation target.
63 * @return Augmentation target - class which augmentation provides
64 * additional extensions.
66 public static Class<? extends Augmentable<?>> findAugmentationTarget(
67 final Class<? extends Augmentation<?>> augmentation) {
68 return ClassLoaderUtils.findFirstGenericArgument(augmentation, Augmentation.class);
74 * {@link Augmentation} subclass for which we want to determine
75 * augmentation target.
76 * @return Augmentation target - class which augmentation provides
77 * additional extensions.
79 public static Class<?> findHierarchicalParent(final Class<? extends ChildOf<?>> childClass) {
80 return ClassLoaderUtils.findFirstGenericArgument(childClass, ChildOf.class);
86 * {@link Augmentation} subclass for which we want to determine
87 * augmentation target.
88 * @return Augmentation target - class which augmentation provides
89 * additional extensions.
91 public static Class<?> findHierarchicalParent(final DataObject childClass) {
92 if (childClass instanceof ChildOf) {
93 return ClassLoaderUtils.findFirstGenericArgument(childClass.getImplementedInterface(), ChildOf.class);
99 * Returns a QName associated to supplied type
102 * @return QName associated to supplied dataType. If dataType is Augmentation
103 * method does not return canonical QName, but QName with correct namespace
104 * revision, but virtual local name, since augmentations do not have name.
106 public static final QName findQName(final Class<?> dataType) {
107 return classToQName.getUnchecked(dataType).orNull();
110 private static class ClassToQNameLoader extends CacheLoader<Class<?>, Optional<QName>> {
113 public Optional<QName> load(final Class<?> key) throws Exception {
115 Field field = key.getField(BindingMapping.QNAME_STATIC_FIELD_NAME);
116 Object obj = field.get(null);
117 if (obj instanceof QName) {
118 return Optional.of((QName) obj);
120 } catch (NoSuchFieldException e) {
121 if(Augmentation.class.isAssignableFrom(key)) {
122 YangModuleInfo moduleInfo = getModuleInfo(key);
123 return Optional.of(QName.create(moduleInfo.getNamespace(), moduleInfo.getRevision(), moduleInfo.getName()));
125 } catch (SecurityException | IllegalArgumentException | IllegalAccessException e) {
128 return Optional.absent();
132 public static boolean isRpcMethod(final Method possibleMethod) {
133 return possibleMethod != null && RpcService.class.isAssignableFrom(possibleMethod.getDeclaringClass())
134 && Future.class.isAssignableFrom(possibleMethod.getReturnType())
135 && possibleMethod.getParameterTypes().length <= 1;
138 @SuppressWarnings("rawtypes")
139 public static Optional<Class<?>> resolveRpcOutputClass(final Method targetMethod) {
140 checkState(isRpcMethod(targetMethod), "Supplied method is not Rpc invocation method");
141 Type futureType = targetMethod.getGenericReturnType();
142 Type rpcResultType = ClassLoaderUtils.getFirstGenericParameter(futureType);
143 Type rpcResultArgument = ClassLoaderUtils.getFirstGenericParameter(rpcResultType);
144 if (rpcResultArgument instanceof Class && !Void.class.equals(rpcResultArgument)) {
145 return Optional.<Class<?>> of((Class) rpcResultArgument);
147 return Optional.absent();
150 @SuppressWarnings("unchecked")
151 public static Optional<Class<? extends DataContainer>> resolveRpcInputClass(final Method targetMethod) {
152 @SuppressWarnings("rawtypes")
153 Class[] types = targetMethod.getParameterTypes();
154 if (types.length == 0) {
155 return Optional.absent();
157 if (types.length == 1) {
158 return Optional.<Class<? extends DataContainer>> of(types[0]);
160 throw new IllegalArgumentException("Method has 2 or more arguments.");
163 public static QName getQName(final Class<? extends BaseIdentity> context) {
164 return findQName(context);
167 public static boolean isAugmentationChild(final Class<?> clazz) {
168 // FIXME: Current resolver could be still confused when
169 // child node was added by grouping
170 checkArgument(clazz != null);
172 @SuppressWarnings({ "rawtypes", "unchecked" })
173 Class<?> parent = findHierarchicalParent((Class) clazz);
174 if (parent == null) {
175 LOG.debug("Did not find a parent for class {}", clazz);
179 String clazzModelPackage = getModelRootPackageName(clazz.getPackage());
180 String parentModelPackage = getModelRootPackageName(parent.getPackage());
182 return !clazzModelPackage.equals(parentModelPackage);
185 public static String getModelRootPackageName(final Package pkg) {
186 return getModelRootPackageName(pkg.getName());
189 public static String getModelRootPackageName(final String name) {
190 checkArgument(name != null, "Package name should not be null.");
191 checkArgument(name.startsWith(BindingMapping.PACKAGE_PREFIX), "Package name not starting with %s, is: %s",
192 BindingMapping.PACKAGE_PREFIX, name);
193 Matcher match = ROOT_PACKAGE_PATTERN.matcher(name);
194 checkArgument(match.find(),"Package name '%s' does not match required pattern '%s'",name,ROOT_PACKAGE_PATTERN_STRING);
195 return match.group(0);
198 public static YangModuleInfo getModuleInfo(final Class<?> cls) throws Exception {
199 checkArgument(cls != null);
200 String packageName = getModelRootPackageName(cls.getPackage());
201 final String potentialClassName = getModuleInfoClassName(packageName);
202 return ClassLoaderUtils.withClassLoader(cls.getClassLoader(), new Callable<YangModuleInfo>() {
204 public YangModuleInfo call() throws ClassNotFoundException, IllegalAccessException, IllegalArgumentException, InvocationTargetException, NoSuchMethodException, SecurityException {
205 Class<?> moduleInfoClass = Thread.currentThread().getContextClassLoader().loadClass(potentialClassName);
206 return (YangModuleInfo) moduleInfoClass.getMethod("getInstance").invoke(null);
211 public static String getModuleInfoClassName(final String packageName) {
212 return packageName + "." + BindingMapping.MODULE_INFO_CLASS_NAME;
215 public static boolean isBindingClass(final Class<?> cls) {
216 if (DataContainer.class.isAssignableFrom(cls) || Augmentation.class.isAssignableFrom(cls)) {
219 return (cls.getName().startsWith(BindingMapping.PACKAGE_PREFIX));
222 public static boolean isNotificationCallback(final Method method) {
223 checkArgument(method != null);
224 if (method.getName().startsWith("on") && method.getParameterTypes().length == 1) {
225 Class<?> potentialNotification = method.getParameterTypes()[0];
226 if (isNotification(potentialNotification)
227 && method.getName().equals("on" + potentialNotification.getSimpleName())) {
234 public static boolean isNotification(final Class<?> potentialNotification) {
235 checkArgument(potentialNotification != null);
236 return Notification.class.isAssignableFrom(potentialNotification);
239 public static ImmutableSet<YangModuleInfo> loadModuleInfos() {
240 return loadModuleInfos(Thread.currentThread().getContextClassLoader());
243 public static ImmutableSet<YangModuleInfo> loadModuleInfos(final ClassLoader loader) {
244 Builder<YangModuleInfo> moduleInfoSet = ImmutableSet.<YangModuleInfo>builder();
245 ServiceLoader<YangModelBindingProvider> serviceLoader = ServiceLoader.load(YangModelBindingProvider.class, loader);
246 for(YangModelBindingProvider bindingProvider : serviceLoader) {
247 YangModuleInfo moduleInfo = bindingProvider.getModuleInfo();
248 checkState(moduleInfo != null, "Module Info for %s is not available.",bindingProvider.getClass());
249 collectYangModuleInfo(bindingProvider.getModuleInfo(),moduleInfoSet);
251 return moduleInfoSet.build();
254 private static void collectYangModuleInfo(final YangModuleInfo moduleInfo, final Builder<YangModuleInfo> moduleInfoSet) {
255 moduleInfoSet.add(moduleInfo);
256 for(YangModuleInfo dependency : moduleInfo.getImportedModules()) {
257 collectYangModuleInfo(dependency, moduleInfoSet);
261 public static boolean isRpcType(final Class<? extends DataObject> targetType) {
262 return DataContainer.class.isAssignableFrom(targetType) //
263 && !ChildOf.class.isAssignableFrom(targetType) //
264 && !Notification.class.isAssignableFrom(targetType) //
265 && (targetType.getName().endsWith("Input") || targetType.getName().endsWith("Output"));