Package org.apache.catalina.webresources
Class EmptyResource
- java.lang.Object
-
- org.apache.catalina.webresources.EmptyResource
-
- All Implemented Interfaces:
WebResource
- Direct Known Subclasses:
VirtualResource
public class EmptyResource extends java.lang.Object implements WebResource
-
-
Constructor Summary
Constructors Constructor Description EmptyResource(WebResourceRoot root, java.lang.String webAppPath)EmptyResource(WebResourceRoot root, java.lang.String webAppPath, java.io.File file)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleancanRead()booleandelete()booleanexists()java.lang.StringgetCanonicalPath()java.security.cert.Certificate[]getCertificates()java.net.URLgetCodeBase()byte[]getContent()longgetContentLength()longgetCreation()java.lang.StringgetETag()Return the strong ETag if available (currently not supported) else return the weak ETag calculated from the content length and last modified.java.io.InputStreamgetInputStream()Obtain an InputStream based on the contents of this resource.longgetLastModified()java.lang.StringgetLastModifiedHttp()java.util.jar.ManifestgetManifest()java.lang.StringgetMimeType()java.lang.StringgetName()java.net.URLgetURL()java.lang.StringgetWebappPath()WebResourceRootgetWebResourceRoot()booleanisDirectory()booleanisFile()booleanisVirtual()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.voidsetMimeType(java.lang.String mimeType)Set the MIME type for this Resource.
-
-
-
Constructor Detail
-
EmptyResource
public EmptyResource(WebResourceRoot root, java.lang.String webAppPath)
-
EmptyResource
public EmptyResource(WebResourceRoot root, java.lang.String webAppPath, java.io.File file)
-
-
Method Detail
-
getLastModified
public long getLastModified()
- Specified by:
getLastModifiedin interfaceWebResource- Returns:
File.lastModified().
-
getLastModifiedHttp
public java.lang.String getLastModifiedHttp()
- Specified by:
getLastModifiedHttpin interfaceWebResource- Returns:
- the last modified time of this resource in the correct format for the HTTP Last-Modified header as specified by RFC 2616.
-
exists
public boolean exists()
- Specified by:
existsin interfaceWebResource- Returns:
File.exists().
-
isVirtual
public boolean isVirtual()
Description copied from interface:WebResourceIndicates 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.- Specified by:
isVirtualin interfaceWebResource- Returns:
truefor a virtual resource
-
isDirectory
public boolean isDirectory()
- Specified by:
isDirectoryin interfaceWebResource- Returns:
File.isDirectory().
-
isFile
public boolean isFile()
- Specified by:
isFilein interfaceWebResource- Returns:
File.isFile().
-
delete
public boolean delete()
- Specified by:
deletein interfaceWebResource- Returns:
File.delete().
-
getName
public java.lang.String getName()
- Specified by:
getNamein interfaceWebResource- Returns:
File.getName().
-
getContentLength
public long getContentLength()
- Specified by:
getContentLengthin interfaceWebResource- Returns:
File.length().
-
getCanonicalPath
public java.lang.String getCanonicalPath()
- Specified by:
getCanonicalPathin interfaceWebResource- Returns:
File.getCanonicalPath().
-
canRead
public boolean canRead()
- Specified by:
canReadin interfaceWebResource- Returns:
File.canRead().
-
getWebappPath
public java.lang.String getWebappPath()
- Specified by:
getWebappPathin interfaceWebResource- 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
public java.lang.String getETag()
Description copied from interface:WebResourceReturn the strong ETag if available (currently not supported) else return the weak ETag calculated from the content length and last modified.- Specified by:
getETagin interfaceWebResource- Returns:
- The ETag for this resource
-
setMimeType
public void setMimeType(java.lang.String mimeType)
Description copied from interface:WebResourceSet the MIME type for this Resource.- Specified by:
setMimeTypein interfaceWebResource- Parameters:
mimeType- The mime type that will be associated with the resource
-
getMimeType
public java.lang.String getMimeType()
- Specified by:
getMimeTypein interfaceWebResource- Returns:
- the MIME type for this Resource.
-
getInputStream
public java.io.InputStream getInputStream()
Description copied from interface:WebResourceObtain an InputStream based on the contents of this resource.- Specified by:
getInputStreamin interfaceWebResource- Returns:
- An InputStream based on the contents of this resource or
nullif the resource does not exist or does not represent a file
-
getContent
public byte[] getContent()
- Specified by:
getContentin interfaceWebResource- Returns:
- the binary content of this resource or
nullif it is not available in a byte[] because, for example, it is too big.
-
getCreation
public long getCreation()
- Specified by:
getCreationin interfaceWebResource- Returns:
- The time the file was created. If not available, the result of
WebResource.getLastModified()will be returned.
-
getURL
public java.net.URL getURL()
- Specified by:
getURLin interfaceWebResource- Returns:
- a URL to access the resource or
nullif no such URL is available or if the resource does not exist.
-
getCodeBase
public java.net.URL getCodeBase()
- Specified by:
getCodeBasein interfaceWebResource- 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.
-
getCertificates
public java.security.cert.Certificate[] getCertificates()
- Specified by:
getCertificatesin interfaceWebResource- Returns:
- the certificates that were used to sign this resource to verify it or @null if none.
- See Also:
JarEntry.getCertificates()
-
getManifest
public java.util.jar.Manifest getManifest()
- Specified by:
getManifestin interfaceWebResource- Returns:
- the manifest associated with this resource or @null if none.
- See Also:
JarFile.getManifest()
-
getWebResourceRoot
public WebResourceRoot getWebResourceRoot()
- Specified by:
getWebResourceRootin interfaceWebResource- Returns:
- a reference to the WebResourceRoot of which this WebResource is a part.
-
-