Module io.inverno.mod.base

Package io.inverno.mod.base.resource

Class ClasspathResource

java.lang.Object

io.inverno.mod.base.resource.AbstractResource

io.inverno.mod.base.resource.AbstractAsyncResource

io.inverno.mod.base.resource.ClasspathResource

All Implemented Interfaces:

AsyncResource, Resource, AutoCloseable

public class ClasspathResource
extends AbstractAsyncResource

A Resource implementation that identifies resources by a URI of the form classpath:/path/to/resource and looks up data on the classpath.

A typical usage is:

 ClasspathResource resource = new ClasspathResource(URI.create("classpath:/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

Modifier and Type	Field	Description
static final String	SCHEME_CLASSPATH	The classpath resource scheme

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
ClasspathResource(URI uri)	Creates a classpath resource with the specified URI.
ClasspathResource(URI uri, MediaTypeService mediaTypeService)	Creates a classpath resource with the specified URI and media type service.
ClasspathResource(URI uri, Class<?> clazz)	Creates a classpath resource with the specified URI that looks up data from the specified class.
ClasspathResource(URI uri, Class<?> clazz, MediaTypeService mediaTypeService)	Creates a classpath resource with the specified URI and media type service that looks up data from the specified class.
ClasspathResource(URI uri, ClassLoader classLoader)	Creates a classpath resource with the specified URI that looks up data from the specified class loader.
ClasspathResource(URI uri, ClassLoader classLoader, MediaTypeService mediaTypeService)	Creates a classpath resource with the specified URI and media type service that looks up data from the specified class loader.

Method Summary

Modifier and Type	Method	Description
static URI	checkUri(URI uri)	Checks that the specified URI is a classpath resource URI.
void	close()
boolean	delete()	Deletes the resource.
Optional<Boolean>	exists()	Determines whether the resource exists.
String	getFilename()	Returns the resource file name.
String	getMediaType()	Returns the resource media type.
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.
Publisher<ByteBuf>	read()	Reads the resource in a reactive way.
Resource	resolve(Path path)	Resolves the specified URI against the resource URI as defined by Path.resolve(Path).
void	setExecutor(ExecutorService executor)	Sets the executor service to use when reading or writing the resource asynchronously.
Optional<Long>	size()	Returns the resource content size.
Publisher<Integer>	write(Publisher<ByteBuf> data, boolean append, boolean createParents)	Writes content to the resource in a reactive way appending or not content to an existing resource and create or not missing parent directories.

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

getExecutor, setReadBufferCapacity

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

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

openWritableByteChannel, openWritableByteChannel, resolve, write, write

Field Details

SCHEME_CLASSPATH

public static final String SCHEME_CLASSPATH

The classpath resource scheme

See Also:

• Constant Field Values

Constructor Details

ClasspathResource

public ClasspathResource(URI uri)
                  throws IllegalArgumentException

Creates a classpath resource with the specified URI.

Parameters:

uri - the resource URI

Throws:

IllegalArgumentException - if the specified URI does not designate a classpath resource

ClasspathResource

public ClasspathResource(URI uri,
 Class<?> clazz)
                  throws IllegalArgumentException

Creates a classpath resource with the specified URI that looks up data from the specified class.

Parameters:

uri - the resource URI

clazz - a class

Throws:

IllegalArgumentException - if the specified URI does not designate a classpath resource

See Also:

• Class.getResource(String)

ClasspathResource

public ClasspathResource(URI uri,
 ClassLoader classLoader)
                  throws IllegalArgumentException

Creates a classpath resource with the specified URI that looks up data from the specified class loader.

Parameters:

uri - the resource URI

classLoader - a class loader

Throws:

IllegalArgumentException - if the specified URI does not designate a classpath resource

See Also:

• ClassLoader.getResource(String)

ClasspathResource

public ClasspathResource(URI uri,
 MediaTypeService mediaTypeService)
                  throws IllegalArgumentException

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

Parameters:

uri - the resource URI

mediaTypeService - a media type service

Throws:

IllegalArgumentException - if the specified URI does not designate a classpath resource

ClasspathResource

public ClasspathResource(URI uri,
 Class<?> clazz,
 MediaTypeService mediaTypeService)
                  throws IllegalArgumentException

Creates a classpath resource with the specified URI and media type service that looks up data from the specified class.

Parameters:

uri - the resource URI

clazz - a class

mediaTypeService - a media type service

Throws:

IllegalArgumentException - if the specified URI does not designate a classpath resource

ClasspathResource

public ClasspathResource(URI uri,
 ClassLoader classLoader,
 MediaTypeService mediaTypeService)
                  throws IllegalArgumentException

Creates a classpath resource with the specified URI and media type service that looks up data from the specified class loader.

Parameters:

uri - the resource URI

classLoader - a class loader

mediaTypeService - a media type service

Throws:

IllegalArgumentException - if the specified URI does not designate a classpath resource

Method Details

checkUri

public static URI checkUri(URI uri)
                    throws IllegalArgumentException

Checks that the specified URI is a classpath resource URI.

Parameters:

uri - the uri to check

Returns:

the uri if it is a classpath resource URI

Throws:

IllegalArgumentException - if the specified URI does not designate a classpath resource

setExecutor

public void setExecutor(ExecutorService executor)

Description copied from interface: AsyncResource

Sets the executor service to use when reading or writing the resource asynchronously.

Specified by:

setExecutor in interface AsyncResource

Overrides:

setExecutor in class AbstractAsyncResource

Parameters:

executor - the executor service to set

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

getMediaType

public String getMediaType()
                    throws ResourceException

Description copied from interface: Resource

Returns the resource media type.

Specified by:

getMediaType in interface Resource

Overrides:

getMediaType in class AbstractResource

Returns:

the resource media type or null if it couldn't be determined

Throws:

ResourceException - if there was an error resolving the resource media type

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

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

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

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

read

public Publisher<ByteBuf> read()
                        throws NotReadableResourceException,
ResourceException

Description copied from interface: Resource

Reads the resource in a reactive way.

Specified by:

read in interface Resource

Overrides:

read in class AbstractAsyncResource

Returns:

a stream of ByteBuf

Throws:

NotReadableResourceException - if the resource is not readable

ResourceException - if there was an error reading the resource

write

public Publisher<Integer> write(Publisher<ByteBuf> data,
 boolean append,
 boolean createParents)
                         throws NotWritableResourceException,
ResourceException

Description copied from interface: Resource

Writes content to the resource in a reactive way appending or not content to an existing resource and create or not missing parent directories.

Specified by:

write in interface Resource

Overrides:

write in class AbstractAsyncResource

Parameters:

data - the stream of data to write

append - true to append content to an existing resource

createParents - true to create missing parent directories

Returns:

a stream of integer emitting number of bytes written

Throws:

ResourceException - if there was an error writing to the resource

NotWritableResourceException

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 Resource 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()