org.mule.extension.file.common.api

Class AbstractConnectedFileInputStreamSupplier<T extends FileSystem>

java.lang.Object

org.mule.extension.file.common.api.AbstractFileInputStreamSupplier

org.mule.extension.file.common.api.AbstractConnectedFileInputStreamSupplier<T>

Type Parameters:

T - the type used to retrieve file contents and attributes

All Implemented Interfaces:

Supplier<InputStream>

public abstract class AbstractConnectedFileInputStreamSupplier<T extends FileSystem>
extends AbstractFileInputStreamSupplier

Abstraction that extends from AbstractFileInputStreamSupplier, this supplier can be used when you need a FileSystem in order to get the file attributes and the file content. This class implements the logic to retrieve and release the needed fileSystems, and the developer will be given the fileSystem to get the attributes and contents without to worry about how to get and retrieve connections.

Field Summary

Fields inherited from class org.mule.extension.file.common.api.AbstractFileInputStreamSupplier

attributes, FILE_NO_LONGER_EXISTS_MESSAGE

Constructor Summary

Constructors

Constructor and Description
AbstractConnectedFileInputStreamSupplier(FileAttributes attributes, org.mule.runtime.core.api.connector.ConnectionManager connectionManager, Long timeBetweenSizeCheck, FileConnectorConfig config)
AbstractConnectedFileInputStreamSupplier(FileAttributes attributes, Long timeBetweenSizeCheck, ConnectionSource<T> connectionSource)
AbstractConnectedFileInputStreamSupplier(FileAttributes attributes, Long timeBetweenSizeCheck, T fileSystem)

Method Summary

Modifier and Type	Method and Description
protected abstract boolean	fileWasDeleted(org.mule.runtime.api.exception.MuleRuntimeException e) This method will be called when a MuleRuntimeException is thrown while retrieving the content of the file and its implementation will return whether the file was deleted or not based on the exception thrown.
Optional<T>	getConnectionUsedForContentInputStream() If the content of the file was retrieved, this method will return the FileSystem used to retrieve that content.
protected InputStream	getContentInputStream() Gets the InputStream of the file described by the attributes passed to the constructor
protected abstract InputStream	getContentInputStream(T fileSystem) Gets the InputStream of the file described by the attributes passed to the constructor
protected FileAttributes	getUpdatedAttributes() Gets the updated attributes of the file.
protected abstract FileAttributes	getUpdatedAttributes(T fileSystem) Gets the updated attributes of the file.
void	releaseConnectionUsedForContentInputStream() If the content of the file was retrieved, this method will release the connection used to get that content.

Methods inherited from class org.mule.extension.file.common.api.AbstractFileInputStreamSupplier

get, onFileDeleted, onFileDeleted

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractConnectedFileInputStreamSupplier

public AbstractConnectedFileInputStreamSupplier(FileAttributes attributes,
                                                Long timeBetweenSizeCheck,
                                                ConnectionSource<T> connectionSource)

AbstractConnectedFileInputStreamSupplier

public AbstractConnectedFileInputStreamSupplier(FileAttributes attributes,
                                                Long timeBetweenSizeCheck,
                                                T fileSystem)

AbstractConnectedFileInputStreamSupplier

public AbstractConnectedFileInputStreamSupplier(FileAttributes attributes,
                                                org.mule.runtime.core.api.connector.ConnectionManager connectionManager,
                                                Long timeBetweenSizeCheck,
                                                FileConnectorConfig config)

Method Detail

getUpdatedAttributes

protected final FileAttributes getUpdatedAttributes()

Gets the updated attributes of the file.

Specified by:

getUpdatedAttributes in class AbstractFileInputStreamSupplier

Returns:

the updated attributes accourding to the path of the variable attributes passed in the constructor

getContentInputStream

protected final InputStream getContentInputStream()

Gets the InputStream of the file described by the attributes passed to the constructor

Specified by:

getContentInputStream in class AbstractFileInputStreamSupplier

Returns:

the InputStream of the file

releaseConnectionUsedForContentInputStream

public void releaseConnectionUsedForContentInputStream()

If the content of the file was retrieved, this method will release the connection used to get that content.

getConnectionUsedForContentInputStream

public Optional<T> getConnectionUsedForContentInputStream()
                                                   throws org.mule.runtime.api.connection.ConnectionException

If the content of the file was retrieved, this method will return the FileSystem used to retrieve that content.

Returns:

an Optional that contains the FileSystem or Optional.empty()

Throws:

org.mule.runtime.api.connection.ConnectionException

getUpdatedAttributes

protected abstract FileAttributes getUpdatedAttributes(T fileSystem)

Gets the updated attributes of the file.

Parameters:

fileSystem - the FileSystem to be used to gather the updated attributes

Returns:

the updated attributes according to the path of the variable attributes passed in the constructor

getContentInputStream

protected abstract InputStream getContentInputStream(T fileSystem)

Gets the InputStream of the file described by the attributes passed to the constructor

Parameters:

fileSystem - the FileSystem to be used to get the content of the file

Returns:

the InputStream of the file

fileWasDeleted

protected abstract boolean fileWasDeleted(org.mule.runtime.api.exception.MuleRuntimeException e)

This method will be called when a MuleRuntimeException is thrown while retrieving the content of the file and its implementation will return whether the file was deleted or not based on the exception thrown.

Parameters:

e - the thrown MuleRuntimeException

Returns:

whether the exception implies that the file to be read was deleted