Top Description Inners Fields Constructors Methods
org.apache.catalina.webresources

public Class CachedResource

extends Object
implements WebResource
Class Inheritance
All Implemented Interfaces
org.apache.catalina.WebResource
Imports
java.io.ByteArrayInputStream, .IOException, .InputStream, java.net.JarURLConnection, .MalformedURLException, .URI, .URISyntaxException, .URL, .URLConnection, .URLStreamHandler, java.nio.charset.Charset, java.security.Permission, java.security.cert.Certificate, java.text.Collator, java.util.Arrays, .Locale, java.util.jar.JarFile, .Manifest, org.apache.catalina.WebResource, .WebResourceRoot, org.apache.juli.logging.Log, .LogFactory, org.apache.tomcat.util.res.StringManager
This class is designed to wrap a 'raw' WebResource and providing caching for expensive operations. Inexpensive operations may be passed through to the underlying resource.

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
CachedResource.CachedResourceJarURLConnection

private static class
CachedResource.CachedResourceURLConnection

private static class
CachedResource.CachedResourceURLStreamHandler

URLStreamHandler to handle a URL for a cached resource, delegating reads to the Cache.

Field Summary

Modifier and TypeField and Description
private final Cache
cache

private static final long
CACHE_ENTRY_SIZE

private volatile byte[]
cachedContent

private volatile Long
cachedContentLength

private volatile Boolean
cachedExists

private volatile Boolean
cachedIsDirectory

private volatile Boolean
cachedIsFile

private volatile Boolean
cachedIsVirtual

private volatile Long
cachedLastModified

private volatile String
cachedLastModifiedHttp

private static final Log
log

private volatile long
nextCheck

private final int
objectMaxSizeBytes

private final StandardRoot
root

private static final StringManager
sm

private final long
ttl

private final boolean
usesClassLoaderResources

private final String
webAppPath

private volatile WebResource
webResource

private volatile WebResource[]
webResources

Constructor Summary

AccessConstructor and Description
public
CachedResource(Cache cache, StandardRoot root, String path, long ttl, int objectMaxSizeBytes, boolean usesClassLoaderResources)

Method Summary

Modifier and TypeMethod and Description
private static InputStream
buildInputStream(String[] files)

public boolean
canRead()

Implements org.apache.catalina.WebResource.canRead.

public boolean
delete()

Implements org.apache.catalina.WebResource.delete.

public boolean
exists()

Implements org.apache.catalina.WebResource.exists.

public String
getCanonicalPath()

Implements org.apache.catalina.WebResource.getCanonicalPath.

public Certificate[]
getCertificates()

Implements org.apache.catalina.WebResource.getCertificates.

public URL
getCodeBase()

Implements org.apache.catalina.WebResource.getCodeBase.

public byte[]
getContent()

Implements org.apache.catalina.WebResource.getContent.

public long
getContentLength()

Implements org.apache.catalina.WebResource.getContentLength.

public long
getCreation()

Implements org.apache.catalina.WebResource.getCreation.

public String
getETag()

Implements org.apache.catalina.WebResource.getETag.

Return the strong ETag if available (currently not supported) else return the weak ETag calculated from the content length and last modified.

public InputStream
getInputStream()

Implements org.apache.catalina.WebResource.getInputStream.

Obtain an InputStream based on the contents of this resource.

public long
getLastModified()

Implements org.apache.catalina.WebResource.getLastModified.

public String
getLastModifiedHttp()

Implements org.apache.catalina.WebResource.getLastModifiedHttp.

public Manifest
getManifest()

Implements org.apache.catalina.WebResource.getManifest.

public String
getMimeType()

Implements org.apache.catalina.WebResource.getMimeType.

public String
getName()

Implements org.apache.catalina.WebResource.getName.

protected long
getNextCheck()

pack-priv long
getSize()

public URL
getURL()

Implements org.apache.catalina.WebResource.getURL.

public String
getWebappPath()

Implements org.apache.catalina.WebResource.getWebappPath.

pack-priv WebResource
getWebResource()

public WebResourceRoot
getWebResourceRoot()

Implements org.apache.catalina.WebResource.getWebResourceRoot.

pack-priv WebResource[]
getWebResources()

public boolean
isDirectory()

Implements org.apache.catalina.WebResource.isDirectory.

public boolean
isFile()

Implements org.apache.catalina.WebResource.isFile.

public boolean
isVirtual()

Implements org.apache.catalina.WebResource.isVirtual.

Indicates if this resource is required for applications to correctly scan the file structure but that does not exist in either the main or any additional WebResourceSet.

public void
setMimeType(String
The mime type that will be associated with the resource
mimeType)

Implements org.apache.catalina.WebResource.setMimeType.

Set the MIME type for this Resource.

pack-priv boolean
usesClassLoaderResources()

protected boolean
validateResource(boolean useClassLoaderResources)

protected boolean
validateResources(boolean useClassLoaderResources)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait