org.apache.tomcat.util.descriptor.web

Class FragmentJarScannerCallback

java.lang.Object

org.apache.tomcat.util.descriptor.web.FragmentJarScannerCallback

All Implemented Interfaces:

JarScannerCallback

public class FragmentJarScannerCallback
extends java.lang.Object
implements JarScannerCallback

Callback handling a web-fragment.xml descriptor.

Constructor Summary

Constructors

Constructor and Description
FragmentJarScannerCallback(WebXmlParser webXmlParser, boolean delegate, boolean parseRequired)

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,WebXml>	getFragments()
boolean	isOk()
void	scan(java.io.File file, java.lang.String webappPath, boolean isWebapp) A JAR was found (probably in an unpacked WAR or possibly elsewhere on the class path) and may be accessed for further processing via the provided file.
void	scan(java.net.JarURLConnection jarConn, java.lang.String webappPath, boolean isWebapp) A JAR was found (probably packaged in a WAR) and may be accessed for further processing via the provided URL connection.
void	scanWebInfClasses() A directory structure was found within the web application at /WEB-INF/classes that should be handled as an unpacked JAR.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FragmentJarScannerCallback

public FragmentJarScannerCallback(WebXmlParser webXmlParser,
                                  boolean delegate,
                                  boolean parseRequired)

Method Detail

scan

public void scan(java.net.JarURLConnection jarConn,
                 java.lang.String webappPath,
                 boolean isWebapp)
          throws java.io.IOException

Description copied from interface: JarScannerCallback

A JAR was found (probably packaged in a WAR) and may be accessed for further processing via the provided URL connection.

Specified by:

scan in interface JarScannerCallback

Parameters:

jarConn - The connection to the identified JAR

webappPath - The path, if any, to the JAR within the web application

isWebapp - Indicates if the JAR was found within a web application. If false the JAR should be treated as being provided by the container

Throws:

java.io.IOException

scan

public void scan(java.io.File file,
                 java.lang.String webappPath,
                 boolean isWebapp)
          throws java.io.IOException

Description copied from interface: JarScannerCallback

A JAR was found (probably in an unpacked WAR or possibly elsewhere on the class path) and may be accessed for further processing via the provided file.

Specified by:

scan in interface JarScannerCallback

Parameters:

file - The file for the identified JAR.

webappPath - The path, if any, to the file within the web application

isWebapp - Indicates if the JAR was found within a web application. If false the JAR should be treated as being provided by the container

Throws:

java.io.IOException

scanWebInfClasses

public void scanWebInfClasses()

Description copied from interface: JarScannerCallback

A directory structure was found within the web application at /WEB-INF/classes that should be handled as an unpacked JAR. Note that all resource access must be via the ServletContext to ensure that any additional resources are visible.

Specified by:

scanWebInfClasses in interface JarScannerCallback

isOk

public boolean isOk()

getFragments

public java.util.Map<java.lang.String,WebXml> getFragments()