Tomcat 10.1.19 · org.apache.catalina.webresources.EmptyResource

Modifier and Type	Field and Description
private final File	file
private final WebResourceRoot	root
private final String	webAppPath

Access	Constructor and Description
public	EmptyResource(WebResourceRoot root, String webAppPath)
public	EmptyResource(WebResourceRoot root, String webAppPath, File file)

Modifier and Type	Method and Description
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.
public URL	getURL() Implements org.apache.catalina.WebResource.getURL.
public String	getWebappPath() Implements org.apache.catalina.WebResource.getWebappPath.
public WebResourceRoot	getWebResourceRoot() Implements org.apache.catalina.WebResource.getWebResourceRoot.
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.

file	back to summary
private final File file

root	back to summary
private final WebResourceRoot root

webAppPath	back to summary
private final String webAppPath

EmptyResource	back to summary
public EmptyResource(WebResourceRoot root, String webAppPath)

EmptyResource	back to summary
public EmptyResource(WebResourceRoot root, String webAppPath, File file)

Method Detail

canRead back to summary

canRead	back to summary
public boolean canRead() Implements org.apache.catalina.WebResource.canRead. Returns:boolean Doc from org.apache.catalina.WebResource.canRead. `java.io.File#canRead()`. Annotations @Override

public boolean canRead()

Implements org.apache.catalina.WebResource.canRead.

Returns:boolean

Doc from org.apache.catalina.WebResource.canRead.

java.io.File#canRead().

Annotations

@Override

delete back to summary

delete	back to summary
public boolean delete() Implements org.apache.catalina.WebResource.delete. Returns:boolean Doc from org.apache.catalina.WebResource.delete. `java.io.File#delete()`. Annotations @Override

public boolean delete()

Implements org.apache.catalina.WebResource.delete.

Returns:boolean

Doc from org.apache.catalina.WebResource.delete.

java.io.File#delete().

Annotations

@Override

exists back to summary

exists	back to summary
public boolean exists() Implements org.apache.catalina.WebResource.exists. Returns:boolean Doc from org.apache.catalina.WebResource.exists. `java.io.File#exists()`. Annotations @Override

public boolean exists()

Implements org.apache.catalina.WebResource.exists.

Returns:boolean

Doc from org.apache.catalina.WebResource.exists.

java.io.File#exists().

Annotations

@Override

getCanonicalPath back to summary

getCanonicalPath	back to summary
public String getCanonicalPath() Implements org.apache.catalina.WebResource.getCanonicalPath. Returns:String Doc from org.apache.catalina.WebResource.getCanonicalPath. `java.io.File#getCanonicalPath()`. Annotations @Override

public String getCanonicalPath()

Implements org.apache.catalina.WebResource.getCanonicalPath.

Returns:String

Doc from org.apache.catalina.WebResource.getCanonicalPath.

java.io.File#getCanonicalPath().

Annotations

@Override

getCertificates	back to summary
public Certificate[] getCertificates() Implements org.apache.catalina.WebResource.getCertificates. Returns:Certificate[] Doc from org.apache.catalina.WebResource.getCertificates. the certificates that were used to sign this resource to verify it or @null if none. Annotations @Override

getCertificates

back to summary

public Certificate[] getCertificates()

Implements org.apache.catalina.WebResource.getCertificates.

Returns:Certificate[]

Doc from org.apache.catalina.WebResource.getCertificates.

the certificates that were used to sign this resource to verify it or @null if none.

Annotations

@Override

getCodeBase	back to summary
public URL getCodeBase() Implements org.apache.catalina.WebResource.getCodeBase. Returns:URL Doc from org.apache.catalina.WebResource.getCodeBase. 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. Annotations @Override

getCodeBase

back to summary

public URL getCodeBase()

Implements org.apache.catalina.WebResource.getCodeBase.

Returns:URL

Doc from org.apache.catalina.WebResource.getCodeBase.

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.

Annotations

@Override

getContent back to summary

getContent	back to summary
public byte[] getContent() Implements org.apache.catalina.WebResource.getContent. Returns:byte[] Doc from org.apache.catalina.WebResource.getContent. the binary content of this resource or `null` if it is not available in a byte[] because, for example, it is too big. Annotations @Override

public byte[] getContent()

Implements org.apache.catalina.WebResource.getContent.

Returns:byte[]

Doc from org.apache.catalina.WebResource.getContent.

the binary content of this resource or null if it is not available in a byte[] because, for example, it is too big.

Annotations

@Override

getContentLength back to summary

getContentLength	back to summary
public long getContentLength() Implements org.apache.catalina.WebResource.getContentLength. Returns:long Doc from org.apache.catalina.WebResource.getContentLength. `java.io.File#length()`. Annotations @Override

public long getContentLength()

Implements org.apache.catalina.WebResource.getContentLength.

Returns:long

Doc from org.apache.catalina.WebResource.getContentLength.

java.io.File#length().

Annotations

@Override

getCreation back to summary

getCreation	back to summary
public long getCreation() Implements org.apache.catalina.WebResource.getCreation. Returns:long Doc from org.apache.catalina.WebResource.getCreation. The time the file was created. If not available, the result of `getLastModified()` will be returned. Annotations @Override

public long getCreation()

Implements org.apache.catalina.WebResource.getCreation.

Returns:long

Doc from org.apache.catalina.WebResource.getCreation.

The time the file was created. If not available, the result of getLastModified() will be returned.

Annotations

@Override

getETag	back to summary
public String getETag() Implements org.apache.catalina.WebResource.getETag. Doc from 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. Returns:String The ETag for this resource Annotations @Override

getETag

back to summary

public String getETag()

Implements org.apache.catalina.WebResource.getETag.

Doc from 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.

Returns:String

The ETag for this resource

Annotations

@Override

getInputStream back to summary

getInputStream	back to summary
public InputStream getInputStream() Implements org.apache.catalina.WebResource.getInputStream. Doc from org.apache.catalina.WebResource.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 Annotations @Override

public InputStream getInputStream()

Implements org.apache.catalina.WebResource.getInputStream.

Doc from org.apache.catalina.WebResource.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

Annotations

@Override

getLastModified back to summary

getLastModified	back to summary
public long getLastModified() Implements org.apache.catalina.WebResource.getLastModified. Returns:long Doc from org.apache.catalina.WebResource.getLastModified. `java.io.File#lastModified()`. Annotations @Override

public long getLastModified()

Implements org.apache.catalina.WebResource.getLastModified.

Returns:long

Doc from org.apache.catalina.WebResource.getLastModified.

java.io.File#lastModified().

Annotations

@Override

getLastModifiedHttp	back to summary
public String getLastModifiedHttp() Implements org.apache.catalina.WebResource.getLastModifiedHttp. Returns:String Doc from org.apache.catalina.WebResource.getLastModifiedHttp. the last modified time of this resource in the correct format for the HTTP Last-Modified header as specified by RFC 2616. Annotations @Override

getLastModifiedHttp

back to summary

public String getLastModifiedHttp()

Implements org.apache.catalina.WebResource.getLastModifiedHttp.

Returns:String

Doc from org.apache.catalina.WebResource.getLastModifiedHttp.

the last modified time of this resource in the correct format for the HTTP Last-Modified header as specified by RFC 2616.

Annotations

@Override

getManifest	back to summary
public Manifest getManifest() Implements org.apache.catalina.WebResource.getManifest. Returns:Manifest Doc from org.apache.catalina.WebResource.getManifest. the manifest associated with this resource or @null if none. Annotations @Override

getManifest

back to summary

public Manifest getManifest()

Implements org.apache.catalina.WebResource.getManifest.

Returns:Manifest

Doc from org.apache.catalina.WebResource.getManifest.

the manifest associated with this resource or @null if none.

Annotations

@Override

getMimeType	back to summary
public String getMimeType() Implements org.apache.catalina.WebResource.getMimeType. Returns:String Doc from org.apache.catalina.WebResource.getMimeType. the MIME type for this Resource. Annotations @Override

getMimeType

back to summary

public String getMimeType()

Implements org.apache.catalina.WebResource.getMimeType.

Returns:String

Doc from org.apache.catalina.WebResource.getMimeType.

the MIME type for this Resource.

Annotations

@Override

getName back to summary

getName	back to summary
public String getName() Implements org.apache.catalina.WebResource.getName. Returns:String Doc from org.apache.catalina.WebResource.getName. `java.io.File#getName()`. Annotations @Override

public String getName()

Implements org.apache.catalina.WebResource.getName.

Returns:String

Doc from org.apache.catalina.WebResource.getName.

java.io.File#getName().

Annotations

@Override

getURL back to summary

getURL	back to summary
public URL getURL() Implements org.apache.catalina.WebResource.getURL. Returns:URL Doc from org.apache.catalina.WebResource.getURL. a URL to access the resource or `null` if no such URL is available or if the resource does not exist. Annotations @Override

public URL getURL()

Implements org.apache.catalina.WebResource.getURL.

Returns:URL

Doc from org.apache.catalina.WebResource.getURL.

a URL to access the resource or null if no such URL is available or if the resource does not exist.

Annotations

@Override

getWebappPath	back to summary
public String getWebappPath() Implements org.apache.catalina.WebResource.getWebappPath. Returns:String Doc from org.apache.catalina.WebResource.getWebappPath. The path of this resource relative to the web application root. If the resource is a directory, the return value will end in '/'. Annotations @Override

getWebappPath

back to summary

public String getWebappPath()

Implements org.apache.catalina.WebResource.getWebappPath.

Returns:String

Doc from org.apache.catalina.WebResource.getWebappPath.

The path of this resource relative to the web application root. If the resource is a directory, the return value will end in '/'.

Annotations

@Override

getWebResourceRoot	back to summary
public WebResourceRoot getWebResourceRoot() Implements org.apache.catalina.WebResource.getWebResourceRoot. Returns:WebResourceRoot Doc from org.apache.catalina.WebResource.getWebResourceRoot. a reference to the WebResourceRoot of which this WebResource is a part. Annotations @Override

getWebResourceRoot

back to summary

public WebResourceRoot getWebResourceRoot()

Implements org.apache.catalina.WebResource.getWebResourceRoot.

Returns:WebResourceRoot

Doc from org.apache.catalina.WebResource.getWebResourceRoot.

a reference to the WebResourceRoot of which this WebResource is a part.

Annotations

@Override

isDirectory back to summary

isDirectory	back to summary
public boolean isDirectory() Implements org.apache.catalina.WebResource.isDirectory. Returns:boolean Doc from org.apache.catalina.WebResource.isDirectory. `java.io.File#isDirectory()`. Annotations @Override

public boolean isDirectory()

Implements org.apache.catalina.WebResource.isDirectory.

Returns:boolean

Doc from org.apache.catalina.WebResource.isDirectory.

java.io.File#isDirectory().

Annotations

@Override

isFile back to summary

isFile	back to summary
public boolean isFile() Implements org.apache.catalina.WebResource.isFile. Returns:boolean Doc from org.apache.catalina.WebResource.isFile. `java.io.File#isFile()`. Annotations @Override

public boolean isFile()

Implements org.apache.catalina.WebResource.isFile.

Returns:boolean

Doc from org.apache.catalina.WebResource.isFile.

java.io.File#isFile().

Annotations

@Override

isVirtual back to summary

isVirtual	back to summary
public boolean isVirtual() Implements org.apache.catalina.WebResource.isVirtual. Doc from 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`. 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 Annotations @Override

public boolean isVirtual()

Implements org.apache.catalina.WebResource.isVirtual.

Doc from 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. 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

Annotations

@Override

setMimeType	back to summary
public void setMimeType(String mimeType) Implements org.apache.catalina.WebResource.setMimeType. Doc from org.apache.catalina.WebResource.setMimeType. Set the MIME type for this Resource. Parameters mimeType:String The mime type that will be associated with the resource Annotations @Override

setMimeType

back to summary

public void setMimeType(String mimeType)

Implements org.apache.catalina.WebResource.setMimeType.

Doc from org.apache.catalina.WebResource.setMimeType.

Set the MIME type for this Resource.

Parameters

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

Annotations

@Override

public Class EmptyResource

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail