Class AbstractSingleArchiveResourceSet
java.lang.Object
org.apache.catalina.util.LifecycleBase
org.apache.catalina.webresources.AbstractResourceSet
org.apache.catalina.webresources.AbstractArchiveResourceSet
org.apache.catalina.webresources.AbstractSingleArchiveResourceSet
- All Implemented Interfaces:
Lifecycle,WebResourceSet
- Direct Known Subclasses:
JarResourceSet,WarResourceSet
Base class for a
WebResourceSet based on a single, rather than nested, archive.-
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, archiveLockFields inherited from class org.apache.catalina.webresources.AbstractResourceSet
smFields 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
ConstructorsConstructorDescriptionA no argument constructor is required for this to work with the digester.AbstractSingleArchiveResourceSet(WebResourceRoot root, String webAppMount, String base, String internalPath) -
Method Summary
Modifier and TypeMethodDescriptiongetArchiveEntries(boolean single) Obtain the map of entries in the archive.protected JarEntrygetArchiveEntry(String pathInArchive) Obtain a single entry from the archive.protected voidSubclasses implement this method to perform any instance initialisation required.protected booleanMethods inherited from class org.apache.catalina.webresources.AbstractArchiveResourceSet
closeJarFile, createArchiveResource, gc, getAllowLinking, getBaseUrl, getBaseUrlString, getResource, isReadOnly, list, listWebAppPaths, mkdir, openJarFile, setAllowLinking, setBaseUrl, setReadOnly, writeMethods 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, stopInternalMethods inherited from class org.apache.catalina.util.LifecycleBase
addLifecycleListener, destroy, findLifecycleListeners, fireLifecycleEvent, getState, getStateName, getThrowOnFailure, init, removeLifecycleListener, setState, setState, setThrowOnFailure, start, stopMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.apache.catalina.Lifecycle
addLifecycleListener, destroy, findLifecycleListeners, getState, getStateName, init, removeLifecycleListener, start, stop
-
Constructor Details
-
AbstractSingleArchiveResourceSet
public AbstractSingleArchiveResourceSet()A no argument constructor is required for this to work with the digester. -
AbstractSingleArchiveResourceSet
public AbstractSingleArchiveResourceSet(WebResourceRoot root, String webAppMount, String base, String internalPath) throws IllegalArgumentException - Throws:
IllegalArgumentException
-
-
Method Details
-
getArchiveEntries
Description copied from class:AbstractArchiveResourceSetObtain the map of entries in the archive. May return null in which caseAbstractArchiveResourceSet.getArchiveEntry(String)should be used.- Specified by:
getArchiveEntriesin classAbstractArchiveResourceSet- 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
Description copied from class:AbstractArchiveResourceSetObtain 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:
getArchiveEntryin classAbstractArchiveResourceSet- Parameters:
pathInArchive- The path in the archive of the entry required- Returns:
- The specified archive entry or null if it does not exist
-
isMultiRelease
protected boolean isMultiRelease()- Specified by:
isMultiReleasein classAbstractArchiveResourceSet
-
initInternal
Description copied from class:LifecycleBaseSubclasses implement this method to perform any instance initialisation required.- Specified by:
initInternalin classLifecycleBase- Throws:
LifecycleException- If the initialisation fails
-