public interface ScpClientCreator extends ScpFileOpenerHolder
Modifier and Type | Method and Description |
---|---|
default ScpClient |
createScpClient(ClientSession session)
Create an SCP client from this session.
|
default ScpClient |
createScpClient(ClientSession session,
ScpFileOpener opener)
Create an SCP client from this session.
|
ScpClient |
createScpClient(ClientSession session,
ScpFileOpener opener,
ScpTransferEventListener listener)
Create an SCP client from this session.
|
default ScpClient |
createScpClient(ClientSession session,
ScpTransferEventListener listener)
Create an SCP client from this session.
|
ScpTransferEventListener |
getScpTransferEventListener() |
static ScpClientCreator |
instance() |
void |
setScpTransferEventListener(ScpTransferEventListener listener) |
getScpFileOpener, setScpFileOpener
static ScpClientCreator instance()
default ScpClient createScpClient(ClientSession session)
session
- The ClientSession
ScpClient
instance. Note: uses the currently
registered ScpTransferEventListener
and ScpFileOpener
if anyScpFileOpenerHolder.setScpFileOpener(ScpFileOpener)
,
setScpTransferEventListener(ScpTransferEventListener)
default ScpClient createScpClient(ClientSession session, ScpTransferEventListener listener)
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)
ScpClient
instancedefault ScpClient createScpClient(ClientSession session, ScpFileOpener opener)
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)
ScpClient
instanceScpClient createScpClient(ClientSession session, ScpFileOpener opener, ScpTransferEventListener listener)
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)
ScpClient
instanceScpTransferEventListener getScpTransferEventListener()
ScpTransferEventListener
set via
setScpTransferEventListener(ScpTransferEventListener)
void setScpTransferEventListener(ScpTransferEventListener listener)
listener
- A default ScpTransferEventListener
that can be used
to receive information about the SCP operations - may be null
to indicate no more events are requiredcreateScpClient(ClientSession, ScpTransferEventListener)
Copyright © 2008–2022 The Apache Software Foundation. All rights reserved.