The default JarScanner implementation scans the WEB-INF/lib directory followed by the provided classloader and then works up the classloader hierarchy. This implementation is sufficient to meet the requirements of the Servlet 3.0 specification as well as to provide a number of Tomcat specific extensions. The extensions are:

Scanning the classloader hierarchy (enabled by default)
Testing all files to see if they are JARs (disabled by default)
Testing all directories to see if they are exploded JARs (disabled by default)

All of the extensions may be controlled via configuration.

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	StandardJarScanner.ClassPathEntry

Field Summary

Modifier and Type	Field and Description
private static final Set<ClassLoader>	CLASSLOADER_HIERARCHY
private JarScanFilter	jarScanFilter Controls the filtering of the results from the scan for JARs
private final Log	log
private boolean	scanAllDirectories Controls the testing all directories to see of they are exploded JAR files extension.
private boolean	scanAllFiles Controls the testing all files to see of they are JAR files extension.
private boolean	scanBootstrapClassPath Controls the testing of the bootstrap classpath which consists of the runtime classes provided by the JVM and any installed system extensions.
private boolean	scanClassPath Controls the classpath scanning extension.
private boolean	scanManifest Controls the JAR file Manifest scanning extension.
private static final StringManager	sm The string resources for this package.

Constructor Summary

Access	Constructor and Description
public	StandardJarScanner()

Method Summary

Modifier and Type	Method and Description
protected void	addClassPath(Deque<URL> classPathUrlsToProcess)
protected void	doScanClassPath(JarScanType scanType, ServletContext context, JarScannerCallback callback, Set<URL> processedURLs)
public JarScanFilter	getJarScanFilter() Implements org.apache.tomcat.JarScanner.getJarScanFilter.
public boolean	isScanAllDirectories()
public boolean	isScanAllFiles()
public boolean	isScanBootstrapClassPath()
public boolean	isScanClassPath()
public boolean	isScanManifest()
private static boolean	isWebappClassLoader(ClassLoader classLoader)
protected void	process(JarScanType scanType, JarScannerCallback callback, URL url, String webappPath, boolean isWebapp, Deque<URL> classPathUrlsToProcess)
private void	processManifest(Jar jar, boolean isWebapp, Deque<URL> classPathUrlsToProcess)
protected void	processURLs(JarScanType scanType, JarScannerCallback callback, Set<URL> processedURLs, boolean isWebapp, Deque<URL> classPathUrlsToProcess)
public void	scan(JarScanType The type of JAR scan to perform. This is passed to the filter which uses it to determine how to filter the results scanType, ServletContext The ServletContext - used to locate and access WEB-INF/lib context, JarScannerCallback The handler to process any JARs found callback) Implements org.apache.tomcat.JarScanner.scan. Scan the provided ServletContext and class loader for JAR files.
public void	setJarScanFilter(JarScanFilter jarScanFilter) Implements org.apache.tomcat.JarScanner.setJarScanFilter.
public void	setScanAllDirectories(boolean scanAllDirectories)
public void	setScanAllFiles(boolean scanAllFiles)
public void	setScanBootstrapClassPath(boolean scanBootstrapClassPath)
public void	setScanClassPath(boolean scanClassPath)
public void	setScanManifest(boolean scanManifest)

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

Field Detail

CLASSLOADER_HIERARCHY	back to summary
private static final Set<ClassLoader> CLASSLOADER_HIERARCHY

jarScanFilter	back to summary
private JarScanFilter jarScanFilter Controls the filtering of the results from the scan for JARs

log	back to summary
private final Log log

scanAllDirectories	back to summary
private boolean scanAllDirectories Controls the testing all directories to see of they are exploded JAR files extension.

scanAllFiles	back to summary
private boolean scanAllFiles Controls the testing all files to see of they are JAR files extension.

scanBootstrapClassPath	back to summary
private boolean scanBootstrapClassPath Controls the testing of the bootstrap classpath which consists of the runtime classes provided by the JVM and any installed system extensions.

scanClassPath	back to summary
private boolean scanClassPath Controls the classpath scanning extension.

scanManifest	back to summary
private boolean scanManifest Controls the JAR file Manifest scanning extension.

sm	back to summary
private static final StringManager sm The string resources for this package.

Constructor Detail

StandardJarScanner	back to summary
public StandardJarScanner()

Method Detail

addClassPath	back to summary
protected void addClassPath(Deque<URL> classPathUrlsToProcess)

doScanClassPath	back to summary
protected void doScanClassPath(JarScanType scanType, ServletContext context, JarScannerCallback callback, Set<URL> processedURLs)

getJarScanFilter	back to summary
public JarScanFilter getJarScanFilter() Implements org.apache.tomcat.JarScanner.getJarScanFilter. Annotations @Override

getJarScanFilter

back to summary

public JarScanFilter getJarScanFilter()

Implements org.apache.tomcat.JarScanner.getJarScanFilter.

Annotations

@Override

isScanAllDirectories	back to summary
public boolean isScanAllDirectories()

isScanAllFiles	back to summary
public boolean isScanAllFiles()

isScanBootstrapClassPath	back to summary
public boolean isScanBootstrapClassPath()

isScanClassPath	back to summary
public boolean isScanClassPath()

isScanManifest	back to summary
public boolean isScanManifest()

isWebappClassLoader	back to summary
private static boolean isWebappClassLoader(ClassLoader classLoader)

process	back to summary
protected void process(JarScanType scanType, JarScannerCallback callback, URL url, String webappPath, boolean isWebapp, Deque<URL> classPathUrlsToProcess) throws IOException

processManifest	back to summary
private void processManifest(Jar jar, boolean isWebapp, Deque<URL> classPathUrlsToProcess) throws IOException

processURLs	back to summary
protected void processURLs(JarScanType scanType, JarScannerCallback callback, Set<URL> processedURLs, boolean isWebapp, Deque<URL> classPathUrlsToProcess)

scan	back to summary
public void scan(JarScanType scanType, ServletContext context, JarScannerCallback callback) Implements org.apache.tomcat.JarScanner.scan. Scan the provided ServletContext and class loader for JAR files. Each JAR file found will be passed to the callback handler to be processed. Parameters scanType:JarScanType The type of JAR scan to perform. This is passed to the filter which uses it to determine how to filter the results context:ServletContext The ServletContext - used to locate and access WEB-INF/lib callback:JarScannerCallback The handler to process any JARs found Annotations @Override

scan

back to summary

public void scan(JarScanType scanType, ServletContext context, JarScannerCallback callback)

Implements org.apache.tomcat.JarScanner.scan.

Scan the provided ServletContext and class loader for JAR files. Each JAR file found will be passed to the callback handler to be processed.

Parameters

scanType:JarScanType: The type of JAR scan to perform. This is passed to the filter which uses it to determine how to filter the results
context:ServletContext: The ServletContext - used to locate and access WEB-INF/lib
callback:JarScannerCallback: The handler to process any JARs found

Annotations

@Override

setJarScanFilter	back to summary
public void setJarScanFilter(JarScanFilter jarScanFilter) Implements org.apache.tomcat.JarScanner.setJarScanFilter. Annotations @Override

setJarScanFilter

back to summary

public void setJarScanFilter(JarScanFilter jarScanFilter)

Implements org.apache.tomcat.JarScanner.setJarScanFilter.

Annotations

@Override

setScanAllDirectories	back to summary
public void setScanAllDirectories(boolean scanAllDirectories)

setScanAllFiles	back to summary
public void setScanAllFiles(boolean scanAllFiles)

setScanBootstrapClassPath	back to summary
public void setScanBootstrapClassPath(boolean scanBootstrapClassPath)

setScanClassPath	back to summary
public void setScanClassPath(boolean scanClassPath)

setScanManifest	back to summary
public void setScanManifest(boolean scanManifest)

org.apache.tomcat.util.scan back to summary

private Class StandardJarScanner.ClassPathEntry

Class Inheritance

extends Object

java.lang.Object
org.apache.tomcat.util.scan.StandardJarScanner.ClassPathEntry

Field Summary

Modifier and Type	Field and Description
private final boolean	jar
private final String	name

Constructor Summary

Access	Constructor and Description
pack-priv	ClassPathEntry(URL url)

Method Summary

Modifier and Type	Method and Description
public String	getName()
public boolean	isJar()

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

Field Detail

jar	back to summary
private final boolean jar

name	back to summary
private final String name

Constructor Detail

ClassPathEntry	back to summary
pack-priv ClassPathEntry(URL url)

Method Detail

getName	back to summary
public String getName()

isJar	back to summary
public boolean isJar()

public Class StandardJarScanner

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class StandardJarScanner.ClassPathEntry

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail