cn.orionsec.kit.net.ftp.client.pool

Class FtpClientPool

java.lang.Object

cn.orionsec.kit.net.ftp.client.pool.FtpClientPool

All Implemented Interfaces:

AutoCloseable

public class FtpClientPool
extends Object
implements AutoCloseable

FTP 连接池

Since:

2020/3/18 11:19

Version:

1.0.0

Author:

Jiahang Li

Constructor Summary

Constructors

Constructor and Description
FtpClientPool(FtpClientFactory factory)
FtpClientPool(FtpClientFactory factory, int size)

Method Summary

Modifier and Type	Method and Description
protected void	addClient() 新建一个连接到池中
void	close() 关闭连接池 并且释放连接
org.apache.commons.net.ftp.FTPClient	getClient() 获取一个连接
FtpConfig	getConfig() 获取 FTP 配置文件
FtpClientFactory	getFactory()
int	getFreeSize() 获取空闲的连接数量
IFtpInstance	getInstance() 获取一个实例
protected BlockingQueue<org.apache.commons.net.ftp.FTPClient>	getPool() 获取连接池
protected void	invalidClient(org.apache.commons.net.ftp.FTPClient client) 使客户端无效
boolean	isNoAvailableThenCreate()
FtpClientPool	keepAliveListener() 监听 keepAlive 的连接是否超时
FtpClientPool	noAvailableThenCreate(boolean noAvailableThenCreate) 如果池中连接不足是否创建而不是阻塞后报错
void	returnClient(org.apache.commons.net.ftp.FTPClient client) 归还一个连接, 如果归还超时则销毁改对象
FtpClientPool	timeout(int timeout) 入栈超时 ms

Methods inherited from class java.lang.Object

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

Constructor Detail

FtpClientPool

public FtpClientPool(FtpClientFactory factory)

FtpClientPool

public FtpClientPool(FtpClientFactory factory,
                     int size)

Method Detail

timeout

public FtpClientPool timeout(int timeout)

入栈超时 ms

Parameters:

timeout - timeout ms

Returns:

this

noAvailableThenCreate

public FtpClientPool noAvailableThenCreate(boolean noAvailableThenCreate)

如果池中连接不足是否创建而不是阻塞后报错

Parameters:

noAvailableThenCreate - 是否创建

Returns:

this

keepAliveListener

public FtpClientPool keepAliveListener()

监听 keepAlive 的连接是否超时

Returns:

this

getClient

public org.apache.commons.net.ftp.FTPClient getClient()

获取一个连接

Returns:

连接

getInstance

public IFtpInstance getInstance()

获取一个实例

Returns:

this

returnClient

public void returnClient(org.apache.commons.net.ftp.FTPClient client)

归还一个连接, 如果归还超时则销毁改对象

Parameters:

client - 客户端

addClient

protected void addClient()

新建一个连接到池中

invalidClient

protected void invalidClient(org.apache.commons.net.ftp.FTPClient client)

使客户端无效

Parameters:

client - 客户端

close

public void close()
           throws InterruptedException

关闭连接池 并且释放连接

Specified by:

close in interface AutoCloseable

Throws:

InterruptedException - 释放连接超时

getPool

protected BlockingQueue<org.apache.commons.net.ftp.FTPClient> getPool()

获取连接池

Returns:

连接池

isNoAvailableThenCreate

public boolean isNoAvailableThenCreate()

getFactory

public FtpClientFactory getFactory()

getConfig

public FtpConfig getConfig()

获取 FTP 配置文件

Returns:

FtpConfig

getFreeSize

public int getFreeSize()

获取空闲的连接数量

Returns:

数量