net.sf.sshapi

Class AbstractSCPClient

java.lang.Object

net.sf.sshapi.AbstractLifecycleComponent

net.sf.sshapi.AbstractLifecycleComponentWithEvents

net.sf.sshapi.AbstractFileTransferClient

net.sf.sshapi.AbstractSCPClient

All Implemented Interfaces:

SshFileTransferClient, SshLifecycleComponent, SshSCPClient

Direct Known Subclasses:

LibsshSCPClient

public abstract class AbstractSCPClient
extends AbstractFileTransferClient
implements SshSCPClient

Abstract implementation of an SCP client. This adds checking of the parameters passed to put(String, String, File, boolean).

Constructor Summary

Constructors

Constructor and Description
AbstractSCPClient()

Method Summary

Modifier and Type	Method and Description
protected abstract void	doPut(java.lang.String remotePath, java.lang.String mode, java.io.File localfile, boolean recursive) Sub-classes should implement this to perform the actual upload of the file(s).
protected void	onClose()
protected void	onOpen()
void	put(java.lang.String remotePath, java.lang.String mode, java.io.File localfile, boolean recursive) Put a file or directory to a remote path.

Methods inherited from class net.sf.sshapi.AbstractFileTransferClient

addFileTransferListener, fireFileTransferFinished, fireFileTransferProgressed, fireFileTransferStarted, removeFileTransferListener

Methods inherited from class net.sf.sshapi.AbstractLifecycleComponentWithEvents

checkOpen, close, isOpen, open

Methods inherited from class net.sf.sshapi.AbstractLifecycleComponent

addListener, fireClosed, fireClosing, fireOpened, getListeners, removeListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.sshapi.SshSCPClient

get

Methods inherited from interface net.sf.sshapi.SshFileTransferClient

addFileTransferListener, removeFileTransferListener

Methods inherited from interface net.sf.sshapi.SshLifecycleComponent

addListener, close, isOpen, open, removeListener

Constructor Detail

AbstractSCPClient

public AbstractSCPClient()

Method Detail

onOpen

protected void onOpen()
               throws SshException

Specified by:

onOpen in class AbstractLifecycleComponentWithEvents

Throws:

SshException

onClose

protected void onClose()
                throws SshException

Specified by:

onClose in class AbstractLifecycleComponentWithEvents

Throws:

SshException

put

public final void put(java.lang.String remotePath,
                      java.lang.String mode,
                      java.io.File localfile,
                      boolean recursive)
               throws SshException

Description copied from interface: SshSCPClient

Put a file or directory to a remote path.

Specified by:

put in interface SshSCPClient

Parameters:

remotePath - path to copy file to.

mode - mode to create new files as

localfile - source file (or directory)

recursive - recursively copy this directory and all of it's children to the remote path

Throws:

SshException

doPut

protected abstract void doPut(java.lang.String remotePath,
                              java.lang.String mode,
                              java.io.File localfile,
                              boolean recursive)
                       throws SshException

Sub-classes should implement this to perform the actual upload of the file(s).

Parameters:

remotePath - remote path to upload files to

mode - mode string

localfile - local file to copy

recursive - recursive

Throws:

SshException - on any error