Tomcat 10.1.19 · org.apache.catalina.WebResource · APIdia, the JavaDoc alternative

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: `java.io.File#canRead()`. canRead()
public boolean	Returns: `java.io.File#delete()`. delete()
public boolean	Returns: `java.io.File#exists()`. exists()
public String	Returns: `java.io.File#getCanonicalPath()`. getCanonicalPath()
public Certificate[]	Returns: the certificates that were used to sign this resource to verify it or @null if none. getCertificates()
public URL	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. getCodeBase()
public byte[]	Returns: the binary content of this resource or `null` if it is not available in a byte[] because, for example, it is too big. getContent()
public long	Returns: `java.io.File#length()`. getContentLength()
public long	Returns: The time the file was created. If not available, the result of `getLastModified()` will be returned. getCreation()
public String	Returns: The ETag for this resource 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	Returns: An InputStream based on the contents of this resource or `null` if the resource does not exist or does not represent a file getInputStream() Obtain an InputStream based on the contents of this resource.
public long	Returns: `java.io.File#lastModified()`. getLastModified()
public String	Returns: the last modified time of this resource in the correct format for the HTTP Last-Modified header as specified by RFC 2616. getLastModifiedHttp()
public Manifest	Returns: the manifest associated with this resource or @null if none. getManifest()
public String	Returns: the MIME type for this Resource. getMimeType()
public String	Returns: `java.io.File#getName()`. getName()
public URL	Returns: a URL to access the resource or `null` if no such URL is available or if the resource does not exist. getURL()
public String	Returns: The path of this resource relative to the web application root. If the resource is a directory, the return value will end in '/'. getWebappPath()
public WebResourceRoot	Returns: a reference to the WebResourceRoot of which this WebResource is a part. getWebResourceRoot()
public boolean	Returns: `java.io.File#isDirectory()`. isDirectory()
public boolean	Returns: `java.io.File#isFile()`. isFile()
public boolean	Returns: `true` for a virtual resource 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) Set the MIME type for this Resource.

Method Detail

canRead	back to summary
public boolean canRead() Returns:boolean `java.io.File#canRead()`.

delete	back to summary
public boolean delete() Returns:boolean `java.io.File#delete()`.

exists	back to summary
public boolean exists() Returns:boolean `java.io.File#exists()`.

getCanonicalPath	back to summary
public String getCanonicalPath() Returns:String `java.io.File#getCanonicalPath()`.

getCertificates	back to summary
public Certificate[] getCertificates() Returns:Certificate[] the certificates that were used to sign this resource to verify it or @null if none. See Also `java.util.jar.JarEntry#getCertificates()`

getCodeBase	back to summary
public URL getCodeBase() Returns:URL 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.

getContent	back to summary
public byte[] getContent() Returns:byte[] the binary content of this resource or `null` if it is not available in a byte[] because, for example, it is too big.

getContentLength	back to summary
public long getContentLength() Returns:long `java.io.File#length()`.

getCreation	back to summary
public long getCreation() Returns:long The time the file was created. If not available, the result of `getLastModified()` will be returned.

getETag	back to summary
public 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:String The ETag for this resource

getETag

back to summary

public 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:String: The ETag for this resource

getInputStream back to summary

getInputStream	back to summary
public InputStream getInputStream() Obtain an InputStream based on the contents of this resource. Returns:InputStream An InputStream based on the contents of this resource or `null` if the resource does not exist or does not represent a file

public InputStream getInputStream()

Obtain an InputStream based on the contents of this resource.

Returns:InputStream: An InputStream based on the contents of this resource or null if the resource does not exist or does not represent a file

getLastModified	back to summary
public long getLastModified() Returns:long `java.io.File#lastModified()`.

getLastModifiedHttp	back to summary
public String getLastModifiedHttp() Returns:String the last modified time of this resource in the correct format for the HTTP Last-Modified header as specified by RFC 2616.

getManifest	back to summary
public Manifest getManifest() Returns:Manifest the manifest associated with this resource or @null if none. See Also `java.util.jar.JarFile#getManifest()`

getMimeType	back to summary
public String getMimeType() Returns:String the MIME type for this Resource.

getName	back to summary
public String getName() Returns:String `java.io.File#getName()`.

getURL	back to summary
public URL getURL() Returns:URL a URL to access the resource or `null` if no such URL is available or if the resource does not exist.

getWebappPath	back to summary
public String getWebappPath() Returns:String The path of this resource relative to the web application root. If the resource is a directory, the return value will end in '/'.

getWebResourceRoot	back to summary
public WebResourceRoot getWebResourceRoot() Returns:WebResourceRoot a reference to the WebResourceRoot of which this WebResource is a part.

isDirectory	back to summary
public boolean isDirectory() Returns:boolean `java.io.File#isDirectory()`.

isFile	back to summary
public boolean isFile() Returns:boolean `java.io.File#isFile()`.

isVirtual back to summary

isVirtual	back to summary
public 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 additional `WebResourceSet`. 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:boolean `true` for a virtual resource

public 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 additional WebResourceSet. 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:boolean: true for a virtual resource

setMimeType	back to summary
public void setMimeType(String mimeType) Set the MIME type for this Resource. Parameters mimeType:String The mime type that will be associated with the resource

setMimeType

back to summary

public void setMimeType(String mimeType)

Set the MIME type for this Resource.

Parameters

mimeType:String: The mime type that will be associated with the resource

public Interface WebResource

Method Summary

Method Detail