org.springframework.integration.ftp
Interface FtpClientPool

All Superinterfaces:

FtpClientFactory

All Known Implementing Classes:

QueuedFtpClientPool

public interface FtpClientPool
extends FtpClientFactory

A pool of FTPClient instances. The pool can be used to control the number of open FTP connections and reuse these connections efficiently.

Author:

Iwein Fuld

Method Summary

void	releaseClient(org.apache.commons.net.ftp.FTPClient client) Releases the client back to the pool.

Methods inherited from interface org.springframework.integration.ftp.FtpClientFactory

getClient

Method Detail

releaseClient

void releaseClient(org.apache.commons.net.ftp.FTPClient client)

Releases the client back to the pool. When calling this method the caller is no longer responsible for the connection. The pool is free to do with it as it sees fit, which means either recycling or disconnecting it most probably.

The caller should NOT disconnect the client before calling this method.

The caller is NOT expected to use the client after calling this method. Doing so can lead to unexpected behavior.

Parameters:

client - the FTPClient to release. Implementations of this method are recommended to deal gracefully with a null argument, although the endpoint implementations in org.springframework.integration.ftp will never pass in null.