Package org.apache.tomcat.util.scan
Class StandardJarScanFilter
- java.lang.Object
-
- org.apache.tomcat.util.scan.StandardJarScanFilter
-
- All Implemented Interfaces:
JarScanFilter
public class StandardJarScanFilter extends Object implements JarScanFilter
-
-
Constructor Summary
Constructors Constructor Description StandardJarScanFilter()This is the standard implementation ofJarScanFilter.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleancheck(JarScanType jarScanType, String jarName)StringgetPluggabilityScan()StringgetPluggabilitySkip()StringgetTldScan()StringgetTldSkip()booleanisDefaultPluggabilityScan()booleanisDefaultTldScan()booleanisSkipAll()voidsetDefaultPluggabilityScan(boolean defaultPluggabilityScan)voidsetDefaultTldScan(boolean defaultTldScan)voidsetPluggabilityScan(String pluggabilityScan)voidsetPluggabilitySkip(String pluggabilitySkip)voidsetTldScan(String tldScan)voidsetTldSkip(String tldSkip)
-
-
-
Constructor Detail
-
StandardJarScanFilter
public StandardJarScanFilter()
This is the standard implementation ofJarScanFilter. By default, the following filtering rules are used:- JARs that match neither the skip nor the scan list will be included in scan results.
- JARs that match the skip list but not the scan list will be excluded from scan results.
- JARs that match the scan list will be included from scan results.
Constants.SKIP_JARS_PROPERTYandConstants.SCAN_JARS_PROPERTYrespectively. These default values may be over-ridden for theJarScanType.TLDandJarScanType.PLUGGABILITYscans. The filtering rules may also be modified for these scan types usingsetDefaultTldScan(boolean)andsetDefaultPluggabilityScan(boolean). If set tofalse, the following filtering rules are used for associated type:- JARs that match neither the skip nor the scan list will be excluded from scan results.
- JARs that match the scan list but not the skip list will be included in scan results.
- JARs that match the skip list will be excluded from scan results.
-
-
Method Detail
-
getTldSkip
public String getTldSkip()
-
setTldSkip
public void setTldSkip(String tldSkip)
-
getTldScan
public String getTldScan()
-
setTldScan
public void setTldScan(String tldScan)
-
isSkipAll
public boolean isSkipAll()
- Specified by:
isSkipAllin interfaceJarScanFilter- Returns:
trueif all of the scans should be skipped which can improve startup performance. The default isfalse.
-
isDefaultTldScan
public boolean isDefaultTldScan()
-
setDefaultTldScan
public void setDefaultTldScan(boolean defaultTldScan)
-
getPluggabilitySkip
public String getPluggabilitySkip()
-
setPluggabilitySkip
public void setPluggabilitySkip(String pluggabilitySkip)
-
getPluggabilityScan
public String getPluggabilityScan()
-
setPluggabilityScan
public void setPluggabilityScan(String pluggabilityScan)
-
isDefaultPluggabilityScan
public boolean isDefaultPluggabilityScan()
-
setDefaultPluggabilityScan
public void setDefaultPluggabilityScan(boolean defaultPluggabilityScan)
-
check
public boolean check(JarScanType jarScanType, String jarName)
- Specified by:
checkin interfaceJarScanFilter- Parameters:
jarScanType- The type of JAR scan currently being performedjarName- The name of the JAR file (without any path information) to be checked to see if it should be included in the results or not- Returns:
trueif the JAR should be returned in the results,falseif it should be excluded
-
-