Package org.apache.sshd.scp.client

Interface ScpClientCreator

All Superinterfaces:

ScpFileOpenerHolder

All Known Implementing Classes:

AbstractScpClientCreator, DefaultScpClientCreator

public interface ScpClientCreator
extends ScpFileOpenerHolder

Author:

Apache MINA SSHD Project

Method Summary

Modifier and Type	Method	Description
default ScpClient	createScpClient(org.apache.sshd.client.session.ClientSession session)	Create an SCP client from this session.
default ScpClient	createScpClient(org.apache.sshd.client.session.ClientSession session, ScpFileOpener opener)	Create an SCP client from this session.
ScpClient	createScpClient(org.apache.sshd.client.session.ClientSession session, ScpFileOpener opener, ScpTransferEventListener listener)	Create an SCP client from this session.
default ScpClient	createScpClient(org.apache.sshd.client.session.ClientSession session, ScpTransferEventListener listener)	Create an SCP client from this session.
ScpTransferEventListener	getScpTransferEventListener()
static ScpClientCreator	instance()
void	setScpTransferEventListener(ScpTransferEventListener listener)

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

getScpFileOpener, setScpFileOpener

Method Details

instance

static ScpClientCreator instance()

createScpClient

default ScpClient createScpClient(org.apache.sshd.client.session.ClientSession session)

Create an SCP client from this session.

Parameters:

session - The ClientSession

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(org.apache.sshd.client.session.ClientSession session,
 ScpTransferEventListener listener)

Create an SCP client from this session.

Parameters:

session - The ClientSession

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(org.apache.sshd.client.session.ClientSession session,
 ScpFileOpener opener)

Create an SCP client from this session.

Parameters:

session - The ClientSession

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(org.apache.sshd.client.session.ClientSession session,
 ScpFileOpener opener,
 ScpTransferEventListener listener)

Create an SCP client from this session.

Parameters:

session - The ClientSession

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(ClientSession, ScpTransferEventListener)