import static com.google.common.base.Preconditions.checkArgument;
import static com.google.common.base.Preconditions.checkState;
+import static java.util.Objects.requireNonNull;
import com.google.common.annotations.Beta;
import com.google.common.cache.CacheBuilder;
import com.google.common.collect.ImmutableSet.Builder;
import com.google.common.util.concurrent.ListenableFuture;
import java.lang.reflect.Field;
+import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
+import java.lang.reflect.Modifier;
+import java.lang.reflect.ParameterizedType;
import java.lang.reflect.Type;
import java.util.Arrays;
import java.util.HashMap;
import java.util.concurrent.TimeUnit;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
-import javax.annotation.RegEx;
+import org.checkerframework.checker.regex.qual.Regex;
+import org.eclipse.jdt.annotation.NonNull;
import org.opendaylight.mdsal.binding.spec.naming.BindingMapping;
import org.opendaylight.yangtools.util.ClassLoaderUtils;
import org.opendaylight.yangtools.yang.binding.Action;
private static final long EXPIRATION_TIME = 60;
- @RegEx
+ @Regex
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]|norev))";
private static final Pattern ROOT_PACKAGE_PATTERN = Pattern.compile(ROOT_PACKAGE_PATTERN_STRING);
.expireAfterAccess(EXPIRATION_TIME, TimeUnit.SECONDS)
.build(new ClassToQNameLoader());
+ private static final LoadingCache<ClassLoader, ImmutableSet<YangModuleInfo>> MODULE_INFO_CACHE =
+ CacheBuilder.newBuilder().weakKeys().weakValues().build(
+ new CacheLoader<ClassLoader, ImmutableSet<YangModuleInfo>>() {
+ @Override
+ public ImmutableSet<YangModuleInfo> load(final ClassLoader key) {
+ return loadModuleInfos(key);
+ }
+ });
+
private BindingReflections() {
- throw new UnsupportedOperationException("Utility class.");
+ // Hidden on purpose
}
/**
*/
public static Class<? extends Augmentable<?>> findAugmentationTarget(
final Class<? extends Augmentation<?>> augmentation) {
- return ClassLoaderUtils.findFirstGenericArgument(augmentation, Augmentation.class);
+ final Optional<Class<Augmentable<?>>> opt = ClassLoaderUtils.findFirstGenericArgument(augmentation,
+ Augmentation.class);
+ return opt.orElse(null);
}
/**
* @return Parent class, e.g. class of which the childClass is ChildOf.
*/
public static Class<?> findHierarchicalParent(final Class<? extends ChildOf<?>> childClass) {
- return ClassLoaderUtils.findFirstGenericArgument(childClass, ChildOf.class);
+ return ClassLoaderUtils.findFirstGenericArgument(childClass, ChildOf.class).orElse(null);
}
/**
*/
public static Class<?> findHierarchicalParent(final DataObject child) {
if (child instanceof ChildOf) {
- return ClassLoaderUtils.findFirstGenericArgument(child.implementedInterface(), ChildOf.class);
+ return ClassLoaderUtils.findFirstGenericArgument(child.implementedInterface(), ChildOf.class).orElse(null);
}
return null;
}
public static Optional<Class<?>> resolveRpcOutputClass(final Method targetMethod) {
checkState(isRpcMethod(targetMethod), "Supplied method is not a RPC invocation method");
Type futureType = targetMethod.getGenericReturnType();
- Type rpcResultType = ClassLoaderUtils.getFirstGenericParameter(futureType);
- Type rpcResultArgument = ClassLoaderUtils.getFirstGenericParameter(rpcResultType);
+ Type rpcResultType = ClassLoaderUtils.getFirstGenericParameter(futureType).orElse(null);
+ Type rpcResultArgument = ClassLoaderUtils.getFirstGenericParameter(rpcResultType).orElse(null);
if (rpcResultArgument instanceof Class && !Void.class.equals(rpcResultArgument)) {
return Optional.of((Class) rpcResultArgument);
}
return Optional.empty();
}
- public static QName getQName(final Class<? extends BaseIdentity> context) {
- return findQName(context);
+ public static @NonNull QName getQName(final Class<? extends BaseIdentity> bindingClass) {
+ final Optional<QName> qname = CLASS_TO_QNAME.getUnchecked(requireNonNull(bindingClass));
+ checkState(qname.isPresent(), "Failed to resolve QName of %s", bindingClass);
+ return qname.get();
}
/**
return match.group(0);
}
- @SuppressWarnings("checkstyle:illegalCatch")
public static QNameModule getQNameModule(final Class<?> clz) {
if (DataContainer.class.isAssignableFrom(clz) || BaseIdentity.class.isAssignableFrom(clz)
|| Action.class.isAssignableFrom(clz)) {
return findQName(clz).getModule();
}
- try {
- return BindingReflections.getModuleInfo(clz).getName().getModule();
- } catch (Exception e) {
- throw new IllegalStateException("Unable to get QName of defining model.", e);
- }
+
+ return getModuleInfo(clz).getName().getModule();
}
/**
* Returns instance of {@link YangModuleInfo} of declaring model for specific class.
*
* @param cls data object class
- * @return Instance of {@link YangModuleInfo} associated with model, from
- * which this class was derived.
+ * @return Instance of {@link YangModuleInfo} associated with model, from which this class was derived.
*/
- public static YangModuleInfo getModuleInfo(final Class<?> cls) throws Exception {
- checkArgument(cls != null);
- String packageName = getModelRootPackageName(cls.getPackage());
+ public static @NonNull YangModuleInfo getModuleInfo(final Class<?> cls) {
+ final String packageName = getModelRootPackageName(cls.getPackage());
final String potentialClassName = getModuleInfoClassName(packageName);
- return ClassLoaderUtils.callWithClassLoader(cls.getClassLoader(), () -> {
- Class<?> moduleInfoClass = Thread.currentThread().getContextClassLoader().loadClass(potentialClassName);
- return (YangModuleInfo) moduleInfoClass.getMethod("getInstance").invoke(null);
- });
+ final Class<?> moduleInfoClass;
+ try {
+ moduleInfoClass = cls.getClassLoader().loadClass(potentialClassName);
+ } catch (ClassNotFoundException e) {
+ throw new IllegalStateException("Failed to load " + potentialClassName, e);
+ }
+
+ final Object infoInstance;
+ try {
+ infoInstance = moduleInfoClass.getMethod("getInstance").invoke(null);
+ } catch (IllegalAccessException | InvocationTargetException | NoSuchMethodException e) {
+ throw new IllegalStateException("Failed to get instance of " + moduleInfoClass, e);
+ }
+
+ checkState(infoInstance instanceof YangModuleInfo, "Unexpected instance %s", infoInstance);
+ return (YangModuleInfo) infoInstance;
}
- public static String getModuleInfoClassName(final String packageName) {
+ public static @NonNull String getModuleInfoClassName(final String packageName) {
return packageName + "." + BindingMapping.MODULE_INFO_CLASS_NAME;
}
*
* @return Set of {@link YangModuleInfo} available for current classloader.
*/
- public static ImmutableSet<YangModuleInfo> loadModuleInfos() {
+ public static @NonNull ImmutableSet<YangModuleInfo> loadModuleInfos() {
return loadModuleInfos(Thread.currentThread().getContextClassLoader());
}
* When {@link YangModuleInfo} is available, all dependencies are recursively collected into returning set by
* collecting results of {@link YangModuleInfo#getImportedModules()}.
*
- * @param loader
- * Classloader for which {@link YangModuleInfo} should be
- * retrieved.
+ * <p>
+ * Consider using {@link #cacheModuleInfos(ClassLoader)} if the classloader is known to be immutable.
+ *
+ * @param loader Classloader for which {@link YangModuleInfo} should be retrieved.
* @return Set of {@link YangModuleInfo} available for supplied classloader.
*/
- public static ImmutableSet<YangModuleInfo> loadModuleInfos(final ClassLoader loader) {
+ public static @NonNull ImmutableSet<YangModuleInfo> loadModuleInfos(final ClassLoader loader) {
Builder<YangModuleInfo> moduleInfoSet = ImmutableSet.builder();
ServiceLoader<YangModelBindingProvider> serviceLoader = ServiceLoader.load(YangModelBindingProvider.class,
loader);
return moduleInfoSet.build();
}
+ /**
+ * Loads {@link YangModuleInfo} instances available on supplied {@link ClassLoader}, assuming the set of available
+ * information does not change. Subsequent accesses may return cached values.
+ *
+ * <p>
+ * {@link YangModuleInfo} are discovered using {@link ServiceLoader} for {@link YangModelBindingProvider}.
+ * {@link YangModelBindingProvider} are simple classes which holds only pointers to actual instance
+ * {@link YangModuleInfo}.
+ *
+ * <p>
+ * When {@link YangModuleInfo} is available, all dependencies are recursively collected into returning set by
+ * collecting results of {@link YangModuleInfo#getImportedModules()}.
+ *
+ * @param loader Class loader for which {@link YangModuleInfo} should be retrieved.
+ * @return Set of {@link YangModuleInfo} available for supplied classloader.
+ */
+ @Beta
+ public static @NonNull ImmutableSet<YangModuleInfo> cacheModuleInfos(final ClassLoader loader) {
+ return MODULE_INFO_CACHE.getUnchecked(loader);
+ }
+
private static void collectYangModuleInfo(final YangModuleInfo moduleInfo,
final Builder<YangModuleInfo> moduleInfoSet) {
moduleInfoSet.add(moduleInfo);
/**
* Scans supplied class and returns an iterable of all data children classes.
*
- * @param type
- * YANG Modeled Entity derived from DataContainer
+ * @param type YANG Modeled Entity derived from DataContainer
* @return Iterable of all data children, which have YANG modeled entity
*/
- public static Map<Class<?>, Method> getChildrenClassToMethod(final Class<?> type) {
- return getChildrenClassToMethod(type, BindingMapping.GETTER_PREFIX);
+ public static Map<Class<? extends DataContainer>, Method> getChildrenClassToMethod(final Class<?> type) {
+ return getChildClassToMethod(type, BindingMapping.GETTER_PREFIX);
+ }
+
+ @Beta
+ public static Map<Class<? extends DataContainer>, Method> getChildrenClassToNonnullMethod(final Class<?> type) {
+ return getChildClassToMethod(type, BindingMapping.NONNULL_PREFIX);
}
- private static Map<Class<?>, Method> getChildrenClassToMethod(final Class<?> type, final String prefix) {
+ private static Map<Class<? extends DataContainer>, Method> getChildClassToMethod(final Class<?> type,
+ final String prefix) {
checkArgument(type != null, "Target type must not be null");
checkArgument(DataContainer.class.isAssignableFrom(type), "Supplied type %s must be derived from DataContainer",
type);
- Map<Class<?>, Method> ret = new HashMap<>();
+ Map<Class<? extends DataContainer>, Method> ret = new HashMap<>();
for (Method method : type.getMethods()) {
Optional<Class<? extends DataContainer>> entity = getYangModeledReturnType(method, prefix);
if (entity.isPresent()) {
return ret;
}
- @Beta
- public static Map<Class<?>, Method> getChildrenClassToNonnullMethod(final Class<?> type) {
- return getChildrenClassToMethod(type, BindingMapping.NONNULL_PREFIX);
- }
-
- @SuppressWarnings({ "unchecked", "rawtypes", "checkstyle:illegalCatch" })
private static Optional<Class<? extends DataContainer>> getYangModeledReturnType(final Method method,
final String prefix) {
final String methodName = method.getName();
return Optional.empty();
}
- Class returnType = method.getReturnType();
+ final Class<?> returnType = method.getReturnType();
if (DataContainer.class.isAssignableFrom(returnType)) {
- return Optional.of(returnType);
+ return optionalDataContainer(returnType);
+ } else if (List.class.isAssignableFrom(returnType)) {
+ return getYangModeledReturnType(method, 0);
+ } else if (Map.class.isAssignableFrom(returnType)) {
+ return getYangModeledReturnType(method, 1);
}
- if (List.class.isAssignableFrom(returnType)) {
- try {
- return ClassLoaderUtils.callWithClassLoader(method.getDeclaringClass().getClassLoader(), () -> {
- Type listResult = ClassLoaderUtils.getFirstGenericParameter(method.getGenericReturnType());
- if (listResult instanceof Class && DataContainer.class.isAssignableFrom((Class) listResult)) {
- return Optional.of((Class) listResult);
- }
- return Optional.empty();
- });
- } catch (Exception e) {
- /*
- * It is safe to log this this exception on debug, since this
- * method should not fail. Only failures are possible if the
- * runtime / backing.
- */
- LOG.debug("Unable to find YANG modeled return type for {}", method, e);
+ return Optional.empty();
+ }
+
+ @SuppressWarnings("checkstyle:illegalCatch")
+ private static Optional<Class<? extends DataContainer>> getYangModeledReturnType(final Method method,
+ final int parameterOffset) {
+ try {
+ return ClassLoaderUtils.callWithClassLoader(method.getDeclaringClass().getClassLoader(),
+ () -> genericParameter(method.getGenericReturnType(), parameterOffset)
+ .flatMap(result -> result instanceof Class ? optionalCast((Class<?>) result) : Optional.empty()));
+ } catch (Exception e) {
+ /*
+ * It is safe to log this this exception on debug, since this
+ * method should not fail. Only failures are possible if the
+ * runtime / backing.
+ */
+ LOG.debug("Unable to find YANG modeled return type for {}", method, e);
+ }
+ return Optional.empty();
+ }
+
+ private static Optional<Class<? extends DataContainer>> optionalCast(final Class<?> type) {
+ return DataContainer.class.isAssignableFrom(type) ? optionalDataContainer(type) : Optional.empty();
+ }
+
+ private static Optional<Class<? extends DataContainer>> optionalDataContainer(final Class<?> type) {
+ return Optional.of(type.asSubclass(DataContainer.class));
+ }
+
+ private static Optional<Type> genericParameter(final Type type, final int offset) {
+ if (type instanceof ParameterizedType) {
+ final Type[] parameters = ((ParameterizedType) type).getActualTypeArguments();
+ if (parameters.length > offset) {
+ return Optional.of(parameters[offset]);
}
}
return Optional.empty();
* @throws IllegalArgumentException If supplied class was not derived from YANG model.
*/
// FIXME: Extend this algorithm to also provide QName for YANG modeled simple types.
- @SuppressWarnings({ "rawtypes", "unchecked", "checkstyle:illegalCatch" })
+ @SuppressWarnings({ "rawtypes", "unchecked" })
private static QName computeQName(final Class key) {
checkArgument(isBindingClass(key), "Supplied class %s is not derived from YANG.", key);
- YangModuleInfo moduleInfo;
- try {
- moduleInfo = getModuleInfo(key);
- } catch (Exception e) {
- throw new IllegalStateException("Unable to get QName for " + key + ". YangModuleInfo was not found.",
- e);
- }
- final QName module = moduleInfo.getName();
+ final QName module = getModuleInfo(key).getName();
if (Augmentation.class.isAssignableFrom(key)) {
return module;
} else if (isRpcType(key)) {
}
}
- /**
- * Extracts augmentation from Binding DTO field using reflection.
- *
- * @param input
- * Instance of DataObject which is augmentable and may contain
- * augmentation
- * @return Map of augmentations if read was successful, otherwise empty map.
- */
- public static Map<Class<? extends Augmentation<?>>, Augmentation<?>> getAugmentations(final Augmentable<?> input) {
- return AugmentationFieldGetter.getGetter(input.getClass()).getAugmentations(input);
- }
-
/**
* Determines if two augmentation classes or case classes represents same
* data.
* Class which should be used at particular subtree
* @return true if and only if classes represents same data.
*/
+ // FIXME: this really should live in BindingRuntimeTypes and should not be based on reflection. The only user is
+ // binding-dom-codec and the logic could easily be performed on GeneratedType instead. For a particular
+ // world this boils down to a matrix, which can be calculated either on-demand or when we create
+ // BindingRuntimeTypes. Achieving that will bring us one step closer to being able to have a pre-compiled
+ // Binding Runtime.
@SuppressWarnings({ "rawtypes", "unchecked" })
public static boolean isSubstitutionFor(final Class potential, final Class target) {
Set<Class> subImplemented = new HashSet<>(Arrays.asList(potential.getInterfaces()));
return false;
}
for (Method potentialMethod : potential.getMethods()) {
+ if (Modifier.isStatic(potentialMethod.getModifiers())) {
+ // Skip any static methods, as we are not interested in those
+ continue;
+ }
+
try {
Method targetMethod = target.getMethod(potentialMethod.getName(), potentialMethod.getParameterTypes());
if (!potentialMethod.getReturnType().equals(targetMethod.getReturnType())) {
Code Review / mdsal.git / blobdiff