org.mule.extension.ftp.internal.sftp

Class SftpInputStream

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

org.mule.extension.ftp.internal.sftp.SftpInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class SftpInputStream
extends FtpInputStream

Implementation of FtpInputStream for SFTP connections

Since:

4.0

Field Summary

Fields inherited from class java.io.FilterInputStream

in

Method Summary

Modifier and Type	Method and Description
static FtpInputStream	newInstance(FtpConnector config, FtpFileAttributes attributes, org.mule.extension.file.common.api.lock.PathLock lock) Establishes the underlying connection and returns a new instance of this class.

Methods inherited from class org.mule.extension.ftp.internal.FtpInputStream

beforeClose, doClose, getConnectionHandler, getFtpFileSystem, getStreamSupplier

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

Method Detail

newInstance

public static FtpInputStream newInstance(FtpConnector config,
                                         FtpFileAttributes attributes,
                                         org.mule.extension.file.common.api.lock.PathLock lock)
                                  throws org.mule.runtime.api.connection.ConnectionException

Establishes the underlying connection and returns a new instance of this class.

Instances returned by this method MUST be closed or fully consumed.

Parameters:

config - the config which is parameterizing this operation

attributes - a FileAttributes referencing the file which contents are to be fetched

lock - the PathLock to be used

Returns:

a new FtpInputStream

Throws:

org.mule.runtime.api.connection.ConnectionException - if a connection could not be established