Class SCPFileTransfer

java.lang.Object

net.schmizz.sshj.xfer.AbstractFileTransfer

net.schmizz.sshj.xfer.scp.SCPFileTransfer

All Implemented Interfaces:

FileTransfer

public class SCPFileTransfer
extends AbstractFileTransfer
implements FileTransfer

Field Summary

Fields

Modifier and Type	Field	Description
private int	bandwidthLimit
private static final int	DEFAULT_BANDWIDTH_LIMIT	Default bandwidth limit for SCP transfer in kilobit/s (-1 means unlimited)
private final SessionFactory	sessionFactory

Fields inherited from class AbstractFileTransfer

log, loggerFactory

Constructor Summary

Constructors

Constructor	Description
SCPFileTransfer(SessionFactory sessionFactory, LoggerFactory loggerFactory)

Method Summary

Modifier and Type	Method	Description
SCPFileTransfer	bandwidthLimit(int limit)
private void	checkByteOffsetSupport(long byteOffset)
void	download(String remotePath, String localPath)	This is meant to delegate to FileTransfer.download(String, LocalDestFile) with the localPath wrapped as e.g.
void	download(String remotePath, String localPath, long byteOffset)	This is meant to delegate to FileTransfer.download(String, LocalDestFile) with the localPath wrapped as e.g.
void	download(String remotePath, LocalDestFile localFile)	Download remotePath to localFile.
void	download(String remotePath, LocalDestFile localFile, long byteOffset)	Download remotePath to localFile.
SCPDownloadClient	newSCPDownloadClient()
private SCPEngine	newSCPEngine()
SCPUploadClient	newSCPUploadClient()
void	upload(String localPath, String remotePath)	This is meant to delegate to FileTransfer.upload(LocalSourceFile, String) with the localPath wrapped as e.g.
void	upload(String localFile, String remotePath, long byteOffset)	This is meant to delegate to FileTransfer.upload(LocalSourceFile, String) with the localPath wrapped as e.g.
void	upload(LocalSourceFile localFile, String remotePath)	Upload localFile to remotePath.
void	upload(LocalSourceFile localFile, String remotePath, long byteOffset)	Upload localFile to remotePath.

Methods inherited from class AbstractFileTransfer

getTransferListener, setTransferListener

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface FileTransfer

getTransferListener, setTransferListener

Field Details

DEFAULT_BANDWIDTH_LIMIT

private static final int DEFAULT_BANDWIDTH_LIMIT

Default bandwidth limit for SCP transfer in kilobit/s (-1 means unlimited)

See Also:

• Constant Field Values

sessionFactory

private final SessionFactory sessionFactory

bandwidthLimit

private int bandwidthLimit

Constructor Details

SCPFileTransfer

public SCPFileTransfer(SessionFactory sessionFactory,
 LoggerFactory loggerFactory)

Method Details

newSCPDownloadClient

public SCPDownloadClient newSCPDownloadClient()

newSCPUploadClient

public SCPUploadClient newSCPUploadClient()

newSCPEngine

private SCPEngine newSCPEngine()

upload

public void upload(String localPath,
 String remotePath)
            throws IOException

Description copied from interface: FileTransfer

This is meant to delegate to FileTransfer.upload(LocalSourceFile, String) with the localPath wrapped as e.g. a FileSystemFile.

Specified by:

upload in interface FileTransfer

Parameters:

localPath -

remotePath -

Throws:

IOException

upload

public void upload(String localFile,
 String remotePath,
 long byteOffset)
            throws IOException

Description copied from interface: FileTransfer

This is meant to delegate to FileTransfer.upload(LocalSourceFile, String) with the localPath wrapped as e.g. a FileSystemFile. Appends to existing if byteOffset > 0.

Specified by:

upload in interface FileTransfer

Parameters:

localFile -

remotePath -

byteOffset -

Throws:

IOException

download

public void download(String remotePath,
 String localPath)
              throws IOException

Description copied from interface: FileTransfer

This is meant to delegate to FileTransfer.download(String, LocalDestFile) with the localPath wrapped as e.g. a FileSystemFile.

Specified by:

download in interface FileTransfer

Parameters:

remotePath -

localPath -

Throws:

IOException

download

public void download(String remotePath,
 String localPath,
 long byteOffset)
              throws IOException

Description copied from interface: FileTransfer

This is meant to delegate to FileTransfer.download(String, LocalDestFile) with the localPath wrapped as e.g. a FileSystemFile. Appends to existing if byteOffset > 0.

Specified by:

download in interface FileTransfer

Parameters:

remotePath -

localPath -

byteOffset -

Throws:

IOException

download

public void download(String remotePath,
 LocalDestFile localFile)
              throws IOException

Description copied from interface: FileTransfer

Download remotePath to localFile.

Specified by:

download in interface FileTransfer

Parameters:

remotePath -

localFile -

Throws:

IOException

download

public void download(String remotePath,
 LocalDestFile localFile,
 long byteOffset)
              throws IOException

Description copied from interface: FileTransfer

Download remotePath to localFile. Appends to existing if byteOffset > 0.

Specified by:

download in interface FileTransfer

Parameters:

remotePath -

localFile -

byteOffset -

Throws:

IOException

upload

public void upload(LocalSourceFile localFile,
 String remotePath)
            throws IOException

Description copied from interface: FileTransfer

Upload localFile to remotePath.

Specified by:

upload in interface FileTransfer

Parameters:

localFile -

remotePath -

Throws:

IOException

upload

public void upload(LocalSourceFile localFile,
 String remotePath,
 long byteOffset)
            throws IOException

Description copied from interface: FileTransfer

Upload localFile to remotePath. Appends to existing if byteOffset > 0.

Specified by:

upload in interface FileTransfer

Parameters:

localFile -

remotePath -

byteOffset -

Throws:

IOException

bandwidthLimit

public SCPFileTransfer bandwidthLimit(int limit)

checkByteOffsetSupport

private void checkByteOffsetSupport(long byteOffset)
                             throws IOException

Throws:

IOException