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