org.springframework.integration.ftp.session

Class FtpSession

java.lang.Object

org.springframework.integration.ftp.session.FtpSession

All Implemented Interfaces:

Session<org.apache.commons.net.ftp.FTPFile>

public class FtpSession
extends Object
implements Session<org.apache.commons.net.ftp.FTPFile>

Implementation of Session for FTP.

Since:

2.0

Author:

Mark Fisher, Oleg Zhurakousky, Gary Russell

Constructor Summary

Constructors

Constructor and Description
FtpSession(org.apache.commons.net.ftp.FTPClient client)

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
boolean	exists(String path)
boolean	finalizeRaw() Invoke after closing the InputStream from Session.readRaw(String).
boolean	isOpen()
org.apache.commons.net.ftp.FTPFile[]	list(String path)
String[]	listNames(String path)
boolean	mkdir(String remoteDirectory)
void	read(String path, OutputStream fos)
InputStream	readRaw(String source) Retrieve a remote file as a raw InputStream.
boolean	remove(String path)
void	rename(String pathFrom, String pathTo)
void	write(InputStream inputStream, String path)

Methods inherited from class java.lang.Object

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

Constructor Detail

FtpSession

public FtpSession(org.apache.commons.net.ftp.FTPClient client)

Method Detail

remove

public boolean remove(String path)
               throws IOException

Specified by:

remove in interface Session<org.apache.commons.net.ftp.FTPFile>

Throws:

IOException

list

public org.apache.commons.net.ftp.FTPFile[] list(String path)
                                          throws IOException

Specified by:

list in interface Session<org.apache.commons.net.ftp.FTPFile>

Throws:

IOException

listNames

public String[] listNames(String path)
                   throws IOException

Specified by:

listNames in interface Session<org.apache.commons.net.ftp.FTPFile>

Throws:

IOException

read

public void read(String path,
        OutputStream fos)
          throws IOException

Specified by:

read in interface Session<org.apache.commons.net.ftp.FTPFile>

Throws:

IOException

readRaw

public InputStream readRaw(String source)
                    throws IOException

Description copied from interface: Session

Retrieve a remote file as a raw InputStream.

Specified by:

readRaw in interface Session<org.apache.commons.net.ftp.FTPFile>

Parameters:

source - The path of the remote file.

Returns:

The raw inputStream.

Throws:

IOException - Any IOException.

finalizeRaw

public boolean finalizeRaw()
                    throws IOException

Description copied from interface: Session

Invoke after closing the InputStream from Session.readRaw(String). Required by some session providers.

Specified by:

finalizeRaw in interface Session<org.apache.commons.net.ftp.FTPFile>

Returns:

true if successful.

Throws:

IOException - Any IOException.

write

public void write(InputStream inputStream,
         String path)
           throws IOException

Specified by:

write in interface Session<org.apache.commons.net.ftp.FTPFile>

Throws:

IOException

close

public void close()

Specified by:

close in interface Session<org.apache.commons.net.ftp.FTPFile>

isOpen

public boolean isOpen()

Specified by:

isOpen in interface Session<org.apache.commons.net.ftp.FTPFile>

rename

public void rename(String pathFrom,
          String pathTo)
            throws IOException

Specified by:

rename in interface Session<org.apache.commons.net.ftp.FTPFile>

Throws:

IOException

mkdir

public boolean mkdir(String remoteDirectory)
              throws IOException

Specified by:

mkdir in interface Session<org.apache.commons.net.ftp.FTPFile>

Throws:

IOException

exists

public boolean exists(String path)
               throws IOException

Specified by:

exists in interface Session<org.apache.commons.net.ftp.FTPFile>

Throws:

IOException