Summary: Ctors | Methods | Inherited Methods | [Expand All]

public class

ServletContextResource

extends AbstractFileResolvingResource
implements ContextResource

java.lang.Object
↳	org.springframework.core.io.AbstractResource
	↳	org.springframework.core.io.AbstractFileResolvingResource
		↳	org.springframework.web.context.support.ServletContextResource

Class Overview

Resource implementation for javax.servlet.ServletContext resources, interpreting relative paths within the web application root directory.

Always supports stream access and URL access, but only allows java.io.File access when the web application archive is expanded.

Summary

Public Constructors
	ServletContextResource(ServletContext servletContext, String path) Create a new ServletContextResource.

Public Methods
Resource	createRelative(String relativePath) This implementation creates a ServletContextResource, applying the given path relative to the path of the underlying file of this resource descriptor.
boolean	equals(Object obj) This implementation compares the underlying ServletContext resource locations.
boolean	exists() This implementation checks `ServletContext.getResource`.
String	getDescription() This implementation returns a description that includes the ServletContext resource location.
File	getFile() This implementation delegates to `ServletContext.getRealPath`, but throws a FileNotFoundException if not found or not resolvable.
String	getFilename() This implementation returns the name of the file that this ServletContext resource refers to.
InputStream	getInputStream() This implementation delegates to `ServletContext.getResourceAsStream`, but throws a FileNotFoundException if no resource found.
final String	getPath() Return the path for this resource.
String	getPathWithinContext() Return the path within the enclosing 'context'.
final ServletContext	getServletContext() Return the ServletContext for this resource.
URL	getURL() This implementation delegates to `ServletContext.getResource`, but throws a FileNotFoundException if no resource found.
int	hashCode() This implementation returns the hash code of the underlying ServletContext resource location.

[Expand]

Inherited Methods

From class org.springframework.core.io.AbstractFileResolvingResource

From class org.springframework.core.io.AbstractResource

long	contentLength() This implementation checks the timestamp of the underlying File, if available.
Resource	createRelative(String relativePath) This implementation throws a FileNotFoundException, assuming that relative resources cannot be created for this resource.
boolean	equals(Object obj) This implementation compares description strings.
boolean	exists() This implementation checks whether a File can be opened, falling back to whether an InputStream can be opened.
File	getFile() This implementation throws a FileNotFoundException, assuming that the resource cannot be resolved to an absolute file path.
File	getFileForLastModifiedCheck() Determine the File to use for timestamp checking.
String	getFilename() This implementation always throws IllegalStateException, assuming that the resource does not have a filename.
URI	getURI() This implementation builds a URI based on the URL returned by `getURL()`.
URL	getURL() This implementation throws a FileNotFoundException, assuming that the resource cannot be resolved to a URL.
int	hashCode() This implementation returns the description's hash code.
boolean	isOpen() This implementation always returns `false`.
boolean	isReadable() This implementation always returns `true`.
long	lastModified() This implementation checks the timestamp of the underlying File, if available.
String	toString() This implementation returns the description of this resource.

From class java.lang.Object

From interface org.springframework.core.io.ContextResource

From interface org.springframework.core.io.InputStreamSource

From interface org.springframework.core.io.Resource

abstract long	contentLength() Determine the content length for this resource.
abstract Resource	createRelative(String relativePath) Create a resource relative to this resource.
abstract boolean	exists() Return whether this resource actually exists in physical form.
abstract String	getDescription() Return a description for this resource, to be used for error output when working with the resource.
abstract File	getFile() Return a File handle for this resource.
abstract String	getFilename() Return a filename for this resource, i.e.
abstract URI	getURI() Return a URI handle for this resource.
abstract URL	getURL() Return a URL handle for this resource.
abstract boolean	isOpen() Return whether this resource represents a handle with an open stream.
abstract boolean	isReadable() Return whether the contents of this resource can be read, e.g.
abstract long	lastModified() Determine the last-modified timestamp for this resource.

Public Constructors

public ServletContextResource (ServletContext servletContext, String path)

Create a new ServletContextResource.

The Servlet spec requires that resource paths start with a slash, even if many containers accept paths without leading slash too. Consequently, the given path will be prepended with a slash if it doesn't already start with one.

Parameters

servletContext	the ServletContext to load from
path	the path of the resource

Public Methods

public Resource createRelative (String relativePath)

This implementation creates a ServletContextResource, applying the given path relative to the path of the underlying file of this resource descriptor.

Parameters

relativePath	the relative path (relative to this resource)

Returns

the resource handle for the relative resource

public boolean equals (Object obj)

This implementation compares the underlying ServletContext resource locations.

public boolean exists ()

This implementation checks ServletContext.getResource.

public String getDescription ()

This implementation returns a description that includes the ServletContext resource location.

public File getFile ()

This implementation delegates to ServletContext.getRealPath, but throws a FileNotFoundException if not found or not resolvable.

Throws

IOException

public String getFilename ()

This implementation returns the name of the file that this ServletContext resource refers to.

public InputStream getInputStream ()

This implementation delegates to ServletContext.getResourceAsStream, but throws a FileNotFoundException if no resource found.

Throws

IOException

public final String getPath ()

Return the path for this resource.

public String getPathWithinContext ()

Return the path within the enclosing 'context'.

This is typically path relative to a context-specific root directory, e.g. a ServletContext root or a PortletContext root.

public final ServletContext getServletContext ()

Return the ServletContext for this resource.

public URL getURL ()

This implementation delegates to ServletContext.getResource, but throws a FileNotFoundException if no resource found.

Throws

IOException

public int hashCode ()

This implementation returns the hash code of the underlying ServletContext resource location.

Classes

ServletContextResource

Class Overview

See Also

Summary

Public Constructors

public ServletContextResource (ServletContext servletContext, String path)

Parameters

Public Methods

public Resource createRelative (String relativePath)

Parameters

Returns

See Also

public boolean equals (Object obj)

public boolean exists ()

See Also

public String getDescription ()

public File getFile ()

Throws

See Also

public String getFilename ()

See Also

public InputStream getInputStream ()

Throws

See Also

public final String getPath ()

public String getPathWithinContext ()

public final ServletContext getServletContext ()

public URL getURL ()

Throws

See Also

public int hashCode ()