Package org.apache.sshd.scp.client
Interface ScpClientCreator
- All Superinterfaces:
ScpFileOpenerHolder
- All Known Implementing Classes:
AbstractScpClientCreator
,DefaultScpClientCreator
-
Method Summary
Modifier and TypeMethodDescriptiondefault 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.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.static ScpClientCreator
instance()
void
Methods inherited from interface org.apache.sshd.scp.common.ScpFileOpenerHolder
getScpFileOpener, setScpFileOpener
-
Method Details
-
instance
-
createScpClient
Create an SCP client from this session.- Parameters:
session
- TheClientSession
- Returns:
- An
ScpClient
instance. Note: uses the currently registeredScpTransferEventListener
andScpFileOpener
if any - See Also:
-
createScpClient
Create an SCP client from this session.- Parameters:
session
- TheClientSession
listener
- AScpTransferEventListener
that can be used to receive information about the SCP operations - may benull
to indicate no more events are required. Note: this listener is used instead of any listener set viasetScpTransferEventListener(ScpTransferEventListener)
- Returns:
- An
ScpClient
instance
-
createScpClient
Create an SCP client from this session.- Parameters:
session
- TheClientSession
opener
- TheScpFileOpener
to use to control how local files are read/written. Ifnull
then a default opener is used. Note: this opener is used instead of any instance set viaScpFileOpenerHolder.setScpFileOpener(ScpFileOpener)
- Returns:
- An
ScpClient
instance
-
createScpClient
ScpClient createScpClient(ClientSession session, ScpFileOpener opener, ScpTransferEventListener listener) Create an SCP client from this session.- Parameters:
session
- TheClientSession
opener
- TheScpFileOpener
to use to control how local files are read/written. Ifnull
then a default opener is used. Note: this opener is used instead of any instance set viaScpFileOpenerHolder.setScpFileOpener(ScpFileOpener)
listener
- AScpTransferEventListener
that can be used to receive information about the SCP operations - may benull
to indicate no more events are required. Note: this listener is used instead of any listener set viasetScpTransferEventListener(ScpTransferEventListener)
- Returns:
- An
ScpClient
instance
-
getScpTransferEventListener
ScpTransferEventListener getScpTransferEventListener()- Returns:
- The last
ScpTransferEventListener
set viasetScpTransferEventListener(ScpTransferEventListener)
-
setScpTransferEventListener
- Parameters:
listener
- A defaultScpTransferEventListener
that can be used to receive information about the SCP operations - may benull
to indicate no more events are required- See Also:
-