Module io.inverno.mod.base

Package io.inverno.mod.base.resource

Class AbstractAsyncResource

java.lang.Object

io.inverno.mod.base.resource.AbstractResource

io.inverno.mod.base.resource.AbstractAsyncResource

All Implemented Interfaces:

AsyncResource, Resource, AutoCloseable

Direct Known Subclasses:

ClasspathResource, FileResource, ModuleResource, NativeResource, PathResource, URLResource, ZipResource

public abstract class AbstractAsyncResource
extends AbstractResource
implements AsyncResource

Base implementation for AsyncResource.

Since:

1.0

Author:

Jeremy Kuhn

See Also:

• AsyncResource

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	AbstractAsyncResource.EndOfFileException	Thrown when the end of the file is reached when reading a resource.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_READ_BUFFER_CAPACITY	The default read buffer capacity.

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

IS_WINDOWS_PATH

Constructor Summary

Constructors

Modifier	Constructor	Description
	AbstractAsyncResource()	Creates an asnc resource.
protected	AbstractAsyncResource(MediaTypeService mediaTypeService)	Creates an async resource with the specified media type service.

Method Summary

Modifier and Type	Method	Description
ExecutorService	getExecutor()	Returns the executor service.
Publisher<ByteBuf>	read()	Reads the resource in a reactive way.
void	setExecutor(ExecutorService executor)	Sets the executor service to use when reading or writing the resource asynchronously.
void	setReadBufferCapacity(int readBufferCapacity)	Sets the buffer read capacity.
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.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

close, delete, exists, getFilename, getMediaType, getURI, isFile, lastModified, openReadableByteChannel, openWritableByteChannel, openWritableByteChannel, openWritableByteChannel, resolve, resolve, size, write, write

Field Details

DEFAULT_READ_BUFFER_CAPACITY

public static final int DEFAULT_READ_BUFFER_CAPACITY

The default read buffer capacity.

See Also:

• Constant Field Values

Constructor Details

AbstractAsyncResource

public AbstractAsyncResource()

Creates an asnc resource.

AbstractAsyncResource

protected AbstractAsyncResource(MediaTypeService mediaTypeService)

Creates an async resource with the specified media type service.

Parameters:

mediaTypeService - a media type service

Method Details

setReadBufferCapacity

public void setReadBufferCapacity(int readBufferCapacity)

Sets the buffer read capacity.

Parameters:

readBufferCapacity - the buffer read capacity to set

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

Parameters:

executor - the executor service to set

getExecutor

public ExecutorService getExecutor()

Description copied from interface: AsyncResource

Returns the executor service.

Specified by:

getExecutor in interface AsyncResource

Returns:

an executor service

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

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

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