Package org.apache.sshd.scp.client
Interface ScpClientCreator
- All Superinterfaces:
ScpFileOpenerHolder
- All Known Implementing Classes:
AbstractScpClientCreator,DefaultScpClientCreator
-
Method Summary
Modifier and TypeMethodDescriptiondefault ScpClientcreateScpClient(ClientSession session) Create an SCP client from this session.default ScpClientcreateScpClient(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 ScpClientcreateScpClient(ClientSession session, ScpTransferEventListener listener) Create an SCP client from this session.static ScpClientCreatorinstance()voidMethods 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
ScpClientinstance. Note: uses the currently registeredScpTransferEventListenerandScpFileOpenerif any - See Also:
-
createScpClient
Create an SCP client from this session.- Parameters:
session- TheClientSessionlistener- AScpTransferEventListenerthat can be used to receive information about the SCP operations - may benullto indicate no more events are required. Note: this listener is used instead of any listener set viasetScpTransferEventListener(ScpTransferEventListener)- Returns:
- An
ScpClientinstance
-
createScpClient
Create an SCP client from this session.- Parameters:
session- TheClientSessionopener- TheScpFileOpenerto use to control how local files are read/written. Ifnullthen a default opener is used. Note: this opener is used instead of any instance set viaScpFileOpenerHolder.setScpFileOpener(ScpFileOpener)- Returns:
- An
ScpClientinstance
-
createScpClient
ScpClient createScpClient(ClientSession session, ScpFileOpener opener, ScpTransferEventListener listener) Create an SCP client from this session.- Parameters:
session- TheClientSessionopener- TheScpFileOpenerto use to control how local files are read/written. Ifnullthen a default opener is used. Note: this opener is used instead of any instance set viaScpFileOpenerHolder.setScpFileOpener(ScpFileOpener)listener- AScpTransferEventListenerthat can be used to receive information about the SCP operations - may benullto indicate no more events are required. Note: this listener is used instead of any listener set viasetScpTransferEventListener(ScpTransferEventListener)- Returns:
- An
ScpClientinstance
-
getScpTransferEventListener
ScpTransferEventListener getScpTransferEventListener()- Returns:
- The last
ScpTransferEventListenerset viasetScpTransferEventListener(ScpTransferEventListener)
-
setScpTransferEventListener
- Parameters:
listener- A defaultScpTransferEventListenerthat can be used to receive information about the SCP operations - may benullto indicate no more events are required- See Also:
-