Package io.github.classgraph.classloaderhandler

Class JPMSClassLoaderHandler

java.lang.Object

io.github.classgraph.classloaderhandler.JPMSClassLoaderHandler

All Implemented Interfaces:

ClassLoaderHandler

public class JPMSClassLoaderHandler
extends Object
implements ClassLoaderHandler

A placeloader ClassLoaderHandler that matches Java 9+ classloaders, but does not attempt to extract URLs from them (module scanning uses a different mechanism from classpath scanning).

Nested Class Summary

Nested classes/interfaces inherited from interface io.github.classgraph.ClassLoaderHandler

ClassLoaderHandler.DelegationOrder

Constructor Summary

Constructors

Constructor	Description
JPMSClassLoaderHandler()

Method Summary

Modifier and Type	Method	Description
ClassLoaderHandler.DelegationOrder	getDelegationOrder(ClassLoader classLoaderInstance)	The delegation order configuration for a given ClassLoader instance (this is usually PARENT_FIRST for most ClassLoaders, since you don't generally want to be able to override system classes with user classes, but this can be overridden by some ClassLoaders, e.g.
ClassLoader	getEmbeddedClassLoader(ClassLoader outerClassLoaderInstance)	If this ClassLoader delegates directly to an embedded classloader instance, return it here, otherwise return null.
void	handle(ScanSpec scanSpec, ClassLoader classLoader, ClasspathOrder classpathOrderOut, LogNode log)	Determine if a given ClassLoader can be handled (meaning that its classpath elements can be extracted from it), and if it can, extract the classpath elements from the ClassLoader and register them with the ClasspathFinder using classpathFinder.addClasspathElement(pathElement) or classpathFinder.addClasspathElements(path).
String[]	handledClassLoaders()	The fully-qualified names of handled classloader classes.

Methods inherited from class java.lang.Object

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

Constructor Detail

JPMSClassLoaderHandler

public JPMSClassLoaderHandler()

Method Detail

handledClassLoaders

public String[] handledClassLoaders()

Description copied from interface: ClassLoaderHandler

The fully-qualified names of handled classloader classes.

Specified by:

handledClassLoaders in interface ClassLoaderHandler

Returns:

The names of ClassLoaders that this ClassLoaderHandler can handle.

getEmbeddedClassLoader

public ClassLoader getEmbeddedClassLoader(ClassLoader outerClassLoaderInstance)

Description copied from interface: ClassLoaderHandler

If this ClassLoader delegates directly to an embedded classloader instance, return it here, otherwise return null.

Specified by:

getEmbeddedClassLoader in interface ClassLoaderHandler

Parameters:

outerClassLoaderInstance - The outer ClassLoader instance to check for an embedded ClassLoader.

Returns:

The embedded ClassLoader to use instead of the outer ClassLoader, or null to use the outer ClassLoader.

getDelegationOrder

public ClassLoaderHandler.DelegationOrder getDelegationOrder(ClassLoader classLoaderInstance)

Description copied from interface: ClassLoaderHandler

The delegation order configuration for a given ClassLoader instance (this is usually PARENT_FIRST for most ClassLoaders, since you don't generally want to be able to override system classes with user classes, but this can be overridden by some ClassLoaders, e.g. WebSphere).

Specified by:

getDelegationOrder in interface ClassLoaderHandler

Parameters:

classLoaderInstance - The ClassLoader to get the delegation order for.

Returns:

The delegation order for the given ClassLoader.

handle

public void handle(ScanSpec scanSpec,
                   ClassLoader classLoader,
                   ClasspathOrder classpathOrderOut,
                   LogNode log)

Description copied from interface: ClassLoaderHandler

Determine if a given ClassLoader can be handled (meaning that its classpath elements can be extracted from it), and if it can, extract the classpath elements from the ClassLoader and register them with the ClasspathFinder using classpathFinder.addClasspathElement(pathElement) or classpathFinder.addClasspathElements(path).

Specified by:

handle in interface ClassLoaderHandler

Parameters:

scanSpec - the scanning specification, in case it is needed, e.g. this could be used to reduce the number of classpath elements returned in cases where it is very costly for a given classloader to return the entire classpath. (The ScanSpec can be safely ignored, however, and the returned paths will be filtered by ClassGraph.)

classLoader - The ClassLoader class to attempt to handle. If you can't directly use instanceof (because you are using introspection so that your ClassLoaderHandler implementation can be added to the upstream ClassGraph project), you should iterate through the ClassLoader's superclass lineage to ensure subclasses of the target ClassLoader are correctly detected.

classpathOrderOut - The ClasspathOrder to register any discovered classpath elements with.

log - A logger instance -- if this is non-null, write debug information using log.log("message").