JarScanner (Apache Tomcat 9.0.37 API Documentation)

org.apache.tomcat

## Interface JarScanner

- All Known Implementing Classes:
    StandardJarScanner

      public interface JarScanner

  Scans a web application and classloader hierarchy for JAR files. Uses include TLD scanning and web-fragment.xml scanning. Uses a call-back mechanism so the caller can process each JAR found.

- - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method and Description
    --- | ---
    `JarScanFilter` | `getJarScanFilter()`
    `void` | `scan(JarScanType scanType, ServletContext context, JarScannerCallback callback)` Scan the provided ServletContext and classloader for JAR files.
    `void` | `setJarScanFilter(JarScanFilter jarScanFilter)`

- - ### Method Detail

    - #### scan

          void scan(JarScanType scanType,
                    ServletContext context,
                    JarScannerCallback callback)

      Scan the provided ServletContext and classloader for JAR files. Each JAR file found will be passed to the callback handler to be processed.
      Parameters:
        `scanType` - The type of JAR scan to perform. This is passed to the filter which uses it to determine how to filter the results
        `context` - The ServletContext - used to locate and access WEB-INF/lib
        `callback` - The handler to process any JARs found

    - #### getJarScanFilter

          JarScanFilter getJarScanFilter()

    - #### setJarScanFilter

          void setJarScanFilter(JarScanFilter jarScanFilter)

Copyright © 2000-2020 Apache Software Foundation. All Rights Reserved.