| /* |
| * Licensed to the Apache Software Foundation (ASF) under one or more |
| * contributor license agreements. See the NOTICE file distributed with |
| * this work for additional information regarding copyright ownership. |
| * The ASF licenses this file to You under the Apache License, Version 2.0 |
| * (the "License"); you may not use this file except in compliance with |
| * the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| package org.apache.nifi.nar; |
| |
| import org.apache.nifi.authentication.LoginIdentityProvider; |
| import org.apache.nifi.authorization.Authorizer; |
| import org.apache.nifi.components.Validator; |
| import org.apache.nifi.controller.ControllerService; |
| import org.apache.nifi.controller.repository.ContentRepository; |
| import org.apache.nifi.controller.repository.FlowFileRepository; |
| import org.apache.nifi.controller.repository.FlowFileSwapManager; |
| import org.apache.nifi.controller.status.history.ComponentStatusRepository; |
| import org.apache.nifi.flowfile.FlowFilePrioritizer; |
| import org.apache.nifi.processor.Processor; |
| import org.apache.nifi.processor.io.InputStreamCallback; |
| import org.apache.nifi.processor.io.OutputStreamCallback; |
| import org.apache.nifi.processor.io.StreamCallback; |
| import org.apache.nifi.provenance.ProvenanceRepository; |
| import org.apache.nifi.reporting.ReportingTask; |
| import org.apache.nifi.util.NiFiProperties; |
| |
| import java.io.IOException; |
| import java.io.InputStream; |
| import java.lang.reflect.Constructor; |
| import java.lang.reflect.InvocationTargetException; |
| import java.net.URL; |
| import java.net.URLClassLoader; |
| import java.util.ArrayList; |
| import java.util.Enumeration; |
| import java.util.List; |
| |
| /** |
| * THREAD SAFE |
| */ |
| public class NarThreadContextClassLoader extends URLClassLoader { |
| |
| static final ContextSecurityManager contextSecurityManager = new ContextSecurityManager(); |
| private final ClassLoader forward = ClassLoader.getSystemClassLoader(); |
| private static final List<Class<?>> narSpecificClasses = new ArrayList<>(); |
| |
| static { |
| narSpecificClasses.add(Processor.class); |
| narSpecificClasses.add(FlowFilePrioritizer.class); |
| narSpecificClasses.add(ReportingTask.class); |
| narSpecificClasses.add(Validator.class); |
| narSpecificClasses.add(InputStreamCallback.class); |
| narSpecificClasses.add(OutputStreamCallback.class); |
| narSpecificClasses.add(StreamCallback.class); |
| narSpecificClasses.add(ControllerService.class); |
| narSpecificClasses.add(Authorizer.class); |
| narSpecificClasses.add(LoginIdentityProvider.class); |
| narSpecificClasses.add(ProvenanceRepository.class); |
| narSpecificClasses.add(ComponentStatusRepository.class); |
| narSpecificClasses.add(FlowFileRepository.class); |
| narSpecificClasses.add(FlowFileSwapManager.class); |
| narSpecificClasses.add(ContentRepository.class); |
| } |
| |
| private NarThreadContextClassLoader() { |
| super(new URL[0]); |
| } |
| |
| @Override |
| public void clearAssertionStatus() { |
| lookupClassLoader().clearAssertionStatus(); |
| } |
| |
| @Override |
| public URL getResource(String name) { |
| return lookupClassLoader().getResource(name); |
| } |
| |
| @Override |
| public InputStream getResourceAsStream(String name) { |
| return lookupClassLoader().getResourceAsStream(name); |
| } |
| |
| @Override |
| public Enumeration<URL> getResources(String name) throws IOException { |
| return lookupClassLoader().getResources(name); |
| } |
| |
| @Override |
| public Class<?> loadClass(String name) throws ClassNotFoundException { |
| return lookupClassLoader().loadClass(name); |
| } |
| |
| @Override |
| public void setClassAssertionStatus(String className, boolean enabled) { |
| lookupClassLoader().setClassAssertionStatus(className, enabled); |
| } |
| |
| @Override |
| public void setDefaultAssertionStatus(boolean enabled) { |
| lookupClassLoader().setDefaultAssertionStatus(enabled); |
| } |
| |
| @Override |
| public void setPackageAssertionStatus(String packageName, boolean enabled) { |
| lookupClassLoader().setPackageAssertionStatus(packageName, enabled); |
| } |
| |
| private ClassLoader lookupClassLoader() { |
| final Class<?>[] classStack = contextSecurityManager.getExecutionStack(); |
| |
| for (Class<?> currentClass : classStack) { |
| final Class<?> narClass = findNarClass(currentClass); |
| if (narClass != null) { |
| final ClassLoader desiredClassLoader = narClass.getClassLoader(); |
| |
| // When new Threads are created, the new Thread inherits the ClassLoaderContext of |
| // the caller. However, the call stack of that new Thread may not trace back to any NiFi-specific |
| // code. Therefore, the NarThreadContextClassLoader will be unable to find the appropriate NAR |
| // ClassLoader. As a result, we want to set the ContextClassLoader to the NAR ClassLoader that |
| // contains the class or resource that we are looking for. |
| // This locks the current Thread into the appropriate NAR ClassLoader Context. The framework will change |
| // the ContextClassLoader back to the NarThreadContextClassLoader as appropriate via the |
| // {@link FlowEngine.beforeExecute(Thread, Runnable)} and |
| // {@link FlowEngine.afterExecute(Thread, Runnable)} methods. |
| if (desiredClassLoader instanceof NarClassLoader) { |
| Thread.currentThread().setContextClassLoader(desiredClassLoader); |
| } |
| return desiredClassLoader; |
| } |
| } |
| return forward; |
| } |
| |
| private Class<?> findNarClass(final Class<?> cls) { |
| for (final Class<?> narClass : narSpecificClasses) { |
| if (narClass.isAssignableFrom(cls)) { |
| return cls; |
| } else if (cls.getEnclosingClass() != null) { |
| return findNarClass(cls.getEnclosingClass()); |
| } |
| } |
| |
| return null; |
| } |
| |
| private static class SingletonHolder { |
| |
| public static final NarThreadContextClassLoader instance = new NarThreadContextClassLoader(); |
| } |
| |
| public static NarThreadContextClassLoader getInstance() { |
| return SingletonHolder.instance; |
| } |
| |
| static class ContextSecurityManager extends SecurityManager { |
| |
| Class<?>[] getExecutionStack() { |
| return getClassContext(); |
| } |
| } |
| |
| /** |
| * Constructs an instance of the given type using either default no args |
| * constructor or a constructor which takes a NiFiProperties object |
| * (preferred). |
| * |
| * @param <T> the type to create an instance for |
| * @param implementationClassName the implementation class name |
| * @param typeDefinition the type definition |
| * @param nifiProperties the NiFiProperties instance |
| * @return constructed instance |
| * @throws InstantiationException if there is an error instantiating the class |
| * @throws IllegalAccessException if there is an error accessing the type |
| * @throws ClassNotFoundException if the class cannot be found |
| */ |
| public static <T> T createInstance(final String implementationClassName, final Class<T> typeDefinition, final NiFiProperties nifiProperties) |
| throws InstantiationException, IllegalAccessException, ClassNotFoundException { |
| final ClassLoader originalClassLoader = Thread.currentThread().getContextClassLoader(); |
| Thread.currentThread().setContextClassLoader(NarThreadContextClassLoader.getInstance()); |
| try { |
| final ClassLoader detectedClassLoaderForType = ExtensionManager.getClassLoader(implementationClassName); |
| final Class<?> rawClass; |
| if (detectedClassLoaderForType == null) { |
| // try to find from the current class loader |
| rawClass = Class.forName(implementationClassName); |
| } else { |
| // try to find from the registered classloader for that type |
| rawClass = Class.forName(implementationClassName, true, ExtensionManager.getClassLoader(implementationClassName)); |
| } |
| |
| Thread.currentThread().setContextClassLoader(detectedClassLoaderForType); |
| final Class<?> desiredClass = rawClass.asSubclass(typeDefinition); |
| if(nifiProperties == null){ |
| return typeDefinition.cast(desiredClass.newInstance()); |
| } |
| Constructor<?> constructor = null; |
| |
| try { |
| constructor = desiredClass.getConstructor(NiFiProperties.class); |
| } catch (NoSuchMethodException nsme) { |
| try { |
| constructor = desiredClass.getConstructor(); |
| } catch (NoSuchMethodException nsme2) { |
| throw new IllegalStateException("Failed to find constructor which takes NiFiProperties as argument as well as the default constructor on " |
| + desiredClass.getName(), nsme2); |
| } |
| } |
| try { |
| if (constructor.getParameterTypes().length == 0) { |
| return typeDefinition.cast(constructor.newInstance()); |
| } else { |
| return typeDefinition.cast(constructor.newInstance(nifiProperties)); |
| } |
| } catch (InvocationTargetException ite) { |
| throw new IllegalStateException("Failed to instantiate a component due to (see target exception)", ite); |
| } |
| } finally { |
| Thread.currentThread().setContextClassLoader(originalClassLoader); |
| } |
| } |
| } |