Package org.apache.catalina.webresources
Class AbstractArchiveResourceSet
- java.lang.Object
- 
- org.apache.catalina.util.LifecycleBase
- 
- org.apache.catalina.webresources.AbstractResourceSet
- 
- org.apache.catalina.webresources.AbstractArchiveResourceSet
 
 
 
- 
- All Implemented Interfaces:
- Lifecycle,- WebResourceSet
 - Direct Known Subclasses:
- AbstractSingleArchiveResourceSet,- JarWarResourceSet
 
 public abstract class AbstractArchiveResourceSet extends AbstractResourceSet 
- 
- 
Nested Class Summary- 
Nested classes/interfaces inherited from interface org.apache.catalina.LifecycleLifecycle.SingleUse
 
- 
 - 
Field SummaryFields Modifier and Type Field Description protected java.util.Map<java.lang.String,java.util.jar.JarEntry>archiveEntriesprotected java.lang.ObjectarchiveLock- 
Fields inherited from class org.apache.catalina.webresources.AbstractResourceSetsm
 - 
Fields inherited from interface org.apache.catalina.LifecycleAFTER_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 SummaryConstructors Constructor Description AbstractArchiveResourceSet()
 - 
Method SummaryAll Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected voidcloseJarFile()protected abstract WebResourcecreateArchiveResource(java.util.jar.JarEntry jarEntry, java.lang.String webAppPath, java.util.jar.Manifest manifest)voidgc()Implementations may cache some information to improve performance.protected abstract java.util.Map<java.lang.String,java.util.jar.JarEntry>getArchiveEntries(boolean single)Obtain the map of entries in the archive.protected abstract java.util.jar.JarEntrygetArchiveEntry(java.lang.String pathInArchive)Obtain a single entry from the archive.java.net.URLgetBaseUrl()Obtain the base URL for this set of resources.protected java.lang.StringgetBaseUrlString()WebResourcegetResource(java.lang.String path)Obtain the object that represents the resource at the given path.protected abstract booleanisMultiRelease()booleanisReadOnly()Obtains the current value of the read-only setting for this set of resources.java.lang.String[]list(java.lang.String path)Obtain the list of the names of all of the files and directories located in the specified directory.java.util.Set<java.lang.String>listWebAppPaths(java.lang.String path)Obtain the Set of the web applications pathnames of all of the files and directories located in the specified directory.booleanmkdir(java.lang.String path)Create a new directory at the given path.protected java.util.jar.JarFileopenJarFile()protected voidsetBaseUrl(java.net.URL baseUrl)voidsetReadOnly(boolean readOnly)Configures whether or not this set of resources is read-only.booleanwrite(java.lang.String path, java.io.InputStream is, boolean overwrite)Create a new resource at the requested path using the provided InputStream.- 
Methods inherited from class org.apache.catalina.webresources.AbstractResourceSetcheckPath, 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.LifecycleBaseaddLifecycleListener, destroy, findLifecycleListeners, fireLifecycleEvent, getState, getStateName, getThrowOnFailure, init, initInternal, removeLifecycleListener, setState, setState, setThrowOnFailure, start, stop
 - 
Methods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 - 
Methods inherited from interface org.apache.catalina.LifecycleaddLifecycleListener, destroy, findLifecycleListeners, getState, getStateName, init, removeLifecycleListener, start, stop
 
- 
 
- 
- 
- 
Method Detail- 
setBaseUrlprotected final void setBaseUrl(java.net.URL baseUrl) 
 - 
getBaseUrlpublic final java.net.URL getBaseUrl() Description copied from interface:WebResourceSetObtain the base URL for this set of resources. One of the uses of this is to grant read permissions to the resources when running under a security manager.- Returns:
- The base URL for this set of resources
 
 - 
getBaseUrlStringprotected final java.lang.String getBaseUrlString() 
 - 
listpublic final java.lang.String[] list(java.lang.String path) Description copied from interface:WebResourceSetObtain the list of the names of all of the files and directories located in the specified directory.- Parameters:
- path- The path for the resource of interest relative to the root of the web application. It must start with '/'.
- Returns:
- The list of resources. If path does not refer to a directory then a zero length array will be returned.
 
 - 
listWebAppPathspublic final java.util.Set<java.lang.String> listWebAppPaths(java.lang.String path) Description copied from interface:WebResourceSetObtain the Set of the web applications pathnames of all of the files and directories located in the specified directory. Paths representing directories will end with a "/" character.- Parameters:
- path- The path for the resource of interest relative to the root of the web application. It must start with '/'.
- Returns:
- The Set of resources. If path does not refer to a directory then an empty set will be returned.
 
 - 
getArchiveEntriesprotected abstract java.util.Map<java.lang.String,java.util.jar.JarEntry> getArchiveEntries(boolean single) Obtain the map of entries in the archive. May return null in which casegetArchiveEntry(String)should be used.- 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 getArchiveEntry(String)should be used.
 
 - 
getArchiveEntryprotected abstract java.util.jar.JarEntry getArchiveEntry(java.lang.String pathInArchive) Obtain a single entry from the archive. For performance reasons,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.- Parameters:
- pathInArchive- The path in the archive of the entry required
- Returns:
- The specified archive entry or null if it does not exist
 
 - 
mkdirpublic final boolean mkdir(java.lang.String path) Description copied from interface:WebResourceSetCreate a new directory at the given path.- Parameters:
- path- The path for the new resource to create relative to the root of the web application. It must start with '/'.
- Returns:
- trueif the directory was created, otherwise- false
 
 - 
writepublic final boolean write(java.lang.String path, java.io.InputStream is, boolean overwrite)Description copied from interface:WebResourceSetCreate a new resource at the requested path using the provided InputStream.- Parameters:
- path- The path to be used for the new Resource. It is relative to the root of the web application and must start with '/'.
- is- The InputStream that will provide the content for the new Resource.
- overwrite- If- trueand the resource already exists it will be overwritten. If- falseand the resource already exists the write will fail.
- Returns:
- trueif and only if the new Resource is written
 
 - 
getResourcepublic final WebResource getResource(java.lang.String path) Description copied from interface:WebResourceSetObtain the object that represents the resource at the given path. Note the resource at that path may not exist.- Parameters:
- path- The path for the resource of interest relative to the root of the web application. It must start with '/'.
- Returns:
- The object that represents the resource at the given path
 
 - 
isMultiReleaseprotected abstract boolean isMultiRelease() 
 - 
createArchiveResourceprotected abstract WebResource createArchiveResource(java.util.jar.JarEntry jarEntry, java.lang.String webAppPath, java.util.jar.Manifest manifest) 
 - 
isReadOnlypublic final boolean isReadOnly() Description copied from interface:WebResourceSetObtains the current value of the read-only setting for this set of resources.- Returns:
- trueif this set of resources is configured to be read-only, otherwise- false
 
 - 
setReadOnlypublic void setReadOnly(boolean readOnly) Description copied from interface:WebResourceSetConfigures whether or not this set of resources is read-only.- Parameters:
- readOnly-- trueif this set of resources should be configured to be read-only
 
 - 
openJarFileprotected java.util.jar.JarFile openJarFile() throws java.io.IOException- Throws:
- java.io.IOException
 
 - 
closeJarFileprotected void closeJarFile() 
 - 
gcpublic void gc() Description copied from interface:WebResourceSetImplementations may cache some information to improve performance. This method triggers the clean-up of those resources.
 
- 
 
-