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