org.springframework.core.io

Class FileUrlResource

java.lang.Object

org.springframework.core.io.AbstractResource

org.springframework.core.io.AbstractFileResolvingResource

org.springframework.core.io.UrlResource

org.springframework.core.io.FileUrlResource

All Implemented Interfaces:

InputStreamSource, Resource, WritableResource

public class FileUrlResource
extends UrlResource
implements WritableResource

Subclass of UrlResource which assumes file resolution, to the degree of implementing the WritableResource interface for it.

This is the class resolved by DefaultResourceLoader for a "file:..." URL location, allowing a downcast to WritableResource for it.

Alternatively, for direct construction from a File handle, consider using FileSystemResource. For an NIO Path, consider using PathResource instead.

Since:

5.0.2

Author:

Juergen Hoeller

Constructor Summary

Constructors

Constructor and Description
FileUrlResource(java.lang.String location) Create a new FileUrlResource based on the given file location, using the URL protocol "file".
FileUrlResource(java.net.URL url) Create a new FileUrlResource based on the given URL object.

Method Summary

Modifier and Type	Method and Description
Resource	createRelative(java.lang.String relativePath) This implementation creates a UrlResource, applying the given path relative to the path of the underlying URL of this resource descriptor.
java.io.OutputStream	getOutputStream() Return an OutputStream for the underlying resource, allowing to (over-)write its content.
boolean	isWritable() Indicate whether the contents of this resource can be written via WritableResource.getOutputStream().
java.nio.channels.WritableByteChannel	writableChannel() Return a WritableByteChannel.

Methods inherited from class org.springframework.core.io.UrlResource

equals, getDescription, getFile, getFilename, getInputStream, getURI, getURL, hashCode, isFile

Methods inherited from class org.springframework.core.io.AbstractFileResolvingResource

contentLength, customizeConnection, customizeConnection, exists, getFile, getFileForLastModifiedCheck, isFile, isReadable, lastModified, readableChannel

Methods inherited from class org.springframework.core.io.AbstractResource

isOpen, 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

contentLength, exists, getDescription, getFile, getFilename, getURI, getURL, isFile, isOpen, isReadable, lastModified, readableChannel

Methods inherited from interface org.springframework.core.io.InputStreamSource

getInputStream

Constructor Detail

FileUrlResource

public FileUrlResource(java.net.URL url)

Create a new FileUrlResource based on the given URL object.

Note that this does not enforce "file" as URL protocol. If a protocol is known to be resolvable to a file,

Parameters:

url - a URL

See Also:

ResourceUtils.isFileURL(URL), UrlResource.getFile()

FileUrlResource

public FileUrlResource(java.lang.String location)
                throws java.net.MalformedURLException

Create a new FileUrlResource based on the given file location, using the URL protocol "file".

The given parts will automatically get encoded if necessary.

Parameters:

location - the location (i.e. the file path within that protocol)

Throws:

java.net.MalformedURLException - if the given URL specification is not valid

See Also:

UrlResource.UrlResource(String, String), ResourceUtils.URL_PROTOCOL_FILE

Method Detail

createRelative

public Resource createRelative(java.lang.String relativePath)
                        throws java.net.MalformedURLException

Description copied from class: UrlResource

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

Specified by:

createRelative in interface Resource

Overrides:

createRelative in class UrlResource

Parameters:

relativePath - the relative path (relative to this resource)

Returns:

the resource handle for the relative resource

Throws:

java.net.MalformedURLException

See Also:

URL.URL(java.net.URL, String)

isWritable

public boolean isWritable()

Description copied from interface: WritableResource

Indicate whether the contents of this resource can be written via WritableResource.getOutputStream().

Will be true for typical resource descriptors; note that actual content writing may still fail when attempted. However, a value of false is a definitive indication that the resource content cannot be modified.

Specified by:

isWritable in interface WritableResource

See Also:

WritableResource.getOutputStream(), Resource.isReadable()

getOutputStream

public java.io.OutputStream getOutputStream()
                                     throws java.io.IOException

Description copied from interface: WritableResource

Return an OutputStream for the underlying resource, allowing to (over-)write its content.

Specified by:

getOutputStream in interface WritableResource

Throws:

java.io.IOException - if the stream could not be opened

See Also:

InputStreamSource.getInputStream()

writableChannel

public java.nio.channels.WritableByteChannel writableChannel()
                                                      throws java.io.IOException

Description copied from interface: WritableResource

Return a WritableByteChannel.

It is expected that each call creates a fresh channel.

The default implementation returns Channels.newChannel(OutputStream) with the result of WritableResource.getOutputStream().

Specified by:

writableChannel in interface WritableResource

Returns:

the byte channel for the underlying resource (must not be null)

Throws:

java.io.FileNotFoundException - if the underlying resource doesn't exist

java.io.IOException - if the content channel could not be opened

See Also:

WritableResource.getOutputStream()