Package org.apache.catalina
Interface WebResource
-
- All Known Implementing Classes:
AbstractArchiveResource
,AbstractResource
,AbstractSingleArchiveResource
,CachedResource
,EmptyResource
,FileResource
,JarResource
,JarResourceRoot
,JarWarResource
,VirtualResource
,WarResource
public interface WebResource
Represents a file or directory within a web application. It borrows heavily fromFile
.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
canRead()
boolean
delete()
boolean
exists()
java.lang.String
getCanonicalPath()
java.security.cert.Certificate[]
getCertificates()
java.net.URL
getCodeBase()
byte[]
getContent()
long
getContentLength()
long
getCreation()
java.lang.String
getETag()
Return the strong ETag if available (currently not supported) else return the weak ETag calculated from the content length and last modified.java.io.InputStream
getInputStream()
Obtain an InputStream based on the contents of this resource.long
getLastModified()
java.lang.String
getLastModifiedHttp()
java.util.jar.Manifest
getManifest()
java.lang.String
getMimeType()
java.lang.String
getName()
java.net.URL
getURL()
java.lang.String
getWebappPath()
WebResourceRoot
getWebResourceRoot()
boolean
isDirectory()
boolean
isFile()
boolean
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 additionalWebResourceSet
.void
setMimeType(java.lang.String mimeType)
Set the MIME type for this Resource.
-
-
-
Method Detail
-
getLastModified
long getLastModified()
- Returns:
File.lastModified()
.
-
getLastModifiedHttp
java.lang.String getLastModifiedHttp()
- Returns:
- the last modified time of this resource in the correct format for the HTTP Last-Modified header as specified by RFC 2616.
-
exists
boolean exists()
- Returns:
File.exists()
.
-
isVirtual
boolean 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 additionalWebResourceSet
. For example, if an external directory is mapped to /WEB-INF/lib in an otherwise empty web application, /WEB-INF will be represented as a virtual resource.- Returns:
true
for a virtual resource
-
isDirectory
boolean isDirectory()
- Returns:
File.isDirectory()
.
-
isFile
boolean isFile()
- Returns:
File.isFile()
.
-
delete
boolean delete()
- Returns:
File.delete()
.
-
getName
java.lang.String getName()
- Returns:
File.getName()
.
-
getContentLength
long getContentLength()
- Returns:
File.length()
.
-
getCanonicalPath
java.lang.String getCanonicalPath()
- Returns:
File.getCanonicalPath()
.
-
canRead
boolean canRead()
- Returns:
File.canRead()
.
-
getWebappPath
java.lang.String getWebappPath()
- Returns:
- The path of this resource relative to the web application root. If the resource is a directory, the return value will end in '/'.
-
getETag
java.lang.String getETag()
Return the strong ETag if available (currently not supported) else return the weak ETag calculated from the content length and last modified.- Returns:
- The ETag for this resource
-
setMimeType
void setMimeType(java.lang.String mimeType)
Set the MIME type for this Resource.- Parameters:
mimeType
- The mime type that will be associated with the resource
-
getMimeType
java.lang.String getMimeType()
- Returns:
- the MIME type for this Resource.
-
getInputStream
java.io.InputStream getInputStream()
Obtain an InputStream based on the contents of this resource.- Returns:
- An InputStream based on the contents of this resource or
null
if the resource does not exist or does not represent a file
-
getContent
byte[] getContent()
- Returns:
- the binary content of this resource or
null
if it is not available in a byte[] because, for example, it is too big.
-
getCreation
long getCreation()
- Returns:
- The time the file was created. If not available, the result of
getLastModified()
will be returned.
-
getURL
java.net.URL getURL()
- Returns:
- a URL to access the resource or
null
if no such URL is available or if the resource does not exist.
-
getCodeBase
java.net.URL getCodeBase()
- Returns:
- the code base for this resource that will be used when looking up the assigned permissions for the code base in the security policy file when running under a security manager.
-
getWebResourceRoot
WebResourceRoot getWebResourceRoot()
- Returns:
- a reference to the WebResourceRoot of which this WebResource is a part.
-
getCertificates
java.security.cert.Certificate[] getCertificates()
- Returns:
- the certificates that were used to sign this resource to verify it or @null if none.
- See Also:
JarEntry.getCertificates()
-
getManifest
java.util.jar.Manifest getManifest()
- Returns:
- the manifest associated with this resource or @null if none.
- See Also:
JarFile.getManifest()
-
-