Package com.sshtools.j2ssh
Class ScpClient
java.lang.Object
com.sshtools.j2ssh.ScpClient
Implements a Secure Copy (SCP) client. This may be useful when the server does not support SFTP.
- Since:
- 0.2.0
- Version:
- $Revision: 1.18 $
- Author:
- Lee David Painter
-
Constructor Summary
ConstructorsConstructorDescriptionScpClient
(SshClient ssh, boolean verbose, ChannelEventListener eventListener) Creates an SCP client.ScpClient
(File cwd, SshClient ssh, boolean verbose, ChannelEventListener eventListener) Creates an SCP client. -
Method Summary
Modifier and TypeMethodDescriptionGets a remote file as anjava.io.InputStream
.void
Downloads an array of remote files to the local computer.void
Downloads a remote file onto the local computer.void
put
(InputStream in, long length, String localFile, String remoteFile) Uploads ajava.io.InputStream
to a remove server as file.void
Uploads an array of local files onto the remote server.void
Uploads a local file onto the remote server.
-
Constructor Details
-
ScpClient
Creates an SCP client. CWD (Current working directory) will be the CWD of the process that started this JVM.
- Parameters:
ssh
- A connected SshClientverbose
- Output verbose detaileventListener
-- Since:
- 0.2.0
-
ScpClient
Creates an SCP client.
- Parameters:
cwd
- The current local directoryssh
- A connected SshClientverbose
- Output verbose detaileventListener
-- Since:
- 0.2.0
-
-
Method Details
-
put
public void put(InputStream in, long length, String localFile, String remoteFile) throws IOException Uploads a
java.io.InputStream
to a remove server as file. You must supply the correct number of bytes that will be written.- Parameters:
in
- stream providing filelength
- number of bytes that will be writtenlocalFile
- local file nameremoteFile
- remote file name- Throws:
IOException
- on any error
-
get
Gets a remote file as an
java.io.InputStream
.- Parameters:
remoteFile
- remote file name- Returns:
- stream
- Throws:
IOException
- on any error
-
put
Uploads a local file onto the remote server.
- Parameters:
localFile
- The path to the local file relative to the local current directory; may be a file or directoryremoteFile
- The path on the remote server, may be a file or directoryrecursive
- Copy the contents of a directory recursivly- Throws:
IOException
- if an IO error occurs during the operation- Since:
- 0.2.0
-
put
Uploads an array of local files onto the remote server.
- Parameters:
localFiles
- an array of local files; may be files or directoriesremoteFile
- the path on the remote server, may be a file or directory1recursive
- Copy the contents of directorys recursivly- Throws:
IOException
- if an IO error occurs during the operation- Since:
- 0.2.0
-
get
Downloads an array of remote files to the local computer.
- Parameters:
localFile
- The local path to place the filesremoteFiles
- The path of the remote filesrecursive
- recursivly copy the contents of a directory- Throws:
IOException
- if an IO error occurs during the operation- Since:
- 0.2.0
-
get
Downloads a remote file onto the local computer.
- Parameters:
localFile
- The path to place the fileremoteFile
- The path of the file on the remote serverrecursive
- recursivly copy the contents of a directory- Throws:
IOException
- if an IO error occurs during the operation- Since:
- 0.2.0
-