binding/mdsal-binding-spec-util/src/main/java/org/opendaylight/mdsal/binding/spec/reflect/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.mdsal.binding.spec.reflect;
   9
  10 import static com.google.common.base.Preconditions.checkArgument;
  11 import static com.google.common.base.Preconditions.checkState;
  12
  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;
  36
  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()
  40             .weakKeys()
  41             .expireAfterAccess(60, TimeUnit.SECONDS)
  42             .build(new ClassToQNameLoader());
  43
  44     private BindingReflections() {
  45         // Hidden on purpose
  46     }
  47
  48     /**
  49      * Returns a QName associated to supplied type.
  50      *
  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.
  55      */
  56     public static QName findQName(final Class<?> dataType) {
  57         return CLASS_TO_QNAME.getUnchecked(dataType).orElse(null);
  58     }
  59
  60     public static @NonNull QName getQName(final BaseIdentity identity) {
  61         return CLASS_TO_QNAME.getUnchecked(identity.implementedInterface())
  62             .orElseThrow(() -> new IllegalStateException("Failed to resolve QName of " + identity));
  63     }
  64
  65     public static QNameModule getQNameModule(final Class<?> clz) {
  66         if (DataContainer.class.isAssignableFrom(clz) || BaseIdentity.class.isAssignableFrom(clz)
  67                 || Action.class.isAssignableFrom(clz)) {
  68             return findQName(clz).getModule();
  69         }
  70
  71         return getModuleInfo(clz).getName().getModule();
  72     }
  73
  74     /**
  75      * Returns instance of {@link YangModuleInfo} of declaring model for specific class.
  76      *
  77      * @param cls data object class
  78      * @return Instance of {@link YangModuleInfo} associated with model, from which this class was derived.
  79      */
  80     private static @NonNull YangModuleInfo getModuleInfo(final Class<?> cls) {
  81         final String potentialClassName = Naming.getModelRootPackageName(cls.getPackage().getName()) + "."
  82             + Naming.MODULE_INFO_CLASS_NAME;
  83         final Class<?> moduleInfoClass;
  84         try {
  85             moduleInfoClass = cls.getClassLoader().loadClass(potentialClassName);
  86         } catch (ClassNotFoundException e) {
  87             throw new IllegalStateException("Failed to load " + potentialClassName, e);
  88         }
  89
  90         final Object infoInstance;
  91         try {
  92             infoInstance = moduleInfoClass.getMethod("getInstance").invoke(null);
  93         } catch (IllegalAccessException | InvocationTargetException | NoSuchMethodException e) {
  94             throw new IllegalStateException("Failed to get instance of " + moduleInfoClass, e);
  95         }
  96
  97         checkState(infoInstance instanceof YangModuleInfo, "Unexpected instance %s", infoInstance);
  98         return (YangModuleInfo) infoInstance;
  99     }
 100
 101     /**
 102      * Check if supplied class is derived from YANG model.
 103      *
 104      * @param cls
 105      *            Class to check
 106      * @return true if class is derived from YANG model.
 107      */
 108     public static boolean isBindingClass(final Class<?> cls) {
 109         if (DataContainer.class.isAssignableFrom(cls) || Augmentation.class.isAssignableFrom(cls)) {
 110             return true;
 111         }
 112         return cls.getName().startsWith(Naming.PACKAGE_PREFIX);
 113     }
 114
 115     /**
 116      * Checks if supplied class represents RPC Input / RPC Output.
 117      *
 118      * @param targetType
 119      *            Class to be checked
 120      * @return true if class represents RPC Input or RPC Output class.
 121      */
 122     @VisibleForTesting
 123     static boolean isRpcType(final Class<? extends DataObject> targetType) {
 124         return DataContainer.class.isAssignableFrom(targetType)
 125                 && !ChildOf.class.isAssignableFrom(targetType)
 126                 && !Notification.class.isAssignableFrom(targetType)
 127                 && (targetType.getName().endsWith("Input") || targetType.getName().endsWith("Output"));
 128     }
 129
 130     private static final class ClassToQNameLoader extends CacheLoader<Class<?>, Optional<QName>> {
 131
 132         @Override
 133         public Optional<QName> load(@SuppressWarnings("NullableProblems") final Class<?> key) throws Exception {
 134             return resolveQNameNoCache(key);
 135         }
 136
 137         /**
 138          * Tries to resolve QName for supplied class. Looks up for static field with name from constant
 139          * {@link Naming#QNAME_STATIC_FIELD_NAME} and returns value if present. If field is not present uses
 140          * {@link #computeQName(Class)} to compute QName for missing types.
 141          */
 142         private static Optional<QName> resolveQNameNoCache(final Class<?> key) {
 143             try {
 144                 final Field field;
 145                 try {
 146                     field = key.getField(Naming.QNAME_STATIC_FIELD_NAME);
 147                 } catch (NoSuchFieldException e) {
 148                     LOG.debug("{} does not have a {} field, falling back to computation", key,
 149                         Naming.QNAME_STATIC_FIELD_NAME, e);
 150                     return Optional.of(computeQName(key));
 151                 }
 152
 153                 final Object obj = field.get(null);
 154                 if (obj instanceof QName qname) {
 155                     return Optional.of(qname);
 156                 }
 157             } catch (SecurityException | IllegalArgumentException | IllegalAccessException e) {
 158                 /*
 159                  * It is safe to log this this exception on debug, since this method should not fail. Only failures are
 160                  * possible if the runtime / backing is inconsistent.
 161                  */
 162                 LOG.debug("Unexpected exception during extracting QName for {}", key, e);
 163             }
 164             return Optional.empty();
 165         }
 166
 167         /**
 168          * Computes QName for supplied class. Namespace and revision are same as {@link YangModuleInfo} associated with
 169          * supplied class.
 170          *
 171          * <p>
 172          * If class is
 173          * <ul>
 174          * <li>rpc input: local name is "input".
 175          * <li>rpc output: local name is "output".
 176          * <li>augmentation: local name is "module name".
 177          * </ul>
 178          *
 179          * <p>
 180          * There is also fallback, if it is not possible to compute QName using following algorithm returns module
 181          * QName.
 182          *
 183          * @throws IllegalStateException If YangModuleInfo could not be resolved
 184          * @throws IllegalArgumentException If supplied class was not derived from YANG model.
 185          */
 186         // FIXME: Extend this algorithm to also provide QName for YANG modeled simple types.
 187         @SuppressWarnings({ "rawtypes", "unchecked" })
 188         private static QName computeQName(final Class key) {
 189             checkArgument(isBindingClass(key), "Supplied class %s is not derived from YANG.", key);
 190
 191             final QName module = getModuleInfo(key).getName();
 192             if (Augmentation.class.isAssignableFrom(key)) {
 193                 return module;
 194             } else if (isRpcType(key)) {
 195                 final String className = key.getSimpleName();
 196                 if (className.endsWith(Naming.RPC_OUTPUT_SUFFIX)) {
 197                     return YangConstants.operationOutputQName(module.getModule()).intern();
 198                 }
 199
 200                 return YangConstants.operationInputQName(module.getModule()).intern();
 201             }
 202
 203             /*
 204              * Fallback for Binding types which do not have QNAME field
 205              */
 206             return module;
 207         }
 208     }
 209 }