Author: markt
Date: Fri Jun 14 07:44:22 2013
New Revision: 1492983
URL: http://svn.apache.org/r1492983
Log:
Add some documentation
Added:
tomcat/trunk/webapps/docs/config/jar-scan-filter.xml
Modified:
tomcat/trunk/webapps/docs/config/jar-scanner.xml
tomcat/trunk/webapps/docs/config/project.xml
Added: tomcat/trunk/webapps/docs/config/jar-scan-filter.xml
URL:
http://svn.apache.org/viewvc/tomcat/trunk/webapps/docs/config/jar-scan-filter.xml?rev=1492983&view=auto
==============================================================================
--- tomcat/trunk/webapps/docs/config/jar-scan-filter.xml (added)
+++ tomcat/trunk/webapps/docs/config/jar-scan-filter.xml Fri Jun 14 07:44:22
2013
@@ -0,0 +1,149 @@
+<?xml version="1.0"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<!DOCTYPE document [
+ <!ENTITY project SYSTEM "project.xml">
+]>
+<document url="jar-scan-filter.html">
+
+ &project;
+
+ <properties>
+ <title>The Jar Scan Filter Component</title>
+ </properties>
+
+<body>
+
+<section name="Table of Contents">
+<toc/>
+</section>
+
+<section name="Introduction">
+
+ <p>The <strong>Jar Scan Filter</strong> element represents the component that
+ filters results from the <a href="jar-scanner.html">Jar Scanner</a> 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.</p>
+
+ <p>A Jar Scan Filter element MAY be nested inside a
+ <a href="jar-scanner.html">Jar Scanner</a> component. If it is not included,
+ a default Jar Scan Filter configuration will be created automatically, which
+ is sufficient for most requirements.</p>
+
+</section>
+
+
+<section name="Attributes">
+
+ <subsection name="Common Attributes">
+
+ <p>All implementations of <strong>Jar Scan Filter</strong>
+ support the following attributes:</p>
+
+ <attributes>
+
+ <attribute name="className" required="false">
+ <p>Java class name of the implementation to use. This class must
+ implement the <code>org.apache.tomcat.JarScanFilter</code> interface.
+ If not specified, the standard value (defined below) will be used.</p>
+ </attribute>
+
+ </attributes>
+
+ </subsection>
+
+
+ <subsection name="Standard Implementation">
+
+ <p>The standard implementation of <strong>Jar Scan Filter</strong> is
+ <strong>org.apache.tomcat.util.scan.StandardJarScanFilter</strong>.
+ It supports the following additional attributes (in addition to the
+ common attributes listed above):</p>
+
+ <attributes>
+
+ <attribute name="tldSkip" required="false">
+ <p>The comma separated list of JAR file name patterns to skip when
+ scanning for TLDs. If not specified, the default is obtained from the
+ <code>tomcat.util.scan.StandardJarScanFilter.jarsToSkip</code> system
+ property.</p>
+ </attribute>
+
+ <attribute name="tldScan" required="false">
+ <p>The comma separated list of JAR file name patterns to scan when
+ scanning for TLDs. If not specified, the default is obtained from the
+ <code>tomcat.util.scan.StandardJarScanFilter.jarsToScan</code> system
+ property.</p>
+ </attribute>
+
+ <attribute name="defaultTldScan" required="false">
+ <p>Controls if JARs are scanned or skipped by default. If
+ <code>true</code>, JARs are scanned unless they match one or more TLD
+ skip patterns and don't match any TLD scan patterns. If
+ <code>false</code>, 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 <code>true</code>.</p>
+ </attribute>
+
+ <attribute name="pluggableSkip" required="false">
+ <p>The comma separated list of JAR file name patterns to skip when
+ scanning for pluggable features. If not specified, the default is
+ obtained from the
+ <code>tomcat.util.scan.StandardJarScanFilter.jarsToSkip</code> system
+ property.</p>
+ </attribute>
+
+ <attribute name="pluggableScan" required="false">
+ <p>The comma separated list of JAR file name patterns to scan when
+ scanning for pluggable features. If not specified, the default is
+ obtained from the
+ <code>tomcat.util.scan.StandardJarScanFilter.jarsToScan</code> system
+ property.</p>
+ </attribute>
+
+ <attribute name="defaultPluggableScan" required="false">
+ <p>Controls if JARs are scanned or skipped by default. If
+ <code>true</code>, JARs are scanned unless they match one or more
+ pluggable skip patterns and don't match any pluggable scan patterns. If
+ <code>false</code>, 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 <code>true</code>.</p>
+ </attribute>
+
+ </attributes>
+
+ </subsection>
+
+
+</section>
+
+
+<section name="Nested Components">
+ <p>No components may be nested inside a <strong>Jar Scanner</strong> element.
+ </p>
+</section>
+
+
+<section name="Special Features">
+ <p>No special features are associated with a <strong>Jar Scanner</strong>
+ element.</p>
+</section>
+
+</body>
+
+</document>
Modified: tomcat/trunk/webapps/docs/config/jar-scanner.xml
URL:
http://svn.apache.org/viewvc/tomcat/trunk/webapps/docs/config/jar-scanner.xml?rev=1492983&r1=1492982&r2=1492983&view=diff
==============================================================================
--- tomcat/trunk/webapps/docs/config/jar-scanner.xml (original)
+++ tomcat/trunk/webapps/docs/config/jar-scanner.xml Fri Jun 14 07:44:22 2013
@@ -113,8 +113,8 @@
<section name="Nested Components">
- <p>No components may be nested inside a <strong>Jar Scanner</strong> element.
- </p>
+ <p>Only a <a href="jar-scan-filter.html">Jar Scan Filter</a> may be nested
+ inside a <strong>Jar Scanner</strong> element.</p>
</section>
Modified: tomcat/trunk/webapps/docs/config/project.xml
URL:
http://svn.apache.org/viewvc/tomcat/trunk/webapps/docs/config/project.xml?rev=1492983&r1=1492982&r2=1492983&view=diff
==============================================================================
--- tomcat/trunk/webapps/docs/config/project.xml (original)
+++ tomcat/trunk/webapps/docs/config/project.xml Fri Jun 14 07:44:22 2013
@@ -58,6 +58,7 @@
<menu name="Nested Components">
<item name="Global Resources" href="globalresources.html"/>
<item name="JarScanner" href="jar-scanner.html"/>
+ <item name="JarScanFilter" href="jar-scan-filter.html"/>
<item name="Listeners" href="listeners.html"/>
<item name="Loader" href="loader.html"/>
<item name="Manager" href="manager.html"/>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org
