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 java.lang.reflect.Field;
11 import java.lang.reflect.Method;
12 import java.lang.reflect.Type;
13 import java.util.concurrent.Callable;
14 import java.util.concurrent.Future;
15 import java.util.concurrent.TimeUnit;
16 import java.util.regex.MatchResult;
17 import java.util.regex.Matcher;
18 import java.util.regex.Pattern;
20 import org.opendaylight.yangtools.concepts.util.ClassLoaderUtils;
21 import org.opendaylight.yangtools.yang.binding.Augmentable;
22 import org.opendaylight.yangtools.yang.binding.Augmentation;
23 import org.opendaylight.yangtools.yang.binding.BaseIdentity;
24 import org.opendaylight.yangtools.yang.binding.BindingMapping;
25 import org.opendaylight.yangtools.yang.binding.ChildOf;
26 import org.opendaylight.yangtools.yang.binding.DataContainer;
27 import org.opendaylight.yangtools.yang.binding.DataObject;
28 import org.opendaylight.yangtools.yang.binding.RpcService;
29 import org.opendaylight.yangtools.yang.binding.YangModuleInfo;
30 import org.opendaylight.yangtools.yang.binding.annotations.ModuleQName;
31 import org.opendaylight.yangtools.yang.common.QName;
33 import static com.google.common.base.Preconditions.*;
34 import static org.opendaylight.yangtools.concepts.util.ClassLoaderUtils.*;
36 import com.google.common.base.Optional;
37 import com.google.common.base.Preconditions;
38 import com.google.common.cache.CacheBuilder;
39 import com.google.common.cache.CacheLoader;
40 import com.google.common.cache.LoadingCache;
42 public class BindingReflections {
44 private static final long EXPIRATION_TIME = 60;
45 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])";
46 private static final Pattern ROOT_PACKAGE_PATTERN = Pattern.compile(ROOT_PACKAGE_PATTERN_STRING);
48 private static final LoadingCache<Class<?>, Optional<QName>> classToQName = CacheBuilder.newBuilder() //
50 .expireAfterAccess(EXPIRATION_TIME, TimeUnit.SECONDS) //
51 .build(new ClassToQNameLoader());
56 * {@link Augmentation} subclass for which we want to determine
57 * augmentation target.
58 * @return Augmentation target - class which augmentation provides
59 * additional extensions.
61 public static Class<? extends Augmentable<?>> findAugmentationTarget(
62 final Class<? extends Augmentation<?>> augmentation) {
63 return ClassLoaderUtils.findFirstGenericArgument(augmentation, Augmentation.class);
69 * {@link Augmentation} subclass for which we want to determine
70 * augmentation target.
71 * @return Augmentation target - class which augmentation provides
72 * additional extensions.
74 public static Class<?> findHierarchicalParent(final Class<? extends ChildOf<?>> childClass) {
75 return ClassLoaderUtils.findFirstGenericArgument(childClass, ChildOf.class);
81 * {@link Augmentation} subclass for which we want to determine
82 * augmentation target.
83 * @return Augmentation target - class which augmentation provides
84 * additional extensions.
86 public static Class<?> findHierarchicalParent(DataObject childClass) {
87 if (childClass instanceof ChildOf) {
88 return ClassLoaderUtils.findFirstGenericArgument(childClass.getImplementedInterface(), ChildOf.class);
93 public static final QName findQName(Class<?> dataType) {
94 return classToQName.getUnchecked(dataType).orNull();
97 private static class ClassToQNameLoader extends CacheLoader<Class<?>, Optional<QName>> {
100 public Optional<QName> load(Class<?> key) throws Exception {
102 Field field = key.getField(BindingMapping.QNAME_STATIC_FIELD_NAME);
103 Object obj = field.get(null);
104 if (obj instanceof QName) {
105 return Optional.of((QName) obj);
107 } catch (NoSuchFieldException | SecurityException | IllegalArgumentException | IllegalAccessException e) {
110 return Optional.absent();
114 public static boolean isRpcMethod(Method possibleMethod) {
115 return possibleMethod != null &&
116 RpcService.class.isAssignableFrom(possibleMethod.getDeclaringClass())
117 && Future.class.isAssignableFrom(possibleMethod.getReturnType())
118 && possibleMethod.getParameterTypes().length <= 1;
121 @SuppressWarnings("rawtypes")
122 public static Optional<Class<?>> resolveRpcOutputClass(Method targetMethod) {
123 checkState(isRpcMethod(targetMethod),"Supplied method is not Rpc invocation method");
124 Type futureType = targetMethod.getGenericReturnType();
125 Type rpcResultType = ClassLoaderUtils.getFirstGenericParameter(futureType);
126 Type rpcResultArgument = ClassLoaderUtils.getFirstGenericParameter(rpcResultType);
127 if(rpcResultArgument instanceof Class && !Void.class.equals(rpcResultArgument)) {
128 return Optional.<Class<?>>of((Class) rpcResultArgument);
130 return Optional.absent();
133 @SuppressWarnings("unchecked")
134 public static Optional<Class<? extends DataContainer>> resolveRpcInputClass(Method targetMethod) {
135 @SuppressWarnings("rawtypes")
136 Class[] types = targetMethod.getParameterTypes();
137 if(types.length == 0) {
138 return Optional.absent();
140 if(types.length == 1) {
141 return Optional.<Class<? extends DataContainer>>of(types[0]);
143 throw new IllegalArgumentException("Method has 2 or more arguments.");
146 public static QName getQName(Class<? extends BaseIdentity> context) {
147 return findQName(context);
150 public static boolean isAugmentationChild(Class<?> clazz) {
151 // FIXME: Current resolver could be still confused when
152 // child node was added by grouping
153 checkArgument(clazz != null);
154 @SuppressWarnings({ "rawtypes", "unchecked" })
155 Class<?> parent = findHierarchicalParent((Class) clazz);
156 String clazzModelPackage = getModelRootPackageName(clazz.getPackage());
157 String parentModelPackage = getModelRootPackageName(parent.getPackage());
159 return !clazzModelPackage.equals(parentModelPackage);
162 public static String getModelRootPackageName(Package pkg) {
163 return getModelRootPackageName(pkg.getName());
166 public static String getModelRootPackageName(String name) {
167 checkArgument(name != null, "Package name should not be null.");
168 checkArgument(name.startsWith(BindingMapping.PACKAGE_PREFIX));
169 Matcher match = ROOT_PACKAGE_PATTERN.matcher(name);
170 checkArgument(match.find());
171 String rootPackage = match.group(0);
175 public static YangModuleInfo getModuleInfo(final Class<?> cls) throws Exception {
176 checkArgument(cls != null);
177 String packageName = getModelRootPackageName(cls.getPackage());
178 final String potentialClassName = getModuleInfoClassName(packageName);
179 return withClassLoader(cls.getClassLoader(), new Callable<YangModuleInfo>() {
182 public YangModuleInfo call() throws Exception {
183 Class<?> moduleInfoClass = Thread.currentThread().getContextClassLoader().loadClass(potentialClassName);
184 return (YangModuleInfo) moduleInfoClass.getMethod("getInstance").invoke(null);
189 public static String getModuleInfoClassName(String packageName) {
190 return packageName + "." + BindingMapping.MODULE_INFO_CLASS_NAME;
193 public static boolean isBindingClass(Class<?> cls) {
194 if(DataContainer.class.isAssignableFrom(cls) || Augmentation.class.isAssignableFrom(cls)) {
197 return (cls.getName().startsWith(BindingMapping.PACKAGE_PREFIX));