net.scharlie.lj4l.core.io.remote.sftp

Class SftpSessionBuilder

java.lang.Object

net.scharlie.lj4l.core.io.remote.sftp.SftpSessionBuilder

public final class SftpSessionBuilder
extends Object

This class is a tool for building a SFTP session.

Instances of this class are not safe for use by multiple threads.

Constructor Summary

Constructors

Constructor and Description
SftpSessionBuilder(String hostName, int port, String userName) Create a builder.
SftpSessionBuilder(String hostName, String userName) Create a builder with a default port value.

Method Summary

Modifier and Type	Method and Description
SftpSession	build() Create a SFTP session from the gathered parameters.
SftpSessionBuilder	setPassphrase(String passphrase) Set the private key pass-phrase.
SftpSessionBuilder	setPassword(String password) Set the user password.
SftpSessionBuilder	setPrivateKeyFilePath(String privateKeyFilePath) Set the path to the private key file.

Methods inherited from class java.lang.Object

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

Constructor Detail

SftpSessionBuilder

public SftpSessionBuilder(String hostName,
                          String userName)

Create a builder with a default port value.

Parameters:

hostName - The host name

userName - The user name

SftpSessionBuilder

public SftpSessionBuilder(String hostName,
                          int port,
                          String userName)

Create a builder.

Parameters:

hostName - The host name

port - The port number

userName - The user name

Method Detail

setPassword

public final SftpSessionBuilder setPassword(String password)

Set the user password.

Parameters:

password - The user password

Returns:

This builder

setPrivateKeyFilePath

public final SftpSessionBuilder setPrivateKeyFilePath(String privateKeyFilePath)

Set the path to the private key file.

Parameters:

privateKeyFilePath - The path to the private key file

Returns:

This builder

setPassphrase

public final SftpSessionBuilder setPassphrase(String passphrase)

Set the private key pass-phrase.

Parameters:

passphrase - The private key pass-phrase

Returns:

This builder

build

public final SftpSession build()

Create a SFTP session from the gathered parameters.

Returns:

SFTP session