The Jar Scan Filter Component

Table of Contents

Introduction

The Jar Scan Filter element represents the component that filters results from the Jar Scanner before they are passed back to the application. It is typically used to skip the scanning of JARs that are known not to be relevant to some or all types of scan.

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

Attributes

Common Attributes

All implementations of Jar Scan Filter support the following attributes:

Attribute Description
className

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

Standard Implementation

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

Attribute Description
tldSkip

The comma separated list of JAR file and / or directory name patterns to skip when scanning for TLDs. If not specified, the default is obtained from the tomcat.util.scan.StandardJarScanFilter.jarsToSkip system property.

tldScan

The comma separated list of JAR file and / or directory name patterns to scan when scanning for TLDs. If not specified, the default is obtained from the tomcat.util.scan.StandardJarScanFilter.jarsToScan system property.

defaultTldScan

Controls if JARs are scanned or skipped by default. If true, JARs are scanned unless they match one or more TLD skip patterns and don't match any TLD scan patterns. If false, JARs are skipped unless they match one or more TLD scan patterns and don't match any TLD skip patterns. If not specified, the default value is true.

pluggableSkip

The comma separated list of JAR file and / or directory name patterns to skip when scanning for pluggable features. If not specified, the default is obtained from the tomcat.util.scan.StandardJarScanFilter.jarsToSkip system property.

pluggableScan

The comma separated list of JAR file and / or directory name patterns to scan when scanning for pluggable features. If not specified, the default is obtained from the tomcat.util.scan.StandardJarScanFilter.jarsToScan system property.

defaultPluggableScan

Controls if JARs are scanned or skipped by default. If true, JARs are scanned unless they match one or more pluggable skip patterns and don't match any pluggable scan patterns. If false, JARs are skipped unless they match one or more pluggable scan patterns and don't match any pluggable skip patterns. If not specified, the default value is true.

Nested Components

No components may be nested inside a Jar Scanner element.

Special Features

No special features are associated with a Jar Scanner element.

Comments

Notice: This comments section collects your suggestions on improving documentation for Apache Tomcat.

If you have trouble and need help, read Find Help page and ask your question on the tomcat-users mailing list. Do not ask such questions here. This is not a Q&A section.

The Apache Comments System is explained here. Comments may be removed by our moderators if they are either implemented or considered invalid/off-topic.