Utility class for building class loaders for Catalina. The factory method requires the following parameters in order to build a new class loader (with suitable defaults in all cases):

A set of directories containing unpacked classes (and resources) that should be included in the class loader's repositories.
A set of directories containing classes and resources in JAR files. Each readable JAR file discovered in these directories will be added to the class loader's repositories.
ClassLoader instance that should become the parent of the new class loader.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	ClassLoaderFactory.Repository
public static enum	ClassLoaderFactory.RepositoryType

Field Summary

Modifier and Type	Field and Description
private static final Log	log

Constructor Summary

Access	Constructor and Description
public	ClassLoaderFactory()

Method Summary

Modifier and Type	Method and Description
private static URL	buildClassLoaderUrl(String urlString)
private static URL	buildClassLoaderUrl(File file)
public static ClassLoader	Returns: the new class loader createClassLoader(File[] Array of pathnames to unpacked directories that should be added to the repositories of the class loader, or `null` for no unpacked directories to be considered unpacked, File[] Array of pathnames to directories containing JAR files that should be added to the repositories of the class loader, or `null` for no directories of JAR files to be considered packed, final ClassLoader Parent class loader for the new class loader, or `null` for the system class loader. parent) Create and return a new class loader, based on the configuration defaults and the specified directory paths:
public static ClassLoader	Returns: the new class loader createClassLoader(List<ClassLoaderFactory.Repository> List of class directories, jar files, jar directories or URLS that should be added to the repositories of the class loader. repositories, final ClassLoader Parent class loader for the new class loader, or `null` for the system class loader. parent) Create and return a new class loader, based on the configuration defaults and the specified directory paths:
private static boolean	validateFile(File file, ClassLoaderFactory.RepositoryType type)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

log	back to summary
private static final Log log

Constructor Detail

ClassLoaderFactory	back to summary
public ClassLoaderFactory()

Method Detail

buildClassLoaderUrl	back to summary
private static URL buildClassLoaderUrl(String urlString) throws MalformedURLException, URISyntaxException

buildClassLoaderUrl	back to summary
private static URL buildClassLoaderUrl(File file) throws MalformedURLException, URISyntaxException

createClassLoader back to summary

createClassLoader	back to summary
public static ClassLoader createClassLoader(File[] unpacked, File[] packed, final ClassLoader parent) throws Exception Create and return a new class loader, based on the configuration defaults and the specified directory paths: Parameters unpacked:File[] Array of pathnames to unpacked directories that should be added to the repositories of the class loader, or `null` for no unpacked directories to be considered packed:File[] Array of pathnames to directories containing JAR files that should be added to the repositories of the class loader, or `null` for no directories of JAR files to be considered parent:ClassLoader Parent class loader for the new class loader, or `null` for the system class loader. Returns:ClassLoader the new class loader Exceptions Exception: if an error occurs constructing the class loader

public static ClassLoader createClassLoader(File[] unpacked, File[] packed, final ClassLoader parent) throws Exception

Create and return a new class loader, based on the configuration defaults and the specified directory paths:

Parameters

unpacked:File[]: Array of pathnames to unpacked directories that should be added to the repositories of the class loader, or null for no unpacked directories to be considered
packed:File[]: Array of pathnames to directories containing JAR files that should be added to the repositories of the class loader, or null for no directories of JAR files to be considered
parent:ClassLoader: Parent class loader for the new class loader, or null for the system class loader.

Returns:ClassLoader

the new class loader

Exceptions

Exception:: if an error occurs constructing the class loader

createClassLoader back to summary

createClassLoader	back to summary
public static ClassLoader createClassLoader(List<ClassLoaderFactory.Repository> repositories, final ClassLoader parent) throws Exception Create and return a new class loader, based on the configuration defaults and the specified directory paths: Parameters repositories:List<ClassLoaderFactory.Repository> List of class directories, jar files, jar directories or URLS that should be added to the repositories of the class loader. parent:ClassLoader Parent class loader for the new class loader, or `null` for the system class loader. Returns:ClassLoader the new class loader Exceptions Exception: if an error occurs constructing the class loader

public static ClassLoader createClassLoader(List<ClassLoaderFactory.Repository> repositories, final ClassLoader parent) throws Exception

Create and return a new class loader, based on the configuration defaults and the specified directory paths:

Parameters

repositories:List<ClassLoaderFactory.Repository>: List of class directories, jar files, jar directories or URLS that should be added to the repositories of the class loader.
parent:ClassLoader: Parent class loader for the new class loader, or null for the system class loader.

Returns:ClassLoader

the new class loader

Exceptions

Exception:: if an error occurs constructing the class loader

validateFile	back to summary
private static boolean validateFile(File file, ClassLoaderFactory.RepositoryType type) throws IOException

org.apache.catalina.startup back to summary

public Class ClassLoaderFactory.Repository

Class Inheritance

extends Object

java.lang.Object
org.apache.catalina.startup.ClassLoaderFactory.Repository

Field Summary

Modifier and Type	Field and Description
private final String	location
private final ClassLoaderFactory.RepositoryType	type

Constructor Summary

Access	Constructor and Description
public	Repository(String location, ClassLoaderFactory.RepositoryType type)

Method Summary

Modifier and Type	Method and Description
public String	getLocation()
public ClassLoaderFactory.RepositoryType	getType()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

location	back to summary
private final String location

type	back to summary
private final ClassLoaderFactory.RepositoryType type

Constructor Detail

Repository	back to summary
public Repository(String location, ClassLoaderFactory.RepositoryType type)

Method Detail

getLocation	back to summary
public String getLocation()

getType	back to summary
public ClassLoaderFactory.RepositoryType getType()

org.apache.catalina.startup back to summary

public final Enum ClassLoaderFactory.RepositoryType

Class Inheritance

extends Enum<ClassLoaderFactory.RepositoryType>

java.lang.Object
java.lang.Enum
org.apache.catalina.startup.ClassLoaderFactory.RepositoryType

Field Summary

Modifier and Type	Field and Description
public static final ClassLoaderFactory.RepositoryType	DIR
public static final ClassLoaderFactory.RepositoryType	GLOB
public static final ClassLoaderFactory.RepositoryType	JAR
public static final ClassLoaderFactory.RepositoryType	URL

Constructor Summary

Access	Constructor and Description
private	RepositoryType()

Method Summary

Modifier and Type	Method and Description
public static ClassLoaderFactory.RepositoryType	valueOf(String name)
public static ClassLoaderFactory.RepositoryType[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

DIR	back to summary
public static final ClassLoaderFactory.RepositoryType DIR

GLOB	back to summary
public static final ClassLoaderFactory.RepositoryType GLOB

JAR	back to summary
public static final ClassLoaderFactory.RepositoryType JAR

URL	back to summary
public static final ClassLoaderFactory.RepositoryType URL

Constructor Detail

RepositoryType	back to summary
private RepositoryType()

Method Detail

valueOf	back to summary
public static ClassLoaderFactory.RepositoryType valueOf(String name)

values	back to summary
public static ClassLoaderFactory.RepositoryType[] values()

public final Class ClassLoaderFactory

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class ClassLoaderFactory.Repository

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum ClassLoaderFactory.RepositoryType

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail