Class VfsResource
- All Implemented Interfaces:
InputStreamSource
,Resource
Resource
implementation.
As of Spring 4.0, this class supports VFS 3.x on JBoss AS 6+
(package org.jboss.vfs
) and is in particular compatible with
JBoss AS 7 and WildFly 8+.
- Since:
- 3.0
- Author:
- Ales Justin, Juergen Hoeller, Costin Leau, Sam Brannen
-
Constructor Summary
ConstructorDescriptionVfsResource
(Object resource) Create a newVfsResource
wrapping the given resource handle. -
Method Summary
Modifier and TypeMethodDescriptionlong
This method reads the entire InputStream to determine the content length.createRelative
(String relativePath) This implementation throws a FileNotFoundException, assuming that relative resources cannot be created for this resource.boolean
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.Return a description for this resource, to be used for error output when working with the resource.getFile()
This implementation throws a FileNotFoundException, assuming that the resource cannot be resolved to an absolute file path.This implementation always returnsnull
, assuming that this resource type does not have a filename.Return anInputStream
for the content of an underlying resource.getURI()
This implementation builds a URI based on the URL returned byAbstractResource.getURL()
.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
This implementation always returnstrue
for a resource thatexists
(revised as of 5.1).long
This implementation checks the timestamp of the underlying File, if available.Methods inherited from class org.springframework.core.io.AbstractResource
getFileForLastModifiedCheck, isFile, isOpen, readableChannel, toString
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.springframework.core.io.Resource
getContentAsByteArray, getContentAsString
-
Constructor Details
-
VfsResource
Create a newVfsResource
wrapping the given resource handle.- Parameters:
resource
- aorg.jboss.vfs.VirtualFile
instance (untyped in order to avoid a static dependency on the VFS API)
-
-
Method Details
-
getInputStream
Description copied from interface:InputStreamSource
Return anInputStream
for the content of an underlying resource.It is usually expected that every such call creates a fresh stream.
This requirement is particularly important when you consider an API such as JavaMail, which needs to be able to read the stream multiple times when creating mail attachments. For such a use case, it is required that each
getInputStream()
call returns a fresh stream.- Returns:
- the input stream for the underlying resource (must not be
null
) - Throws:
FileNotFoundException
- if the underlying resource does not existIOException
- if the content stream could not be opened- See Also:
-
exists
public boolean exists()Description copied from class:AbstractResource
This implementation checks whether a File can be opened, falling back to whether an InputStream can be opened.This will cover both directories and content resources.
- Specified by:
exists
in interfaceResource
- Overrides:
exists
in classAbstractResource
-
isReadable
public boolean isReadable()Description copied from class:AbstractResource
This implementation always returnstrue
for a resource thatexists
(revised as of 5.1).- Specified by:
isReadable
in interfaceResource
- Overrides:
isReadable
in classAbstractResource
- See Also:
-
getURL
Description copied from class:AbstractResource
This implementation throws a FileNotFoundException, assuming that the resource cannot be resolved to a URL.- Specified by:
getURL
in interfaceResource
- Overrides:
getURL
in classAbstractResource
- Throws:
IOException
- if the resource cannot be resolved as URL, i.e. if the resource is not available as a descriptor
-
getURI
Description copied from class:AbstractResource
This implementation builds a URI based on the URL returned byAbstractResource.getURL()
.- Specified by:
getURI
in interfaceResource
- Overrides:
getURI
in classAbstractResource
- Throws:
IOException
- if the resource cannot be resolved as URI, i.e. if the resource is not available as a descriptor
-
getFile
Description copied from class:AbstractResource
This implementation throws a FileNotFoundException, assuming that the resource cannot be resolved to an absolute file path.- Specified by:
getFile
in interfaceResource
- Overrides:
getFile
in classAbstractResource
- Throws:
FileNotFoundException
- if the resource cannot be resolved as absolute file path, i.e. if the resource is not available in a file systemIOException
- in case of general resolution/reading failures- See Also:
-
contentLength
Description copied from class:AbstractResource
This method reads the entire InputStream to determine the content length.For a custom subclass of
InputStreamResource
, we strongly recommend overriding this method with a more optimal implementation, e.g. checking File length, or possibly simply returning -1 if the stream can only be read once.- Specified by:
contentLength
in interfaceResource
- Overrides:
contentLength
in classAbstractResource
- Throws:
IOException
- if the resource cannot be resolved (in the file system or as some other known physical resource type)- See Also:
-
lastModified
Description copied from class:AbstractResource
This implementation checks the timestamp of the underlying File, if available.- Specified by:
lastModified
in interfaceResource
- Overrides:
lastModified
in classAbstractResource
- Throws:
IOException
- if the resource cannot be resolved (in the file system or as some other known physical resource type)- See Also:
-
createRelative
Description copied from class:AbstractResource
This implementation throws a FileNotFoundException, assuming that relative resources cannot be created for this resource.- Specified by:
createRelative
in interfaceResource
- Overrides:
createRelative
in classAbstractResource
- Parameters:
relativePath
- the relative path (relative to this resource)- Returns:
- the resource handle for the relative resource
- Throws:
IOException
- if the relative resource cannot be determined
-
getFilename
Description copied from class:AbstractResource
This implementation always returnsnull
, assuming that this resource type does not have a filename.- Specified by:
getFilename
in interfaceResource
- Overrides:
getFilename
in classAbstractResource
-
getDescription
Description copied from interface:Resource
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.- See Also:
-
equals
Description copied from class:AbstractResource
This implementation compares description strings.- Overrides:
equals
in classAbstractResource
- See Also:
-
hashCode
public int hashCode()Description copied from class:AbstractResource
This implementation returns the description's hash code.- Overrides:
hashCode
in classAbstractResource
- See Also:
-