jodd.util.cl

Class ExtendedURLClassLoader

java.lang.Object

java.lang.ClassLoader

java.security.SecureClassLoader

java.net.URLClassLoader

jodd.util.cl.ExtendedURLClassLoader

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class ExtendedURLClassLoader
extends java.net.URLClassLoader

Class loader that offers two loading strategies: parent-first and parent-last. The strategy defines the class loading order between this classloader and parent class loader; i.e. defines the first class loader to be used for loading classes. Extends URLClassLoader to provide just minimal set of modifications.

Either way, you can specify wildcard rules to force some behavior - like loading some package/class exclusively with specific loader. There are the following groups:

• parent-only - classes will be loaded only with parent classloader.
• loader-only - classes will be loaded only with this loader.
• default - classes will be loaded as specified by strategy (no need to define).

The order of matching is also set by loading strategy. For parent-first strategy, loader group rules will be checked first. For parent-last strategy, parent group rules will be checked first.

By default, the list of parent-only group is populated with JavaInfo.getJrePackages() JRE packages}.

When parent-last strategy is used, be aware how you use ClassLoaderUtil as it is designed to follow parent-first strategy. Use with caution as setting parent-last violates the class loader hierarchy.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ExtendedURLClassLoader.Loading

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String[]	loaderOnlyRules
protected boolean	matchResourcesAsPackages
protected java.lang.ClassLoader	parentClassLoader
protected boolean	parentFirst
protected java.lang.String[]	parentOnlyRules

Constructor Summary

Constructors

Constructor and Description
ExtendedURLClassLoader(java.net.URL[] classpath, java.lang.ClassLoader parent, boolean parentFirst)
ExtendedURLClassLoader(java.net.URL[] classpath, java.lang.ClassLoader parent, boolean parentFirst, boolean excludeJrePackagesFromLoader) Creates class loader with given loading strategy.

Method Summary

Modifier and Type	Method and Description
void	addLoaderOnlyRules(java.lang.String... packages) Adds loader-only rules for classes which must be loaded using this loader.
void	addParentOnlyRules(java.lang.String... packages) Adds parent only rules for classes which must be loaded on the parent loader.
java.net.URL	getResource(java.lang.String resourceName) Returns a resource using parent-first or parent-last strategy.
java.util.Enumeration<java.net.URL>	getResources(java.lang.String resourceName)
protected boolean	isMatchingRules(java.lang.String name, java.lang.String... rules) Returns true if class or resource name matches at least one package rule from the list.
protected java.lang.Class<?>	loadClass(java.lang.String className, boolean resolve) Loads class using parent-first or parent-last strategy.
protected ExtendedURLClassLoader.Loading	resolveLoading(boolean parentFirstStrategy, java.lang.String className) Resolves loading rules.
protected ExtendedURLClassLoader.Loading	resolveResourceLoading(boolean parentFirstStrategy, java.lang.String resourceName) Resolves resources.
void	setMatchResourcesAsPackages(boolean matchResourcesAsPackages) When set, resources will be matched in the same way as packages.

Methods inherited from class java.net.URLClassLoader

addURL, close, definePackage, findClass, findResource, 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, findLibrary, findLoadedClass, findSystemClass, getClassLoadingLock, getPackage, getPackages, getParent, getSystemClassLoader, getSystemResource, getSystemResourceAsStream, getSystemResources, 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

Field Detail

parentClassLoader

protected final java.lang.ClassLoader parentClassLoader

parentOnlyRules

protected java.lang.String[] parentOnlyRules

loaderOnlyRules

protected java.lang.String[] loaderOnlyRules

parentFirst

protected final boolean parentFirst

matchResourcesAsPackages

protected boolean matchResourcesAsPackages

Constructor Detail

ExtendedURLClassLoader

public ExtendedURLClassLoader(java.net.URL[] classpath,
                              java.lang.ClassLoader parent,
                              boolean parentFirst)

ExtendedURLClassLoader

public ExtendedURLClassLoader(java.net.URL[] classpath,
                              java.lang.ClassLoader parent,
                              boolean parentFirst,
                              boolean excludeJrePackagesFromLoader)

Creates class loader with given loading strategy.

Method Detail

addParentOnlyRules

public void addParentOnlyRules(java.lang.String... packages)

Adds parent only rules for classes which must be loaded on the parent loader.

addLoaderOnlyRules

public void addLoaderOnlyRules(java.lang.String... packages)

Adds loader-only rules for classes which must be loaded using this loader.

setMatchResourcesAsPackages

public void setMatchResourcesAsPackages(boolean matchResourcesAsPackages)

When set, resources will be matched in the same way as packages. If disabled, resources must be matched only with separate rules that uses "/".

isMatchingRules

protected boolean isMatchingRules(java.lang.String name,
                                  java.lang.String... rules)

Returns true if class or resource name matches at least one package rule from the list.

resolveLoading

protected ExtendedURLClassLoader.Loading resolveLoading(boolean parentFirstStrategy,
                                                        java.lang.String className)

Resolves loading rules.

resolveResourceLoading

protected ExtendedURLClassLoader.Loading resolveResourceLoading(boolean parentFirstStrategy,
                                                                java.lang.String resourceName)

Resolves resources.

loadClass

protected java.lang.Class<?> loadClass(java.lang.String className,
                                       boolean resolve)
                                throws java.lang.ClassNotFoundException

Loads class using parent-first or parent-last strategy.

Overrides:

loadClass in class java.lang.ClassLoader

Throws:

java.lang.ClassNotFoundException

getResource

public java.net.URL getResource(java.lang.String resourceName)

Returns a resource using parent-first or parent-last strategy.

Overrides:

getResource in class java.lang.ClassLoader

getResources

public java.util.Enumeration<java.net.URL> getResources(java.lang.String resourceName)
                                                 throws java.io.IOException

Overrides:

getResources in class java.lang.ClassLoader

Throws:

java.io.IOException