Package org.frankframework.configuration.classloaders

Class AbstractClassLoader

java.lang.Object

java.lang.ClassLoader

org.frankframework.configuration.classloaders.AbstractClassLoader

All Implemented Interfaces:

IConfigurationClassLoader, org.springframework.core.SmartClassLoader

Direct Known Subclasses:

AbstractBytesClassLoader, DirectoryClassLoader, DummyClassLoader, WebAppClassLoader

public abstract class AbstractClassLoader
extends ClassLoader
implements IConfigurationClassLoader, org.springframework.core.SmartClassLoader

Abstract base class for for IBIS Configuration ClassLoaders. Appends a BasePath to every resource when set. This allows the use of sub config's in src/main/resources When a file with prepended BasePath cannot be found it will traverse through it's classpath to find it.

Author:

Niels Meijer

Nested Class Summary

Nested classes/interfaces inherited from interface org.frankframework.configuration.classloaders.IConfigurationClassLoader

IConfigurationClassLoader.ReportLevel

Field Summary

Fields

Modifier and Type	Field	Description
protected org.apache.logging.log4j.Logger	log

Fields inherited from interface org.frankframework.configuration.classloaders.IConfigurationClassLoader

CLASSPATH_RESOURCE_SCHEME

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractClassLoader()
protected	AbstractClassLoader(ClassLoader parent)

Method Summary

Modifier and Type	Method	Description
void	configure(IbisContext ibisContext, String configurationName)	Configure the IConfigurationClassLoader's implementation
void	destroy()	Called upon destroying (and thus removing) the IConfigurationClassLoader
protected boolean	getAllowCustomClasses()
protected String	getBasePath()	The root directory where all resources are located.
String	getConfigurationFile()	The configurationFile should only ever be found in the current classloader and never in it's parent
String	getConfigurationName()	Retrieve the name of the configuration that uses this IConfigurationClassLoader
protected IbisContext	getIbisContext()	Only for internal use within ClassLoaders Retrieve the IbisContext from the ClassLoader which is set when the configure method is called
abstract URL	getLocalResource(String name)
IConfigurationClassLoader.ReportLevel	getReportLevel()
final URL	getResource(String name)	Override this method and make it final so nobody can overwrite it.
URL	getResource(String name, boolean useParent)	In case of the getResources(String) we only want the local paths and not the parent path
final Enumeration<URL>	getResources(String name)
protected Class<?>	loadClass(String name, boolean resolve)
Class<?>	publicDefineClass(String name, byte[] b, ProtectionDomain protectionDomain)	Fixes --add-opens=java.base/java.lang=ALL-UNNAMED problem when loading classes dynamically when CGLIB is enabled.
void	reload()	Unload the current IConfigurationClassLoader and load again upon successful unload.
void	setAllowCustomClasses(boolean allow)
void	setBasePath(String basePath)	Sets the path prefix used when getLocalResource() is called.
void	setConfigurationFile(String configurationFile)
void	setReportLevel(String level)	Defines the log level for errors caused by the configure method
String	toString()

Methods inherited from class java.lang.ClassLoader

clearAssertionStatus, defineClass, defineClass, defineClass, defineClass, definePackage, findClass, findClass, findLibrary, findLoadedClass, findResource, findResource, findResources, findSystemClass, getClassLoadingLock, getDefinedPackage, getDefinedPackages, getName, getPackage, getPackages, getParent, getPlatformClassLoader, getResourceAsStream, getSystemClassLoader, getSystemResource, getSystemResourceAsStream, getSystemResources, getUnnamedModule, isRegisteredAsParallelCapable, loadClass, registerAsParallelCapable, resolveClass, resources, setClassAssertionStatus, setDefaultAssertionStatus, setPackageAssertionStatus, setSigners

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.core.SmartClassLoader

getOriginalClassLoader, isClassReloadable

Field Details

log

protected org.apache.logging.log4j.Logger log

Constructor Details

AbstractClassLoader

protected AbstractClassLoader()

AbstractClassLoader

protected AbstractClassLoader(ClassLoader parent)

Method Details

configure

public void configure(IbisContext ibisContext,
 String configurationName)
               throws ClassLoaderException

Description copied from interface: IConfigurationClassLoader

Configure the IConfigurationClassLoader's implementation

Specified by:

configure in interface IConfigurationClassLoader

Throws:

ClassLoaderException - when the IConfigurationClassLoader's implementation cannot retrieve or load the configuration files

setBasePath

public void setBasePath(String basePath)

Sets the path prefix used when getLocalResource() is called.

Parameters:

basePath - path to use, defaults to the configuration name

getBasePath

protected String getBasePath()

The root directory where all resources are located. This may purely be used within the ClassLoader and resources should not be aware of this 'root' directory.

Returns:

the path prefix that is used for retrieving files through this ClassLoader

getConfigurationName

public String getConfigurationName()

Description copied from interface: IConfigurationClassLoader

Retrieve the name of the configuration that uses this IConfigurationClassLoader

Specified by:

getConfigurationName in interface IConfigurationClassLoader

getConfigurationFile

public String getConfigurationFile()

The configurationFile should only ever be found in the current classloader and never in it's parent

setConfigurationFile

public void setConfigurationFile(String configurationFile)

getIbisContext

protected IbisContext getIbisContext()

Only for internal use within ClassLoaders Retrieve the IbisContext from the ClassLoader which is set when the configure method is called

setReportLevel

public void setReportLevel(String level)

Description copied from interface: IConfigurationClassLoader

Defines the log level for errors caused by the configure method

Specified by:

setReportLevel in interface IConfigurationClassLoader

Parameters:

level - ReportLevel in string format to be parsed by the ClassLoaderManager digester

getReportLevel

public IConfigurationClassLoader.ReportLevel getReportLevel()

Specified by:

getReportLevel in interface IConfigurationClassLoader

Returns:

the IConfigurationClassLoader.ReportLevel set for this IConfigurationClassLoader

setAllowCustomClasses

public void setAllowCustomClasses(boolean allow)

getAllowCustomClasses

protected boolean getAllowCustomClasses()

getResource

public final URL getResource(String name)

Override this method and make it final so nobody can overwrite it. Implementations of this class should use getLocalResource(String)

Specified by:

getResource in interface IConfigurationClassLoader

Overrides:

getResource in class ClassLoader

getLocalResource

public abstract URL getLocalResource(String name)

Parameters:

name - of the file to search for in the current local classpath

Returns:

the URL of the file if found in the ClassLoader or null when the file cannot be found

getResource

public URL getResource(String name,
 boolean useParent)

In case of the getResources(String) we only want the local paths and not the parent path

Parameters:

name - of the file to retrieve

useParent - only use local classpath or also traverse down the classpath

Returns:

the URL of the file if found in the ClassLoader or null

getResources

public final Enumeration<URL> getResources(String name)
                                    throws IOException

Overrides:

getResources in class ClassLoader

Throws:

IOException

loadClass

protected Class<?> loadClass(String name,
 boolean resolve)
                      throws ClassNotFoundException

Overrides:

loadClass in class ClassLoader

Throws:

ClassNotFoundException

publicDefineClass

public Class<?> publicDefineClass(String name,
 byte[] b,
 @Nullable
 ProtectionDomain protectionDomain)

Fixes --add-opens=java.base/java.lang=ALL-UNNAMED problem when loading classes dynamically when CGLIB is enabled. See spring github for more background information.

Specified by:

publicDefineClass in interface org.springframework.core.SmartClassLoader

reload

public void reload()
            throws ClassLoaderException

Description copied from interface: IConfigurationClassLoader

Unload the current IConfigurationClassLoader and load again upon successful unload.

Specified by:

reload in interface IConfigurationClassLoader

Throws:

ClassLoaderException

destroy

public void destroy()

Description copied from interface: IConfigurationClassLoader

Called upon destroying (and thus removing) the IConfigurationClassLoader

Specified by:

destroy in interface IConfigurationClassLoader

toString

public String toString()

Overrides:

toString in class Object