com.github.robtimus.filesystems.sftp

Class SFTPPoolConfig.Builder

java.lang.Object

com.github.robtimus.filesystems.sftp.SFTPPoolConfig.Builder

Enclosing class:

SFTPPoolConfig

public static final class SFTPPoolConfig.Builder
extends Object

A builder for SFTPPoolConfig objects.

Author:

Rob Spoor

Since:

3.0

Method Summary

Modifier and Type	Method and Description
SFTPPoolConfig	build() Creates a new SFTPPoolConfig object based on the settings of this builder.
SFTPPoolConfig.Builder	withInitialSize(int initialSize) Sets the initial pool size.
SFTPPoolConfig.Builder	withMaxIdleTime(Duration maxIdleTime) Sets the maximum time that client connections can be idle.
SFTPPoolConfig.Builder	withMaxSize(int maxSize) Sets the maximum pool size.
SFTPPoolConfig.Builder	withMaxWaitTime(Duration maxWaitTime) Sets the maximum time to wait when acquiring client connections.

Methods inherited from class java.lang.Object

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

Method Detail

withMaxWaitTime

public SFTPPoolConfig.Builder withMaxWaitTime(Duration maxWaitTime)

Sets the maximum time to wait when acquiring client connections. If null or negative, acquiring client connections should block until a connection is available. The default is to wait indefinitely.

Parameters:

maxWaitTime - The maximum wait time.

Returns:

This builder.

withMaxIdleTime

public SFTPPoolConfig.Builder withMaxIdleTime(Duration maxIdleTime)

Sets the maximum time that client connections can be idle. The default is indefinitely.

Parameters:

maxIdleTime - The maximum idle time, or null if client connections can be idle indefinitely.

Returns:

This builder.

withInitialSize

public SFTPPoolConfig.Builder withInitialSize(int initialSize)

Sets the initial pool size. This is the number of idle client connections to start with. The default is 1.

If the maximum pool size is smaller than the given initial size, it will be set to be equal to the given initial size.

Parameters:

initialSize - The initial pool size.

Returns:

This builder.

Throws:

IllegalArgumentException - If the initial size is negative.

withMaxSize

public SFTPPoolConfig.Builder withMaxSize(int maxSize)

Sets the maximum pool size. This is the maximum number of client connections, both idle and currently in use. The default is 5.

If the initial pool size is larger than the given maximum size, it will be set to be equal to the given maximum size.

Parameters:

maxSize - The maximum pool size.

Returns:

This builder.

Throws:

IllegalArgumentException - If the given size is not positive.

build

public SFTPPoolConfig build()

Creates a new SFTPPoolConfig object based on the settings of this builder.

Returns:

The created SFTPPoolConfig object.