org.mule.transport.sftp

Class SftpFileArchiveInputStream

java.lang.Object

java.io.InputStream

java.io.FileInputStream

org.mule.transport.sftp.SftpFileArchiveInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class SftpFileArchiveInputStream
extends FileInputStream

Ensures that the file is moved to the archiveFile folder after a successful consumption of the file

Author:

Magnus Larsson

Constructor Summary

Constructors

Constructor and Description
SftpFileArchiveInputStream(File file, File archiveFile, SftpInputStream sftpInputStream)
SftpFileArchiveInputStream(File file, SftpInputStream remoteStream)

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
boolean	isClosed()
void	performPostProcessingOnClose(boolean postProcessOnClose) Specifies if postProcess() should be executed when the stream is closed
void	postProcess() Executes post processing actions like closing connections, deleting/moving files, etc...
int	read()
int	read(byte[] b)
int	read(byte[] b, int off, int len)
void	setErrorOccurred()

Methods inherited from class java.io.FileInputStream

available, finalize, getChannel, getFD, skip

Methods inherited from class java.io.InputStream

mark, markSupported, reset

Methods inherited from class java.lang.Object

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

Constructor Detail

SftpFileArchiveInputStream

public SftpFileArchiveInputStream(File file,
                          SftpInputStream remoteStream)
                           throws FileNotFoundException

Throws:

FileNotFoundException

SftpFileArchiveInputStream

public SftpFileArchiveInputStream(File file,
                          File archiveFile,
                          SftpInputStream sftpInputStream)
                           throws FileNotFoundException

Throws:

FileNotFoundException

Method Detail

read

public int read()
         throws IOException

Overrides:

read in class FileInputStream

Throws:

IOException

read

public int read(byte[] b,
       int off,
       int len)
         throws IOException

Overrides:

read in class FileInputStream

Throws:

IOException

read

public int read(byte[] b)
         throws IOException

Overrides:

read in class FileInputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class FileInputStream

Throws:

IOException

isClosed

public boolean isClosed()

Returns:

Whether the stream has been closed

postProcess

public void postProcess()
                 throws Exception

Executes post processing actions like closing connections, deleting/moving files, etc... The actual actions to be executed depend on the implementation

Throws:

Exception

setErrorOccurred

public void setErrorOccurred()

performPostProcessingOnClose

public void performPostProcessingOnClose(boolean postProcessOnClose)

Specifies if postProcess() should be executed when the stream is closed

Parameters:

postProcessOnClose - a boolean