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.mdsal.binding.spec.reflect;
10 import static com.google.common.base.Preconditions.checkArgument;
11 import static com.google.common.base.Preconditions.checkState;
13 import com.google.common.annotations.VisibleForTesting;
14 import com.google.common.cache.CacheBuilder;
15 import com.google.common.cache.CacheLoader;
16 import com.google.common.cache.LoadingCache;
17 import java.lang.reflect.Field;
18 import java.lang.reflect.InvocationTargetException;
19 import java.util.Optional;
20 import java.util.concurrent.TimeUnit;
21 import org.eclipse.jdt.annotation.NonNull;
22 import org.opendaylight.yangtools.yang.binding.Action;
23 import org.opendaylight.yangtools.yang.binding.Augmentation;
24 import org.opendaylight.yangtools.yang.binding.BaseIdentity;
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.Notification;
29 import org.opendaylight.yangtools.yang.binding.YangModuleInfo;
30 import org.opendaylight.yangtools.yang.binding.contract.Naming;
31 import org.opendaylight.yangtools.yang.common.QName;
32 import org.opendaylight.yangtools.yang.common.QNameModule;
33 import org.opendaylight.yangtools.yang.common.YangConstants;
34 import org.slf4j.Logger;
35 import org.slf4j.LoggerFactory;
37 public final class BindingReflections {
38 private static final Logger LOG = LoggerFactory.getLogger(BindingReflections.class);
39 private static final LoadingCache<Class<?>, Optional<QName>> CLASS_TO_QNAME = CacheBuilder.newBuilder()
41 .expireAfterAccess(60, TimeUnit.SECONDS)
42 .build(new ClassToQNameLoader());
44 private BindingReflections() {
49 * Returns a QName associated to supplied type.
51 * @param dataType Data type class
52 * @return QName associated to supplied dataType. If dataType is Augmentation method does not return canonical
53 * QName, but QName with correct namespace revision, but virtual local name, since augmentations do not
54 * have name. May return null if QName is not present.
56 public static QName findQName(final Class<?> dataType) {
57 return CLASS_TO_QNAME.getUnchecked(dataType).orElse(null);
60 public static @NonNull QNameModule getQNameModule(final Class<?> clz) {
61 if (DataContainer.class.isAssignableFrom(clz) || BaseIdentity.class.isAssignableFrom(clz)
62 || Action.class.isAssignableFrom(clz)) {
63 return findQName(clz).getModule();
66 return getModuleInfo(clz).getName().getModule();
70 * Returns instance of {@link YangModuleInfo} of declaring model for specific class.
72 * @param cls data object class
73 * @return Instance of {@link YangModuleInfo} associated with model, from which this class was derived.
75 private static @NonNull YangModuleInfo getModuleInfo(final Class<?> cls) {
76 final String potentialClassName = Naming.getModelRootPackageName(cls.getPackage().getName()) + "."
77 + Naming.MODULE_INFO_CLASS_NAME;
78 final Class<?> moduleInfoClass;
80 moduleInfoClass = cls.getClassLoader().loadClass(potentialClassName);
81 } catch (ClassNotFoundException e) {
82 throw new IllegalStateException("Failed to load " + potentialClassName, e);
85 final Object infoInstance;
87 infoInstance = moduleInfoClass.getMethod("getInstance").invoke(null);
88 } catch (IllegalAccessException | InvocationTargetException | NoSuchMethodException e) {
89 throw new IllegalStateException("Failed to get instance of " + moduleInfoClass, e);
92 checkState(infoInstance instanceof YangModuleInfo, "Unexpected instance %s", infoInstance);
93 return (YangModuleInfo) infoInstance;
97 * Check if supplied class is derived from YANG model.
101 * @return true if class is derived from YANG model.
103 public static boolean isBindingClass(final Class<?> cls) {
104 if (DataContainer.class.isAssignableFrom(cls) || Augmentation.class.isAssignableFrom(cls)) {
107 return cls.getName().startsWith(Naming.PACKAGE_PREFIX);
111 * Checks if supplied class represents RPC Input / RPC Output.
114 * Class to be checked
115 * @return true if class represents RPC Input or RPC Output class.
118 static boolean isRpcType(final Class<? extends DataObject> targetType) {
119 return DataContainer.class.isAssignableFrom(targetType)
120 && !ChildOf.class.isAssignableFrom(targetType)
121 && !Notification.class.isAssignableFrom(targetType)
122 && (targetType.getName().endsWith("Input") || targetType.getName().endsWith("Output"));
125 private static final class ClassToQNameLoader extends CacheLoader<Class<?>, Optional<QName>> {
128 public Optional<QName> load(@SuppressWarnings("NullableProblems") final Class<?> key) throws Exception {
129 return resolveQNameNoCache(key);
133 * Tries to resolve QName for supplied class. Looks up for static field with name from constant
134 * {@link Naming#QNAME_STATIC_FIELD_NAME} and returns value if present. If field is not present uses
135 * {@link #computeQName(Class)} to compute QName for missing types.
137 private static Optional<QName> resolveQNameNoCache(final Class<?> key) {
141 field = key.getField(Naming.QNAME_STATIC_FIELD_NAME);
142 } catch (NoSuchFieldException e) {
143 LOG.debug("{} does not have a {} field, falling back to computation", key,
144 Naming.QNAME_STATIC_FIELD_NAME, e);
145 return Optional.of(computeQName(key));
148 final Object obj = field.get(null);
149 if (obj instanceof QName qname) {
150 return Optional.of(qname);
152 } catch (SecurityException | IllegalArgumentException | IllegalAccessException e) {
154 * It is safe to log this this exception on debug, since this method should not fail. Only failures are
155 * possible if the runtime / backing is inconsistent.
157 LOG.debug("Unexpected exception during extracting QName for {}", key, e);
159 return Optional.empty();
163 * Computes QName for supplied class. Namespace and revision are same as {@link YangModuleInfo} associated with
169 * <li>rpc input: local name is "input".
170 * <li>rpc output: local name is "output".
171 * <li>augmentation: local name is "module name".
175 * There is also fallback, if it is not possible to compute QName using following algorithm returns module
178 * @throws IllegalStateException If YangModuleInfo could not be resolved
179 * @throws IllegalArgumentException If supplied class was not derived from YANG model.
181 // FIXME: Extend this algorithm to also provide QName for YANG modeled simple types.
182 @SuppressWarnings({ "rawtypes", "unchecked" })
183 private static QName computeQName(final Class key) {
184 checkArgument(isBindingClass(key), "Supplied class %s is not derived from YANG.", key);
186 final QName module = getModuleInfo(key).getName();
187 if (Augmentation.class.isAssignableFrom(key)) {
189 } else if (isRpcType(key)) {
190 final String className = key.getSimpleName();
191 if (className.endsWith(Naming.RPC_OUTPUT_SUFFIX)) {
192 return YangConstants.operationOutputQName(module.getModule()).intern();
195 return YangConstants.operationInputQName(module.getModule()).intern();
199 * Fallback for Binding types which do not have QNAME field