org.apache.nifi.nar

Class InstanceClassLoader

java.lang.Object

java.lang.ClassLoader

java.security.SecureClassLoader

java.net.URLClassLoader

org.apache.nifi.nar.AbstractNativeLibHandlingClassLoader

org.apache.nifi.nar.InstanceClassLoader

All Implemented Interfaces:

Closeable, AutoCloseable, OSUtil

Direct Known Subclasses:

SharedInstanceClassLoader

public class InstanceClassLoader
extends AbstractNativeLibHandlingClassLoader

Each processor, controller service, and reporting task will have an InstanceClassLoader. The InstanceClassLoader will either be an empty pass-through to the NARClassLoader, or will contain a copy of all the NAR's resources in the case of components that @RequireInstanceClassLoading.

Field Summary

Fields

Modifier and Type	Field and Description
private Set<URL>	additionalResourceUrls
private String	identifier
private String	instanceType
private Set<URL>	instanceUrls
private static org.slf4j.Logger	logger

Fields inherited from class org.apache.nifi.nar.AbstractNativeLibHandlingClassLoader

nativeLibDirList, nativeLibNameToPath

Fields inherited from interface org.apache.nifi.nar.OSUtil

OS

Constructor Summary

Constructors

Constructor and Description
InstanceClassLoader(String identifier, String type, Set<URL> instanceUrls, Set<URL> additionalResourceUrls, ClassLoader parent)
InstanceClassLoader(String identifier, String type, Set<URL> instanceUrls, Set<URL> additionalResourceUrls, Set<File> narNativeLibDirs, ClassLoader parent)

Method Summary

Modifier and Type	Method and Description
void	close()
private static URL[]	combineURLs(Set<URL> instanceUrls, Set<URL> additionalResourceUrls)
private URL	findResource(Set<URL> urls, String name)
URL	findResource(String name) Note: Normally URLClassLoader will only load resources that are inside JARs, or in directories, but many times we allow properties to specify specific files to add to the classpath.
Set<URL>	getAdditionalResourceUrls()
String	getIdentifier()
String	getInstanceType()
Set<URL>	getInstanceUrls()
private static List<File>	initNativeLibDirList(Set<File> narNativeLibDirs, Set<URL> additionalResourceUrls)

Methods inherited from class org.apache.nifi.nar.AbstractNativeLibHandlingClassLoader

createTempCopy, findLibrary, findLibrary, getJavaLibraryPath, getUsrLibDirs, toDir

Methods inherited from class java.net.URLClassLoader

addURL, definePackage, findClass, findResources, getPermissions, getResourceAsStream, getURLs, newInstance, newInstance

Methods inherited from class java.security.SecureClassLoader

defineClass, defineClass

Methods inherited from class java.lang.ClassLoader

clearAssertionStatus, defineClass, defineClass, defineClass, defineClass, definePackage, findLoadedClass, findSystemClass, getClassLoadingLock, getPackage, getPackages, getParent, getResource, getResources, getSystemClassLoader, getSystemResource, getSystemResourceAsStream, getSystemResources, loadClass, loadClass, registerAsParallelCapable, resolveClass, setClassAssertionStatus, setDefaultAssertionStatus, setPackageAssertionStatus, setSigners

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.nifi.nar.OSUtil

isOsLinuxUnix, isOsMac, isOsWindows

Field Detail

logger

private static final org.slf4j.Logger logger

identifier

private final String identifier

instanceType

private final String instanceType

instanceUrls

private final Set<URL> instanceUrls

additionalResourceUrls

private final Set<URL> additionalResourceUrls

Constructor Detail

InstanceClassLoader

public InstanceClassLoader(String identifier,
                           String type,
                           Set<URL> instanceUrls,
                           Set<URL> additionalResourceUrls,
                           ClassLoader parent)

Parameters:

identifier - the id of the component this ClassLoader was created for

instanceUrls - the urls for the instance, will either be empty or a copy of the NARs urls

additionalResourceUrls - the urls that came from runtime properties of the component

parent - the parent ClassLoader

InstanceClassLoader

public InstanceClassLoader(String identifier,
                           String type,
                           Set<URL> instanceUrls,
                           Set<URL> additionalResourceUrls,
                           Set<File> narNativeLibDirs,
                           ClassLoader parent)

Method Detail

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class URLClassLoader

Throws:

IOException

findResource

public URL findResource(String name)

Note: Normally URLClassLoader will only load resources that are inside JARs, or in directories, but many times we allow properties to specify specific files to add to the classpath. This allows those files to be found by checking the known URLs of the InstanceClassLoader, when the resource wasn't find in the parent hierarchy.

Overrides:

findResource in class URLClassLoader

findResource

private URL findResource(Set<URL> urls,
                         String name)

initNativeLibDirList

private static List<File> initNativeLibDirList(Set<File> narNativeLibDirs,
                                               Set<URL> additionalResourceUrls)

combineURLs

private static URL[] combineURLs(Set<URL> instanceUrls,
                                 Set<URL> additionalResourceUrls)

getIdentifier

public String getIdentifier()

getInstanceType

public String getInstanceType()

getInstanceUrls

public Set<URL> getInstanceUrls()

getAdditionalResourceUrls

public Set<URL> getAdditionalResourceUrls()