SftpPool (sftp-pool-core 0.1.3 API)

java.lang.Object
- org.apache.commons.pool2.BaseObject
- - org.apache.commons.pool2.impl.BaseGenericObjectPool<T>
  - - org.apache.commons.pool2.impl.GenericKeyedObjectPool<String,SftpConnect>
    - - me.meilon.sftp.core.SftpPool

所有已实现的接口:

Closeable, AutoCloseable, org.apache.commons.pool2.impl.GenericKeyedObjectPoolMXBean<String>, org.apache.commons.pool2.KeyedObjectPool<String,SftpConnect>
```
public class SftpPool
extends org.apache.commons.pool2.impl.GenericKeyedObjectPool<String,SftpConnect>
```
sftp 链接池

作者:

meilon

字段概要
- 从类继承的字段 org.apache.commons.pool2.impl.BaseGenericObjectPool
  MEAN_TIMING_STATS_CACHE_SIZE

构造器概要

构造器
限定符构造器和说明

protected SftpPool(SftpPooledFactory factory, org.apache.commons.pool2.impl.GenericKeyedObjectPoolConfig<SftpConnect> config)

构造器
限定符	构造器和说明
`protected`	`SftpPool(SftpPooledFactory factory, org.apache.commons.pool2.impl.GenericKeyedObjectPoolConfig<SftpConnect> config)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`SftpConnect`	`borrowObject(SftpConnConfig config)` 从连接池中获取一个sftp链接注意: 使用完后需要自行调用 `returnSftp(SftpConnect)` 方法交还
`SftpConnect`	`borrowObject(String sftpId)` 从连接池中获取一个sftp链接通过事先定义的 sftpId 获取sftp链接如果不存在则抛出异常注意: 使用完后需要自行调用 `returnSftp(SftpConnect)` 方法交还
`SftpConnect`	`borrowObject(String host, Integer port, String user, String password)` 从连接池中获取一个sftp链接如果不存在则创建一个新连接
`void`	`clear()` 清除池中闲置的对象
`void`	`clear(String sftpId)` 清除指定 Id 的对象
`void`	`close()` 关闭连接池
`int`	`getNumActive()` 获取活跃数, 也就是被从连接池中出来的sftp链接
`int`	`getNumActive(String sftpId)` 获取指定 Id 的活跃数
`int`	`getNumIdle()` 获取空闲数
`int`	`getNumIdle(String sftpId)` 获取指定 Id 的空闲数
`void`	`invalidateObject(String sftpId, SftpConnect sftpConnect)` 使池中的对象失效，当获取到的对象被确定无效时（由于异常或其他问题），应该调用该方法当要把一个借走的对象置为无效的时候。
`void`	`invalidateSftp(SftpConnect sftpConnect)`
`void`	`returnSftp(SftpConnect sftpConnect)` 将使用完的sftp链接交还给连接池
`void`	`setConfig(SftpPoolConfig config)`

从类继承的方法 org.apache.commons.pool2.impl.GenericKeyedObjectPool
addObject, borrowObject, clearOldest, evict, getFactory, getMaxIdlePerKey, getMaxTotalPerKey, getMinIdlePerKey, getNumActivePerKey, getNumWaiters, getNumWaitersByKey, listAllObjects, preparePool, returnObject, setConfig, setMaxIdlePerKey, setMaxTotalPerKey, setMinIdlePerKey, toStringAppendFields

从类继承的方法 org.apache.commons.pool2.impl.BaseGenericObjectPool
getBlockWhenExhausted, getBorrowedCount, getCreatedCount, getCreationStackTrace, getDestroyedByBorrowValidationCount, getDestroyedByEvictorCount, getDestroyedCount, getEvictionPolicy, getEvictionPolicyClassName, getEvictorShutdownTimeoutMillis, getFairness, getJmxName, getLifo, getMaxBorrowWaitTimeMillis, getMaxTotal, getMaxWaitMillis, getMeanActiveTimeMillis, getMeanBorrowWaitTimeMillis, getMeanIdleTimeMillis, getMinEvictableIdleTimeMillis, getNumTestsPerEvictionRun, getReturnedCount, getSoftMinEvictableIdleTimeMillis, getSwallowedExceptionListener, getTestOnBorrow, getTestOnCreate, getTestOnReturn, getTestWhileIdle, getTimeBetweenEvictionRunsMillis, isClosed, markReturningState, setBlockWhenExhausted, setConfig, setEvictionPolicy, setEvictionPolicyClassName, setEvictionPolicyClassName, setEvictorShutdownTimeoutMillis, setLifo, setMaxTotal, setMaxWaitMillis, setMinEvictableIdleTimeMillis, setNumTestsPerEvictionRun, setSoftMinEvictableIdleTimeMillis, setSwallowedExceptionListener, setTestOnBorrow, setTestOnCreate, setTestOnReturn, setTestWhileIdle, setTimeBetweenEvictionRunsMillis

从类继承的方法 org.apache.commons.pool2.BaseObject
toString

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

从接口继承的方法 org.apache.commons.pool2.impl.GenericKeyedObjectPoolMXBean
getBlockWhenExhausted, getBorrowedCount, getCreatedCount, getCreationStackTrace, getDestroyedByBorrowValidationCount, getDestroyedByEvictorCount, getDestroyedCount, getFairness, getLifo, getMaxBorrowWaitTimeMillis, getMaxTotal, getMaxWaitMillis, getMeanActiveTimeMillis, getMeanBorrowWaitTimeMillis, getMeanIdleTimeMillis, getMinEvictableIdleTimeMillis, getNumTestsPerEvictionRun, getReturnedCount, getTestOnBorrow, getTestOnCreate, getTestOnReturn, getTestWhileIdle, getTimeBetweenEvictionRunsMillis, isClosed

- 构造器详细资料
  - SftpPool
```
protected SftpPool(SftpPooledFactory factory,
                   org.apache.commons.pool2.impl.GenericKeyedObjectPoolConfig<SftpConnect> config)
```
- 方法详细资料
  - borrowObject
```
public SftpConnect borrowObject(SftpConnConfig config)
                         throws Exception
```
    从连接池中获取一个sftp链接注意: 使用完后需要自行调用 returnSftp(SftpConnect) 方法交还
    
    参数:
    
    config - sftp链接配置
    
    返回:
    
    sftp链接对象
    
    抛出:
    
    Exception
  - borrowObject
```
public SftpConnect borrowObject(String host,
                                Integer port,
                                String user,
                                String password)
                         throws Exception
```
    从连接池中获取一个sftp链接如果不存在则创建一个新连接
    
    参数:
    
    host - sftp服务ip
    
    port - 端口
    
    user - 用户名
    
    password - 密码
    
    返回:
    
    sftp链接对象
    
    抛出:
    
    Exception
  - borrowObject
```
public SftpConnect borrowObject(String sftpId)
                         throws Exception
```
    从连接池中获取一个sftp链接通过事先定义的 sftpId 获取sftp链接如果不存在则抛出异常注意: 使用完后需要自行调用 returnSftp(SftpConnect) 方法交还
    
    指定者:
    
    borrowObject 在接口中 org.apache.commons.pool2.KeyedObjectPool<String,SftpConnect>
    
    覆盖:
    
    borrowObject 在类中 org.apache.commons.pool2.impl.GenericKeyedObjectPool<String,SftpConnect>
    
    参数:
    
    sftpId - 通过事先定义的 sftpId 获取sftp链接
    
    返回:
    
    sftp链接对象
    
    抛出:
    
    Exception
  - invalidateObject
```
public void invalidateObject(String sftpId,
                             SftpConnect sftpConnect)
                      throws Exception
```
    使池中的对象失效，当获取到的对象被确定无效时（由于异常或其他问题），应该调用该方法当要把一个借走的对象置为无效的时候。（可能是因为对象的调用发生了异常或者其他未知原因）
    
    指定者:
    
    invalidateObject 在接口中 org.apache.commons.pool2.KeyedObjectPool<String,SftpConnect>
    
    覆盖:
    
    invalidateObject 在类中 org.apache.commons.pool2.impl.GenericKeyedObjectPool<String,SftpConnect>
    
    参数:
    
    sftpId - 指定sftp的唯一id
    
    sftpConnect - sftp链接对象
    
    抛出:
    
    Exception - 失效失败抛出异常
  - invalidateSftp
```
public void invalidateSftp(SftpConnect sftpConnect)
                    throws Exception
```
    抛出:
    
    Exception
  - returnSftp
```
public void returnSftp(SftpConnect sftpConnect)
```
    将使用完的sftp链接交还给连接池
    
    参数:
    
    sftpConnect - sftp链接对象
  - getNumActive
```
public int getNumActive()
```
    获取活跃数, 也就是被从连接池中出来的sftp链接
    
    指定者:
    
    getNumActive 在接口中 org.apache.commons.pool2.impl.GenericKeyedObjectPoolMXBean<String>
    
    指定者:
    
    getNumActive 在接口中 org.apache.commons.pool2.KeyedObjectPool<String,SftpConnect>
    
    覆盖:
    
    getNumActive 在类中 org.apache.commons.pool2.impl.GenericKeyedObjectPool<String,SftpConnect>
    
    返回:
    
    活跃状态的 sftp链接数
  - getNumActive
```
public int getNumActive(String sftpId)
```
    获取指定 Id 的活跃数
    
    指定者:
    
    getNumActive 在接口中 org.apache.commons.pool2.KeyedObjectPool<String,SftpConnect>
    
    覆盖:
    
    getNumActive 在类中 org.apache.commons.pool2.impl.GenericKeyedObjectPool<String,SftpConnect>
    
    参数:
    
    sftpId - 指定sftp的唯一id
    
    返回:
    
    活跃状态的 sftp链接数
  - getNumIdle
```
public int getNumIdle()
```
    获取空闲数
    
    指定者:
    
    getNumIdle 在接口中 org.apache.commons.pool2.impl.GenericKeyedObjectPoolMXBean<String>
    
    指定者:
    
    getNumIdle 在接口中 org.apache.commons.pool2.KeyedObjectPool<String,SftpConnect>
    
    覆盖:
    
    getNumIdle 在类中 org.apache.commons.pool2.impl.GenericKeyedObjectPool<String,SftpConnect>
    
    返回:
    
    空闲状态的sftp链接数
  - getNumIdle
```
public int getNumIdle(String sftpId)
```
    获取指定 Id 的空闲数
    
    指定者:
    
    getNumIdle 在接口中 org.apache.commons.pool2.KeyedObjectPool<String,SftpConnect>
    
    覆盖:
    
    getNumIdle 在类中 org.apache.commons.pool2.impl.GenericKeyedObjectPool<String,SftpConnect>
    
    参数:
    
    sftpId - 指定sftp的唯一id
    
    返回:
    
    空闲状态的sftp链接数
  - clear
```
public void clear()
```
    清除池中闲置的对象
    
    指定者:
    
    clear 在接口中 org.apache.commons.pool2.KeyedObjectPool<String,SftpConnect>
    
    覆盖:
    
    clear 在类中 org.apache.commons.pool2.impl.GenericKeyedObjectPool<String,SftpConnect>
  - clear
```
public void clear(String sftpId)
```
    清除指定 Id 的对象
    
    指定者:
    
    clear 在接口中 org.apache.commons.pool2.KeyedObjectPool<String,SftpConnect>
    
    覆盖:
    
    clear 在类中 org.apache.commons.pool2.impl.GenericKeyedObjectPool<String,SftpConnect>
    
    参数:
    
    sftpId - 指定sftp的唯一id
  - close
```
public void close()
```
    关闭连接池
    
    指定者:
    
    close 在接口中 Closeable
    
    指定者:
    
    close 在接口中 AutoCloseable
    
    指定者:
    
    close 在接口中 org.apache.commons.pool2.KeyedObjectPool<String,SftpConnect>
    
    覆盖:
    
    close 在类中 org.apache.commons.pool2.impl.GenericKeyedObjectPool<String,SftpConnect>
  - setConfig
```
public void setConfig(SftpPoolConfig config)
```

类 SftpPool

字段概要

从类继承的字段 org.apache.commons.pool2.impl.BaseGenericObjectPool

构造器概要

方法概要

从类继承的方法 org.apache.commons.pool2.impl.GenericKeyedObjectPool

从类继承的方法 org.apache.commons.pool2.impl.BaseGenericObjectPool

从类继承的方法 org.apache.commons.pool2.BaseObject

从类继承的方法 java.lang.Object

从接口继承的方法 org.apache.commons.pool2.impl.GenericKeyedObjectPoolMXBean

构造器详细资料

SftpPool

方法详细资料

borrowObject

borrowObject

borrowObject

invalidateObject

invalidateSftp

returnSftp

getNumActive

getNumActive

getNumIdle

getNumIdle

clear

clear

close

setConfig