/* * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Public License v1.0 which accompanies this distribution, * and is available at http://www.eclipse.org/legal/epl-v10.html */ package org.opendaylight.yangtools.util; import static java.util.Objects.requireNonNull; import com.google.common.annotations.Beta; import com.google.common.base.Joiner; import com.google.common.base.Splitter; import com.google.common.collect.Iterables; import java.lang.reflect.ParameterizedType; import java.lang.reflect.Type; import java.util.List; import java.util.Optional; import java.util.concurrent.Callable; import java.util.function.Function; import java.util.function.Supplier; import org.eclipse.jdt.annotation.NonNull; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Utility methods for working with ClassLoaders and classes. */ public final class ClassLoaderUtils { private static final Logger LOG = LoggerFactory.getLogger(ClassLoaderUtils.class); private static final Joiner DOT_JOINER = Joiner.on("."); private static final Splitter DOT_SPLITTER = Splitter.on('.'); private ClassLoaderUtils() { // Hidden on purpose } /** * Immediately call {@link Function#apply(Object)} with provided {@link ClassLoader}. This method safely switches * the thread's Thread Context Class Loader to the specified class loader for the duration of execution of that * method. * * @param the type of the input to the function * @param the type of the result of the function * @param cls {@link ClassLoader} to be used. * @param function Function to be applied. * @param input Function input * @return Result of function invocation. * @throws NullPointerException if class loader or function is null */ @Beta public static R applyWithClassLoader(final @NonNull ClassLoader cls, final @NonNull Function function, final T input) { final Thread currentThread = Thread.currentThread(); final ClassLoader oldCls = currentThread.getContextClassLoader(); currentThread.setContextClassLoader(requireNonNull(cls)); try { return requireNonNull(function).apply(input); } finally { currentThread.setContextClassLoader(oldCls); } } /** * Immediately call {@link Callable#call()} with provided {@link ClassLoader}. This method safely switches * the thread's Thread Context Class Loader to the specified class loader for the duration of execution of that * method. * * @param the result type of the callable * @param cls {@link ClassLoader} to be used. * @param callable Function to be executed. * @return Result of callable invocation. * @throws NullPointerException if class loader or callable is null * @throws Exception if the callable fails */ @Beta public static V callWithClassLoader(final @NonNull ClassLoader cls, final @NonNull Callable callable) throws Exception { final Thread currentThread = Thread.currentThread(); final ClassLoader oldCls = currentThread.getContextClassLoader(); currentThread.setContextClassLoader(requireNonNull(cls)); try { return requireNonNull(callable).call(); } finally { currentThread.setContextClassLoader(oldCls); } } /** * Immediately call {@link Supplier#get()} with provided {@link ClassLoader}. This method safely switches * the thread's Thread Context Class Loader to the specified class loader for the duration of execution of that * method. * * @param the result type of the supplier * @param cls {@link ClassLoader} to be used. * @param supplier Function to be executed. * @return Result of supplier invocation. * @throws NullPointerException if class loader or supplier is null */ @Beta public static V getWithClassLoader(final @NonNull ClassLoader cls, final @NonNull Supplier supplier) { final Thread currentThread = Thread.currentThread(); final ClassLoader oldCls = currentThread.getContextClassLoader(); currentThread.setContextClassLoader(requireNonNull(cls)); try { return requireNonNull(supplier).get(); } finally { currentThread.setContextClassLoader(oldCls); } } /** * Immediately call {@link Runnable#run()} with provided {@link ClassLoader}. This method safely switches * the thread's Thread Context Class Loader to the specified class loader for the duration of execution of that * method. * * @param cls {@link ClassLoader} to be used. * @param runnable Function to be executed. * @throws NullPointerException if class loader or runnable is null */ @Beta public static void runWithClassLoader(final @NonNull ClassLoader cls, final @NonNull Runnable runnable) { final Thread currentThread = Thread.currentThread(); final ClassLoader oldCls = currentThread.getContextClassLoader(); currentThread.setContextClassLoader(requireNonNull(cls)); try { requireNonNull(runnable).run(); } finally { currentThread.setContextClassLoader(oldCls); } } /** * Loads class using this supplied classloader. * * @param cls class loader * @param name String name of class. * @return Loaded class * @throws ClassNotFoundException if the class cannot be loaded * @throws NullPointerException if any argument is null */ public static Class loadClass(final ClassLoader cls, final String name) throws ClassNotFoundException { if ("byte[]".equals(name)) { return byte[].class; } if ("char[]".equals(name)) { return char[].class; } return loadClass0(cls, name); } private static Class loadClass0(final ClassLoader cls, final String name) throws ClassNotFoundException { try { return cls.loadClass(name); } catch (final ClassNotFoundException e) { final List components = DOT_SPLITTER.splitToList(name); if (isInnerClass(components)) { final int length = components.size() - 1; final String outerName = DOT_JOINER.join(Iterables.limit(components, length)); final String innerName = outerName + "$" + components.get(length); return cls.loadClass(innerName); } throw e; } } private static boolean isInnerClass(final List components) { final int length = components.size(); if (length < 2) { return false; } final String potentialOuter = components.get(length - 2); if (potentialOuter == null) { return false; } return Character.isUpperCase(potentialOuter.charAt(0)); } public static Class loadClassWithTCCL(final String name) throws ClassNotFoundException { final Thread thread = Thread.currentThread(); final ClassLoader tccl = thread.getContextClassLoader(); if (tccl == null) { throw new ClassNotFoundException("Thread " + thread + " does not have a Context Class Loader, cannot load " + name); } return loadClass(tccl, name); } public static Optional> tryToLoadClassWithTCCL(final String fullyQualifiedClassName) { final Thread thread = Thread.currentThread(); final ClassLoader tccl = thread.getContextClassLoader(); if (tccl == null) { LOG.debug("Thread {} does not have a Context Class Loader, not loading class {}", thread, fullyQualifiedClassName); return Optional.empty(); } try { return Optional.of(loadClass(tccl, fullyQualifiedClassName)); } catch (final ClassNotFoundException e) { LOG.debug("Failed to load class {}", fullyQualifiedClassName, e); return Optional.empty(); } } @SuppressWarnings("unchecked") public static Optional> findFirstGenericArgument(final Class scannedClass, final Class genericType) { return getWithClassLoader(scannedClass.getClassLoader(), () -> { return findParameterizedType(scannedClass, genericType) .map(ptype -> (Class

) ptype.getActualTypeArguments()[0]); }); } /** * Find the parameterized instantiation of a particular interface implemented by a class. * * @param subclass Implementing class * @param genericType Interface to search for * @return Parameterized interface as implemented by the class, if present */ public static Optional findParameterizedType(final Class subclass, final Class genericType) { requireNonNull(genericType); for (final Type type : subclass.getGenericInterfaces()) { if (type instanceof ParameterizedType) { final ParameterizedType ptype = (ParameterizedType) type; if (genericType.equals(ptype.getRawType())) { return Optional.of(ptype); } } } LOG.debug("Class {} does not declare interface {}", subclass, genericType); return Optional.empty(); } /** * Extract the first generic type argument for a Type. If the type is not parameterized, this method returns empty. * * @param type Type to examine * @return First generic type argument, if present * @throws NullPointerException if {@code type} is null */ public static Optional getFirstGenericParameter(final Type type) { requireNonNull(type); return type instanceof ParameterizedType ? Optional.of(((ParameterizedType) type).getActualTypeArguments()[0]) : Optional.empty(); } }