Apache Mina SSHD 2.15.0 · org.apache.sshd.scp.client.ScpClientCreator

Method Summary

Modifier and Type	Method and Description
public default ScpClient	Returns: An `ScpClient` instance Note uses the currently registered `ScpTransferEventListener` and `ScpFileOpener` if any createScpClient(ClientSession The `ClientSession` session) Create an SCP client from this session.
public default ScpClient	Returns: An `ScpClient` instance createScpClient(ClientSession The `ClientSession` session, ScpTransferEventListener 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)` listener) Create an SCP client from this session.
public default ScpClient	Returns: An `ScpClient` instance createScpClient(ClientSession The `ClientSession` session, ScpFileOpener 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 `setScpFileOpener(ScpFileOpener)` opener) Create an SCP client from this session.
public ScpClient	Returns: An `ScpClient` instance createScpClient(ClientSession The `ClientSession` session, ScpFileOpener 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 `setScpFileOpener(ScpFileOpener)` opener, ScpTransferEventListener 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)` listener) Create an SCP client from this session.
public ScpTransferEventListener	Returns: The last `ScpTransferEventListener` set via `setScpTransferEventListener(ScpTransferEventListener)` getScpTransferEventListener()
public static ScpClientCreator	instance()
public void	setScpTransferEventListener(ScpTransferEventListener A default `ScpTransferEventListener` that can be used to receive information about the SCP operations - may be `null` to indicate no more events are required listener)

Inherited from org.apache.sshd.scp.common.ScpFileOpenerHolder:: getScpFileOpener setScpFileOpener

Method Detail

createScpClient back to summary

createScpClient	back to summary
public default ScpClient createScpClient(ClientSession session) Create an SCP client from this session. Parameters session:ClientSession The `ClientSession` Returns:ScpClient An `ScpClient` instance Note uses the currently registered `ScpTransferEventListener` and `ScpFileOpener` if any See Also `setScpFileOpener(ScpFileOpener)`, `setScpTransferEventListener(ScpTransferEventListener)`

public default ScpClient createScpClient(ClientSession session)

Create an SCP client from this session.

Parameters

session:ClientSession: The ClientSession

Returns:ScpClient

An ScpClient instance

Note

uses the currently registered ScpTransferEventListener and ScpFileOpener if any

createScpClient back to summary

createScpClient	back to summary
public default ScpClient createScpClient(ClientSession session, ScpTransferEventListener listener) Create an SCP client from this session. Parameters session:ClientSession The `ClientSession` listener:ScpTransferEventListener 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:ScpClient An `ScpClient` instance

public default ScpClient createScpClient(ClientSession session, ScpTransferEventListener listener)

Create an SCP client from this session.

Parameters

session:ClientSession: The ClientSession
listener:ScpTransferEventListener: 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:ScpClient

An ScpClient instance

createScpClient back to summary

createScpClient	back to summary
public default ScpClient createScpClient(ClientSession session, ScpFileOpener opener) Create an SCP client from this session. Parameters session:ClientSession The `ClientSession` opener:ScpFileOpener 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 `setScpFileOpener(ScpFileOpener)` Returns:ScpClient An `ScpClient` instance

public default ScpClient createScpClient(ClientSession session, ScpFileOpener opener)

Create an SCP client from this session.

Parameters

session:ClientSession: The ClientSession
opener:ScpFileOpener: 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 setScpFileOpener(ScpFileOpener)

Returns:ScpClient

An ScpClient instance

createScpClient back to summary

createScpClient	back to summary
public ScpClient createScpClient(ClientSession session, ScpFileOpener opener, ScpTransferEventListener listener) Create an SCP client from this session. Parameters session:ClientSession The `ClientSession` opener:ScpFileOpener 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 `setScpFileOpener(ScpFileOpener)` listener:ScpTransferEventListener 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:ScpClient An `ScpClient` instance

public ScpClient createScpClient(ClientSession session, ScpFileOpener opener, ScpTransferEventListener listener)

Create an SCP client from this session.

Parameters

session:ClientSession: The ClientSession
opener:ScpFileOpener: 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 setScpFileOpener(ScpFileOpener)
listener:ScpTransferEventListener: 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:ScpClient

An ScpClient instance

getScpTransferEventListener	back to summary
public ScpTransferEventListener getScpTransferEventListener() Returns:ScpTransferEventListener The last `ScpTransferEventListener` set via `setScpTransferEventListener(ScpTransferEventListener)`

instance	back to summary
public static ScpClientCreator instance()

setScpTransferEventListener	back to summary
public void setScpTransferEventListener(ScpTransferEventListener listener) Parameters listener:ScpTransferEventListener 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)`

public Interface ScpClientCreator

Method Summary

Method Detail