org.apache.sshd.client.scp

Interface ScpClientCreator

All Superinterfaces:

ScpFileOpenerHolder

All Known Subinterfaces:

ClientSession

All Known Implementing Classes:

AbstractClientSession, ClientSessionImpl

public interface ScpClientCreator
extends ScpFileOpenerHolder

Author:

Apache MINA SSHD Project

Method Summary

Modifier and Type	Method and Description
default ScpClient	createScpClient() Create an SCP client from this session.
default ScpClient	createScpClient(ScpFileOpener opener) Create an SCP client from this session.
ScpClient	createScpClient(ScpFileOpener opener, ScpTransferEventListener listener) Create an SCP client from this session.
default ScpClient	createScpClient(ScpTransferEventListener listener) Create an SCP client from this session.
ScpTransferEventListener	getScpTransferEventListener()
void	setScpTransferEventListener(ScpTransferEventListener listener)

Methods inherited from interface org.apache.sshd.common.scp.ScpFileOpenerHolder

getScpFileOpener, setScpFileOpener

Method Detail

createScpClient

default ScpClient createScpClient()

Create an SCP client from this session.

Returns:

An ScpClient instance. Note: uses the currently registered ScpTransferEventListener and ScpFileOpener if any

See Also:

ScpFileOpenerHolder.setScpFileOpener(ScpFileOpener), setScpTransferEventListener(ScpTransferEventListener)

createScpClient

default ScpClient createScpClient(ScpTransferEventListener listener)

Create an SCP client from this session.

Parameters:

listener - A ScpTransferEventListener that can be used to receive information about the SCP operations - may be null to indicate no more events are required. Note: this listener is used instead of any listener set via setScpTransferEventListener(ScpTransferEventListener)

Returns:

An ScpClient instance

createScpClient

default ScpClient createScpClient(ScpFileOpener opener)

Create an SCP client from this session.

Parameters:

opener - The ScpFileOpener to use to control how local files are read/written. If null then a default opener is used. Note: this opener is used instead of any instance set via ScpFileOpenerHolder.setScpFileOpener(ScpFileOpener)

Returns:

An ScpClient instance

createScpClient

ScpClient createScpClient(ScpFileOpener opener,
                          ScpTransferEventListener listener)

Create an SCP client from this session.

Parameters:

opener - The ScpFileOpener to use to control how local files are read/written. If null then a default opener is used. Note: this opener is used instead of any instance set via ScpFileOpenerHolder.setScpFileOpener(ScpFileOpener)

listener - A ScpTransferEventListener that can be used to receive information about the SCP operations - may be null to indicate no more events are required. Note: this listener is used instead of any listener set via setScpTransferEventListener(ScpTransferEventListener)

Returns:

An ScpClient instance

getScpTransferEventListener

ScpTransferEventListener getScpTransferEventListener()

Returns:

The last ScpTransferEventListener set via setScpTransferEventListener(ScpTransferEventListener)

setScpTransferEventListener

void setScpTransferEventListener(ScpTransferEventListener listener)

Parameters:

listener - A default ScpTransferEventListener that can be used to receive information about the SCP operations - may be null to indicate no more events are required

See Also:

createScpClient(ScpTransferEventListener)