Module io.inverno.mod.base

Package io.inverno.mod.base.resource

Class URLResource

java.lang.Object

io.inverno.mod.base.resource.AbstractResource

io.inverno.mod.base.resource.AbstractAsyncResource

io.inverno.mod.base.resource.URLResource

All Implemented Interfaces:

AsyncResource, Resource, AutoCloseable

public class URLResource
extends AbstractAsyncResource

A Resource implementation that identifies resources by a URL that looks up data by opening a URLConnection.

A typical usage is:

 URLResource resource = new URLResource(URI.create("http://host/path/to/resource"));
 ...
 

Since:

1.0

Author:

Jeremy Kuhn

See Also:

• AsyncResource

Nested Class Summary

Nested classes/interfaces inherited from class io.inverno.mod.base.resource.AbstractAsyncResource

AbstractAsyncResource.EndOfFileException

Field Summary

Fields inherited from class io.inverno.mod.base.resource.AbstractAsyncResource

DEFAULT_READ_BUFFER_CAPACITY

Fields inherited from class io.inverno.mod.base.resource.AbstractResource

IS_WINDOWS_PATH

Constructor Summary

Constructors

Constructor	Description
URLResource(URI uri)	Creates a URL resource with the specified URI.
URLResource(URI uri, MediaTypeService mediaTypeService)	Creates a URL resource with the specified URI and media type service.
URLResource(URL url)	Creates a URL resource with the specified URL.
URLResource(URL url, MediaTypeService mediaTypeService)	Creates a URL resource with the specified URL and media type service.

Method Summary

Modifier and Type	Method	Description
void	close()
boolean	delete()	Deletes the resource.
Optional<Boolean>	exists()	Determines whether the resource exists.
String	getFilename()	Returns the resource file name.
URI	getURI()	Returns the resource URI.
Optional<Boolean>	isFile()	Determines whether this resource represents a file.
Optional<FileTime>	lastModified()	Returns the resource last modified time stamp.
Optional<ReadableByteChannel>	openReadableByteChannel()	Opens a readable byte channel to the resource.
Optional<WritableByteChannel>	openWritableByteChannel(boolean append, boolean createParents)	Opens a writable byte channel to the resource that will append or not content to an existing resource and create or not missing parent directories.
URLResource	resolve(Path path)	Resolves the specified URI against the resource URI as defined by Path.resolve(Path).
Optional<Long>	size()	Returns the resource content size.

Methods inherited from class io.inverno.mod.base.resource.AbstractAsyncResource

getExecutor, read, setExecutor, setReadBufferCapacity, write

Methods inherited from class io.inverno.mod.base.resource.AbstractResource

getMediaType, getMediaTypeService, pathToSanitizedString, setMediaTypeService

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.inverno.mod.base.resource.Resource

getMediaType, openWritableByteChannel, openWritableByteChannel, resolve, write, write

Constructor Details

URLResource

public URLResource(URI uri)
            throws IllegalArgumentException

Creates a URL resource with the specified URI.

Parameters:

uri - the resource URI throws IllegalArgumentException if the URI can't be converted to a URL

Throws:

IllegalArgumentException

URLResource

public URLResource(URL url)
            throws IllegalArgumentException

Creates a URL resource with the specified URL.

Parameters:

url - the resource URL throws IllegalArgumentException if the URL can't be converted to a URI

Throws:

IllegalArgumentException

URLResource

public URLResource(URI uri,
 MediaTypeService mediaTypeService)
            throws IllegalArgumentException

Creates a URL resource with the specified URI and media type service.

Parameters:

uri - the resource URI

mediaTypeService - a media type service throws IllegalArgumentException if the URI can't be converted to a URL

Throws:

IllegalArgumentException

URLResource

public URLResource(URL url,
 MediaTypeService mediaTypeService)
            throws IllegalArgumentException

Creates a URL resource with the specified URL and media type service.

Parameters:

url - the resource URL

mediaTypeService - a media type service throws IllegalArgumentException if the URL can't be converted to a URI

Throws:

IllegalArgumentException

Method Details

getURI

public URI getURI()

Description copied from interface: Resource

Returns the resource URI.

Returns:

the resource URI

getFilename

public String getFilename()
                   throws ResourceException

Description copied from interface: Resource

Returns the resource file name.

Returns:

the resource file name

Throws:

ResourceException - if there was an error resolving the resource file name

exists

public Optional<Boolean> exists()
                         throws ResourceException

Description copied from interface: Resource

Determines whether the resource exists.

Returns:

an optional returning true if the resource exists, false otherwise or an empty optional if existence couldn't be determined

Throws:

ResourceException - if there was an error determining resource existence

isFile

public Optional<Boolean> isFile()
                         throws ResourceException

Description copied from interface: Resource

Determines whether this resource represents a file.

A file resource is a resource that can be accessed through a FileChannel.

Returns:

an optional returning true if the resource is a file, false otherwise or an empty optional if it couldn't be determined

Throws:

ResourceException - if there was an error determining whether the resource is a file

lastModified

public Optional<FileTime> lastModified()
                                throws ResourceException

Description copied from interface: Resource

Returns the resource last modified time stamp.

Returns:

an optional returning the resource last modified time stamp or an empty optional if it couldn't be determined

Throws:

ResourceException - if there was an error resolving resource last modified time stamp

size

public Optional<Long> size()
                    throws ResourceException

Description copied from interface: Resource

Returns the resource content size.

Returns:

an optional returning the resource content size or an empty optional if it couldn't be determined

Throws:

ResourceException - if there was an error resolving resource content size

openReadableByteChannel

public Optional<ReadableByteChannel> openReadableByteChannel()
                                                      throws ResourceException

Description copied from interface: Resource

Opens a readable byte channel to the resource.

The caller is responsible for closing the channel to prevent resource leak.

Returns:

an optional returning a readable byte channel or an empty optional if the resource is not readable

Throws:

ResourceException - if there was an error opening the readable byte channel

openWritableByteChannel

public Optional<WritableByteChannel> openWritableByteChannel(boolean append,
 boolean createParents)
                                                      throws ResourceException

Description copied from interface: Resource

Opens a writable byte channel to the resource that will append or not content to an existing resource and create or not missing parent directories.

The caller is responsible for closing the channel to prevent resource leak.

Parameters:

append - true to append content to an existing resource

createParents - true to create missing parent directories

Returns:

an optional returning a writable byte channel or an empty optional if the resource is not writable

Throws:

ResourceException - if there was an error opening the writable byte channel

delete

public boolean delete()
               throws ResourceException

Description copied from interface: Resource

Deletes the resource.

Returns:

true if the resource had been deleted, false otherwise

Throws:

ResourceException - if there was an error deleting to the resource

resolve

public URLResource resolve(Path path)
                    throws ResourceException

Description copied from interface: Resource

Resolves the specified URI against the resource URI as defined by Path.resolve(Path).

Parameters:

path - the path to resolve

Returns:

a new resource resulting from the resolution of the specified path against the resource

Throws:

ResourceException - if there was an error resolving the resource

close

public void close()