Class Overview
Resource
implementation for
javax.portlet.PortletContext resources, interpreting
relative paths within the portlet application root directory.
Always supports stream access and URL access, but only allows
java.io.File
access when the portlet application archive
is expanded.
See Also
- javax.portlet.PortletContext#getResourceAsStream
- javax.portlet.PortletContext#getRealPath
Summary
Public Methods |
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 PortletContext.getResource .
|
String
|
getDescription()
Return a description for this resource,
to be used for error output when working with the resource.
|
File
|
getFile()
This implementation delegates to PortletContext.getRealPath ,
but throws a FileNotFoundException if not found or not resolvable.
|
String
|
getFilename()
This implementation always throws IllegalStateException,
assuming that the resource does not have a filename.
|
InputStream
|
getInputStream()
This implementation delegates to PortletContext.getResourceAsStream ,
but throws a FileNotFoundException if not found.
|
final
String
|
getPath()
Return the path for this resource.
|
String
|
getPathWithinContext()
Return the path within the enclosing 'context'.
|
final
PortletContext
|
getPortletContext()
Return the PortletContext for this resource.
|
URL
|
getURL()
This implementation delegates to PortletContext.getResource ,
but throws a FileNotFoundException if no resource found.
|
int
|
hashCode()
This implementation returns the description's hash code.
|
[Expand]
Inherited Methods |
From class
org.springframework.core.io.AbstractFileResolvingResource
long
|
contentLength()
This implementation checks the timestamp of the underlying File,
if available.
|
boolean
|
exists()
This implementation checks whether a File can be opened,
falling back to whether an InputStream can be opened.
|
File
|
getFile(URI uri)
This implementation returns a File reference for the underlying class path
resource, provided that it refers to a file in the file system.
|
File
|
getFile()
This implementation returns a File reference for the underlying class path
resource, provided that it refers to a file in the file system.
|
File
|
getFileForLastModifiedCheck()
This implementation determines the underlying File
(or jar file, in case of a resource in a jar/zip).
|
boolean
|
isReadable()
This implementation always returns true .
|
long
|
lastModified()
This implementation checks the timestamp of the underlying File,
if available.
|
|
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
Object
|
clone()
|
boolean
|
equals(Object arg0)
|
void
|
finalize()
|
final
Class<?>
|
getClass()
|
int
|
hashCode()
|
final
void
|
notify()
|
final
void
|
notifyAll()
|
String
|
toString()
|
final
void
|
wait()
|
final
void
|
wait(long arg0, int arg1)
|
final
void
|
wait(long arg0)
|
|
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
PortletContextResource
(PortletContext portletContext, String path)
Create a new PortletContextResource.
The Portlet 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
portletContext
| the PortletContext to load from |
path
| the path of the resource
|
Public Methods
public
Resource
createRelative
(String relativePath)
This implementation throws a FileNotFoundException, assuming
that relative resources cannot be created for this resource.
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 description strings.
public
boolean
exists
()
This implementation checks PortletContext.getResource
.
See Also
- javax.portlet.PortletContext#getResource(String)
public
String
getDescription
()
Return a description for this resource,
to be used for error output when working with the resource.
Implementations are also encouraged to return this value
from their toString
method.
public
File
getFile
()
This implementation delegates to PortletContext.getRealPath
,
but throws a FileNotFoundException if not found or not resolvable.
See Also
- javax.portlet.PortletContext#getRealPath(String)
public
String
getFilename
()
This implementation always throws IllegalStateException,
assuming that the resource does not have a filename.
public
InputStream
getInputStream
()
This implementation delegates to PortletContext.getResourceAsStream
,
but throws a FileNotFoundException if not found.
See Also
- javax.portlet.PortletContext#getResourceAsStream(String)
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
PortletContext
getPortletContext
()
Return the PortletContext for this resource.
public
URL
getURL
()
This implementation delegates to PortletContext.getResource
,
but throws a FileNotFoundException if no resource found.
See Also
- javax.portlet.PortletContext#getResource(String)
public
int
hashCode
()
This implementation returns the description's hash code.