org.apache.catalina.webresources

Class JarResourceSet

java.lang.Object

org.apache.catalina.util.LifecycleBase

org.apache.catalina.webresources.AbstractResourceSet

org.apache.catalina.webresources.AbstractArchiveResourceSet

org.apache.catalina.webresources.JarResourceSet

All Implemented Interfaces:

Lifecycle, WebResourceSet

public class JarResourceSet
extends AbstractArchiveResourceSet

Represents a WebResourceSet based on a JAR file.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.catalina.Lifecycle

Lifecycle.SingleUse

Field Summary

Fields inherited from class org.apache.catalina.webresources.AbstractArchiveResourceSet

archiveEntries, archiveLock

Fields inherited from class org.apache.catalina.webresources.AbstractResourceSet

sm

Fields inherited from interface org.apache.catalina.Lifecycle

AFTER_DESTROY_EVENT, AFTER_INIT_EVENT, AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_DESTROY_EVENT, BEFORE_INIT_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, CONFIGURE_START_EVENT, CONFIGURE_STOP_EVENT, PERIODIC_EVENT, START_EVENT, STOP_EVENT

Constructor Summary

Constructors

Constructor and Description
JarResourceSet() A no argument constructor is required for this to work with the digester.
JarResourceSet(WebResourceRoot root, String webAppMount, String base, String internalPath) Creates a new WebResourceSet based on a JAR file.

Method Summary

Modifier and Type	Method and Description
protected WebResource	createArchiveResource(JarEntry jarEntry, String webAppPath, Manifest manifest)
protected HashMap<String,JarEntry>	getArchiveEntries(boolean single) Obtain the map of entries in the archive.
protected JarEntry	getArchiveEntry(String pathInArchive) Obtain a single entry from the archive.
protected void	initInternal()

Methods inherited from class org.apache.catalina.webresources.AbstractArchiveResourceSet

closeJarFile, gc, getBaseUrl, getBaseUrlString, getResource, isReadOnly, list, listWebAppPaths, mkdir, openJarFile, setBaseUrl, setReadOnly, write

Methods inherited from class org.apache.catalina.webresources.AbstractResourceSet

checkPath, destroyInternal, getBase, getClassLoaderOnly, getInternalPath, getManifest, getRoot, getStaticOnly, getWebAppMount, setBase, setClassLoaderOnly, setInternalPath, setManifest, setRoot, setStaticOnly, setWebAppMount, startInternal, stopInternal

Methods inherited from class org.apache.catalina.util.LifecycleBase

addLifecycleListener, destroy, findLifecycleListeners, fireLifecycleEvent, getState, getStateName, init, removeLifecycleListener, setState, setState, start, stop

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.catalina.Lifecycle

addLifecycleListener, destroy, findLifecycleListeners, getState, getStateName, init, removeLifecycleListener, start, stop

Constructor Detail

JarResourceSet

public JarResourceSet()

A no argument constructor is required for this to work with the digester.

JarResourceSet

public JarResourceSet(WebResourceRoot root,
                      String webAppMount,
                      String base,
                      String internalPath)
               throws IllegalArgumentException

Creates a new WebResourceSet based on a JAR file.

Parameters:

root - The WebResourceRoot this new WebResourceSet will be added to.

webAppMount - The path within the web application at which this WebResourceSet will be mounted.

base - The absolute path to the JAR file on the file system from which the resources will be served.

internalPath - The path within this new WebResourceSet where resources will be served from. E.g. for a resource JAR, this would be "META-INF/resources"

Throws:

IllegalArgumentException - if the webAppMount or internalPath is not valid (valid paths must start with '/')

Method Detail

createArchiveResource

protected WebResource createArchiveResource(JarEntry jarEntry,
                                            String webAppPath,
                                            Manifest manifest)

Specified by:

createArchiveResource in class AbstractArchiveResourceSet

getArchiveEntries

protected HashMap<String,JarEntry> getArchiveEntries(boolean single)

Description copied from class: AbstractArchiveResourceSet

Obtain the map of entries in the archive. May return null in which case AbstractArchiveResourceSet.getArchiveEntry(String) should be used.

Specified by:

getArchiveEntries in class AbstractArchiveResourceSet

Parameters:

single - Is this request being make to support a single lookup? If false, a map will always be returned. If true, implementations may use this as a hint in determining the optimum way to respond.

Returns:

The archives entries mapped to their names or null if AbstractArchiveResourceSet.getArchiveEntry(String) should be used.

getArchiveEntry

protected JarEntry getArchiveEntry(String pathInArchive)

Description copied from class: AbstractArchiveResourceSet

Obtain a single entry from the archive. For performance reasons, AbstractArchiveResourceSet.getArchiveEntries(boolean) should always be called first and the archive entry looked up in the map if one is returned. Only if that call returns null should this method be used.

Specified by:

getArchiveEntry in class AbstractArchiveResourceSet

Parameters:

pathInArchive - The path in the archive of the entry required

Returns:

The specified archive entry or null if it does not exist

initInternal

protected void initInternal()
                     throws LifecycleException

Specified by:

initInternal in class LifecycleBase

Throws:

LifecycleException