com.github.robtimus.filesystems.sftp

Class SFTPPoolConfig

java.lang.Object

com.github.robtimus.filesystems.sftp.SFTPPoolConfig

public final class SFTPPoolConfig
extends Object

Configuration for the client connection pools of SFTP file systems.

Instances of this class are immutable and thread-safe.

Author:

Rob Spoor

Since:

3.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SFTPPoolConfig.Builder A builder for SFTPPoolConfig objects.

Method Summary

Modifier and Type	Method and Description
static SFTPPoolConfig.Builder	custom() Returns a new builder for creating SFTPPoolConfig objects.
static SFTPPoolConfig	defaultConfig() Returns a default SFTPPoolConfig object.
int	initialSize() Returns the initial pool size.
Optional<Duration>	maxIdleTime() Returns the maximum time that client connections can be idle.
int	maxSize() Returns the maximum pool size.
Optional<Duration>	maxWaitTime() Returns the maximum time to wait when acquiring client connections.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

maxWaitTime

public Optional<Duration> maxWaitTime()

Returns the maximum time to wait when acquiring client connections.

Returns:

An Optional describing the maximum time to wait when acquiring client connections, or Optional#empty() to wait indefinitely.

maxIdleTime

public Optional<Duration> maxIdleTime()

Returns the maximum time that client connections can be idle.

Returns:

An Optional describing the maximum time that client connections can be idle, or Optional.empty() if client connections can be idle indefinitely.

initialSize

public int initialSize()

Returns the initial pool size. This is the number of idle client connections to start with.

Returns:

The initial pool size.

maxSize

public int maxSize()

Returns the maximum pool size. This is the maximum number of client connections, both idle and currently in use.

Returns:

The maximum pool size.

toString

public String toString()

Overrides:

toString in class Object

defaultConfig

public static SFTPPoolConfig defaultConfig()

Returns a default SFTPPoolConfig object. This has the same configuration as an object returned by custom().build().

Returns:

A default SFTPPoolConfig object.

See Also:

custom()

custom

public static SFTPPoolConfig.Builder custom()

Returns a new builder for creating SFTPPoolConfig objects.

Returns:

A new builder for creating SFTPPoolConfig objects.