The Apache Tomcat Servlet/JSP Container

Apache Tomcat 7

Version 7.0.21, Aug 29 2011
Apache Logo


Top Level Elements




Nested Components

Cluster Elements

Global Settings

The Jar Scanner Component

Table of Contents

The Jar Scanner element represents the component that is used to scan the web application for JAR files. It is typically used during web application start to identify configuration files such as TLDs or web-fragment.xml files that must be processed as part of the web application initialisation.

A Jar Scanner element MAY be nested inside a Context component. If it is not included, a default Jar Scanner configuration will be created automatically, which is sufficient for most requirements.

Common Attributes

All implementations of Jar Scanner support the following attributes:


Java class name of the implementation to use. This class must implement the org.apache.tomcat.JarScanner interface. If not specified, the standard value (defined below) will be used.

Standard Implementation

The standard implementation of Jar Scanner is org.apache.tomcat.util.scan.StandardJarScanner. It supports the following additional attributes (in addition to the common attributes listed above):


If true, the full web application classpath, including the shared and common classloaders will be scanned for Jar files in addition to the web application. The default is true.


If true, any files found on the classpath will be checked to see if they are Jar files rather than relying on the file extension being .jar. The default is false


If true, any directories found on the classpath will be checked to see if are expanded Jar files. The default is false

Nested Components

No components may be nested inside a Jar Scanner element.

Special Features

No special features are associated with a Jar Scanner element.

Copyright © 1999-2011, Apache Software Foundation