Class scp

java.lang.Object

scp

All Implemented Interfaces:

Logger, SshFileTransferListener

public class scp
extends java.lang.Object
implements SshFileTransferListener, Logger

Java clone of the de-facto standard OpenSSH scp command.

Nested Class Summary

Nested classes/interfaces inherited from interface net.sf.sshapi.Logger

Logger.Level

Constructor Summary

Constructors

Constructor and Description
scp() Constructor.

Method Summary

Modifier and Type	Method and Description
void	finishedTransfer(java.lang.String path, java.lang.String targetPath) A file transfer has finished.
boolean	isLevelEnabled(Logger.Level level) Determine if messages at the specified log level will be displayed.
void	log(Logger.Level level, java.lang.String message) Log a message at the specified level.
void	log(Logger.Level level, java.lang.String message, java.lang.Throwable exception) Log a message and an optional exception at the specified level.
static void	main(java.lang.String[] args) Entry point.
void	start() Start the command.
void	startedTransfer(java.lang.String path, java.lang.String targetPath, long length) A new file transfer has started.
void	transferProgress(java.lang.String path, java.lang.String targetPath, long progress) A file transfer has progressed.

Methods inherited from class java.lang.Object

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

Constructor Detail

scp

public scp()
    throws SshException

Constructor.

Throws:

SshException

Method Detail

start

public void start()
           throws SshException,
                  java.io.IOException

Start the command.

Throws:

SshException

java.io.IOException

main

public static void main(java.lang.String[] args)
                 throws SshException

Entry point.

Parameters:

args - command line arguments

Throws:

SshException

startedTransfer

public void startedTransfer(java.lang.String path,
                            java.lang.String targetPath,
                            long length)

Description copied from interface: SshFileTransferListener

A new file transfer has started.

Specified by:

startedTransfer in interface SshFileTransferListener

Parameters:

path - path of file (may be null if the source is a stream)

targetPath - path of file (may be null if the target is a stream)

length - total length of file (or -1 if not known)

transferProgress

public void transferProgress(java.lang.String path,
                             java.lang.String targetPath,
                             long progress)

Description copied from interface: SshFileTransferListener

A file transfer has progressed. The amount of bytes that may have been transmitted since the last progress will depend on the buffer size. .

Specified by:

transferProgress in interface SshFileTransferListener

Parameters:

path - path of file (may be null if the source is a stream)

targetPath - path of file (may be null if the target is a stream)

progress - number of bytes sent since the last progress

finishedTransfer

public void finishedTransfer(java.lang.String path,
                             java.lang.String targetPath)

Description copied from interface: SshFileTransferListener

A file transfer has finished.

Specified by:

finishedTransfer in interface SshFileTransferListener

Parameters:

path - path of file (may be null if the source is a stream)

targetPath - path of file (may be null if the target is a stream)

log

public void log(Logger.Level level,
                java.lang.String message)

Description copied from interface: Logger

Log a message at the specified level.

Specified by:

log in interface Logger

Parameters:

level - level

message - message

log

public void log(Logger.Level level,
                java.lang.String message,
                java.lang.Throwable exception)

Description copied from interface: Logger

Log a message and an optional exception at the specified level.

Specified by:

log in interface Logger

Parameters:

level - level

message - message

exception - exception

isLevelEnabled

public boolean isLevelEnabled(Logger.Level level)

Description copied from interface: Logger

Determine if messages at the specified log level will be displayed.

Specified by:

isLevelEnabled in interface Logger

Parameters:

level - level

Returns:

level enabled