org.mule.extension.ftp.internal

Class FtpInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

org.apache.commons.io.input.ProxyInputStream

org.apache.commons.io.input.AutoCloseInputStream

org.mule.extension.file.common.api.stream.AbstractFileInputStream

org.mule.extension.ftp.internal.FtpInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

ClassicFtpInputStream, SftpInputStream

public abstract class FtpInputStream
extends org.mule.extension.file.common.api.stream.AbstractFileInputStream

An AbstractFileInputStream implementation which obtains a FtpFileSystem through a ConnectionManager and uses it to obtain the contents of a file on a FTP server.

When the stream is closed or fully consumed, the ClassicFtpFileSystem is released back to the ConnectionManager

Since:

4.0

Field Summary

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FtpInputStream(Supplier<InputStream> streamSupplier, org.mule.runtime.api.connection.ConnectionHandler<FtpFileSystem> connectionHandler, org.mule.extension.file.common.api.lock.PathLock lock)

Method Summary

Modifier and Type	Method and Description
protected void	beforeClose() Template method for performing operations just before the stream is closed.
protected void	doClose()
protected static org.mule.runtime.api.connection.ConnectionHandler<FtpFileSystem>	getConnectionHandler(FtpConnector config)
protected FtpFileSystem	getFtpFileSystem()
protected static Supplier<InputStream>	getStreamSupplier(FtpFileAttributes attributes, org.mule.runtime.api.connection.ConnectionHandler<FtpFileSystem> connectionHandler)

Methods inherited from class org.mule.extension.file.common.api.stream.AbstractFileInputStream

close, isLocked

Methods inherited from class org.apache.commons.io.input.AutoCloseInputStream

afterRead, finalize

Methods inherited from class org.apache.commons.io.input.ProxyInputStream

available, beforeRead, handleIOException, mark, markSupported, read, read, read, reset, skip

Methods inherited from class java.lang.Object

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

Constructor Detail

FtpInputStream

protected FtpInputStream(Supplier<InputStream> streamSupplier,
                         org.mule.runtime.api.connection.ConnectionHandler<FtpFileSystem> connectionHandler,
                         org.mule.extension.file.common.api.lock.PathLock lock)
                  throws org.mule.runtime.api.connection.ConnectionException

Throws:

org.mule.runtime.api.connection.ConnectionException

Method Detail

getConnectionHandler

protected static org.mule.runtime.api.connection.ConnectionHandler<FtpFileSystem> getConnectionHandler(FtpConnector config)
                                                                                                throws org.mule.runtime.api.connection.ConnectionException

Throws:

org.mule.runtime.api.connection.ConnectionException

getStreamSupplier

protected static Supplier<InputStream> getStreamSupplier(FtpFileAttributes attributes,
                                                         org.mule.runtime.api.connection.ConnectionHandler<FtpFileSystem> connectionHandler)

doClose

protected void doClose()
                throws IOException

Overrides:

doClose in class org.mule.extension.file.common.api.stream.AbstractFileInputStream

Throws:

IOException

beforeClose

protected void beforeClose()
                    throws IOException

Template method for performing operations just before the stream is closed. This default implementation is empty.

Throws:

IOException

getFtpFileSystem

protected FtpFileSystem getFtpFileSystem()

Returns:

the FtpFileSystem used to obtain the stream