Tomcat 10.1.19 · org.apache.tomcat.util.scan.StandardJarScanFilter

Field Summary

Modifier and Type	Field and Description
private final ReadWriteLock	configurationLock
private boolean	defaultPluggabilityScan
private static final String	defaultScan
private static final Set<String>	defaultScanSet
private static final String	defaultSkip
private static final boolean	defaultSkipAll
private static final Set<String>	defaultSkipSet
private boolean	defaultTldScan
private String	pluggabilityScan
private final Set<String>	pluggabilityScanSet
private String	pluggabilitySkip
private final Set<String>	pluggabilitySkipSet
private String	tldScan
private final Set<String>	tldScanSet
private String	tldSkip
private final Set<String>	tldSkipSet

Constructor Summary

Access	Constructor and Description
public	StandardJarScanFilter() This is the standard implementation of `JarScanFilter`.

Method Summary

Modifier and Type	Method and Description
public boolean	check(JarScanType The type of JAR scan currently being performed jarScanType, String 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 jarName) Implements org.apache.tomcat.JarScanFilter.check.
public String	getPluggabilityScan()
public String	getPluggabilitySkip()
public String	getTldScan()
public String	getTldSkip()
public boolean	isDefaultPluggabilityScan()
public boolean	isDefaultTldScan()
public boolean	isSkipAll() Overrides default org.apache.tomcat.JarScanFilter.isSkipAll.
private static void	populateSetFromAttribute(String attribute, Set<String> set)
public void	setDefaultPluggabilityScan(boolean defaultPluggabilityScan)
public void	setDefaultTldScan(boolean defaultTldScan)
public void	setPluggabilityScan(String pluggabilityScan)
public void	setPluggabilitySkip(String pluggabilitySkip)
public void	setTldScan(String tldScan)
public void	setTldSkip(String tldSkip)

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

Field Detail

configurationLock	back to summary
private final ReadWriteLock configurationLock

defaultPluggabilityScan	back to summary
private boolean defaultPluggabilityScan

defaultScan	back to summary
private static final String defaultScan

defaultScanSet	back to summary
private static final Set<String> defaultScanSet

defaultSkip	back to summary
private static final String defaultSkip

defaultSkipAll	back to summary
private static final boolean defaultSkipAll

defaultSkipSet	back to summary
private static final Set<String> defaultSkipSet

defaultTldScan	back to summary
private boolean defaultTldScan

pluggabilityScan	back to summary
private String pluggabilityScan

pluggabilityScanSet	back to summary
private final Set<String> pluggabilityScanSet

pluggabilitySkip	back to summary
private String pluggabilitySkip

pluggabilitySkipSet	back to summary
private final Set<String> pluggabilitySkipSet

tldScan	back to summary
private String tldScan

tldScanSet	back to summary
private final Set<String> tldScanSet

tldSkip	back to summary
private String tldSkip

tldSkipSet	back to summary
private final Set<String> tldSkipSet

Constructor Detail

StandardJarScanFilter back to summary

StandardJarScanFilter	back to summary
public StandardJarScanFilter() This is the standard implementation of `JarScanFilter`. 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. The default skip list and default scan list are obtained from the system properties `Constants#SKIP_JARS_PROPERTY` and `Constants#SCAN_JARS_PROPERTY` respectively. These default values may be over-ridden for the `JarScanType#TLD` and `JarScanType#PLUGGABILITY` scans. The filtering rules may also be modified for these scan types using `setDefaultTldScan(boolean)` and `setDefaultPluggabilityScan(boolean)`. If set to `false`, 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.

public StandardJarScanFilter()

This is the standard implementation of JarScanFilter. 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.

The default skip list and default scan list are obtained from the system properties Constants#SKIP_JARS_PROPERTY and Constants#SCAN_JARS_PROPERTY respectively. These default values may be over-ridden for the JarScanType#TLD and JarScanType#PLUGGABILITY scans. The filtering rules may also be modified for these scan types using setDefaultTldScan(boolean) and setDefaultPluggabilityScan(boolean). If set to false, 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

check back to summary

check	back to summary
public boolean check(JarScanType jarScanType, String jarName) Implements org.apache.tomcat.JarScanFilter.check. Parameters jarScanType:JarScanType Doc from org.apache.tomcat.JarScanFilter.check. The type of JAR scan currently being performed jarName:String Doc from org.apache.tomcat.JarScanFilter.check. 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:boolean Doc from org.apache.tomcat.JarScanFilter.check. `true` if the JAR should be returned in the results, `false` if it should be excluded Annotations @Override

public boolean check(JarScanType jarScanType, String jarName)

Implements org.apache.tomcat.JarScanFilter.check.

Parameters

jarScanType:JarScanType

Doc from org.apache.tomcat.JarScanFilter.check.

The type of JAR scan currently being performed

jarName:String

Doc from org.apache.tomcat.JarScanFilter.check.

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:boolean

Doc from org.apache.tomcat.JarScanFilter.check.

true if the JAR should be returned in the results, false if it should be excluded

Annotations

@Override

getPluggabilityScan	back to summary
public String getPluggabilityScan()

getPluggabilitySkip	back to summary
public String getPluggabilitySkip()

getTldScan	back to summary
public String getTldScan()

getTldSkip	back to summary
public String getTldSkip()

isDefaultPluggabilityScan	back to summary
public boolean isDefaultPluggabilityScan()

isDefaultTldScan	back to summary
public boolean isDefaultTldScan()

isSkipAll back to summary

isSkipAll	back to summary
public boolean isSkipAll() Overrides default org.apache.tomcat.JarScanFilter.isSkipAll. Returns:boolean Doc from org.apache.tomcat.JarScanFilter.isSkipAll. `true` if all of the scans should be skipped which can improve startup performance. The default is `false`. Annotations @Override

public boolean isSkipAll()

Overrides default org.apache.tomcat.JarScanFilter.isSkipAll.

Returns:boolean

Doc from org.apache.tomcat.JarScanFilter.isSkipAll.

true if all of the scans should be skipped which can improve startup performance. The default is false.

Annotations

@Override

populateSetFromAttribute	back to summary
private static void populateSetFromAttribute(String attribute, Set<String> set)

setDefaultPluggabilityScan	back to summary
public void setDefaultPluggabilityScan(boolean defaultPluggabilityScan)

setDefaultTldScan	back to summary
public void setDefaultTldScan(boolean defaultTldScan)

setPluggabilityScan	back to summary
public void setPluggabilityScan(String pluggabilityScan)

setPluggabilitySkip	back to summary
public void setPluggabilitySkip(String pluggabilitySkip)

setTldScan	back to summary
public void setTldScan(String tldScan)

setTldSkip	back to summary
public void setTldSkip(String tldSkip)

public Class StandardJarScanFilter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail