org.apache.maven.wagon.providers.ssh.external

Class ScpExternalWagon

java.lang.Object

org.apache.maven.wagon.AbstractWagon

org.apache.maven.wagon.providers.ssh.external.ScpExternalWagon

All Implemented Interfaces:

CommandExecutor, Wagon

Direct Known Subclasses:

ScpExternalCommandExecutor

public class ScpExternalWagon
extends AbstractWagon
implements CommandExecutor

SCP deployer using "external" scp program. To allow for ssh-agent type behavior, until we can construct a Java SSH Agent and interface for JSch.

Author:

Brett Porter

Field Summary

Fields inherited from class org.apache.maven.wagon.AbstractWagon

authenticationInfo, BUFFER_SEGMENT_SIZE, DEFAULT_BUFFER_SIZE, interactive, MAXIMUM_BUFFER_SIZE, MINIMUM_AMOUNT_OF_TRANSFER_CHUNKS, proxyInfo, repository, sessionEventSupport, transferEventSupport

Fields inherited from interface org.apache.maven.wagon.CommandExecutor

ROLE

Fields inherited from interface org.apache.maven.wagon.Wagon

DEFAULT_CONNECTION_TIMEOUT, DEFAULT_READ_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
ScpExternalWagon()

Method Summary

Modifier and Type	Method and Description
void	closeConnection()
void	executeCommand(String command)
Streams	executeCommand(String command, boolean ignoreFailures)
void	get(String resourceName, File destination)
List<String>	getFileList(String destinationDirectory)
boolean	getIfNewer(String resourceName, File destination, long timestamp)
String	getScpArgs()
String	getScpExecutable()
String	getSshArgs()
String	getSshExecutable()
protected boolean	isPuTTY()
protected void	openConnectionInternal()
void	put(File source, String destination)
void	putDirectory(File sourceDirectory, String destinationDirectory)
boolean	resourceExists(String resourceName)
void	setScpArgs(String scpArgs)
void	setScpExecutable(String scpExecutable)
void	setSshArgs(String sshArgs)
void	setSshExecutable(String sshExecutable)
boolean	supportsDirectoryCopy()

Methods inherited from class org.apache.maven.wagon.AbstractWagon

addSessionListener, addTransferListener, cleanupGetTransfer, cleanupPutTransfer, connect, connect, connect, connect, connect, connect, createParentDirectories, disconnect, finishGetTransfer, finishPutTransfer, fireGetCompleted, fireGetInitiated, fireGetStarted, firePutCompleted, firePutInitiated, firePutStarted, fireSessionConnectionRefused, fireSessionDebug, fireSessionDisconnected, fireSessionDisconnecting, fireSessionError, fireSessionLoggedIn, fireSessionLoggedOff, fireSessionOpened, fireSessionOpening, fireTransferDebug, fireTransferError, fireTransferProgress, getAuthenticationInfo, getBufferCapacityForTransfer, getPath, getPermissionsOverride, getProxyInfo, getProxyInfo, getReadTimeout, getRepository, getSessionEventSupport, getTimeout, getTransfer, getTransfer, getTransfer, getTransfer, getTransfer, getTransfer, getTransferEventSupport, hasSessionListener, hasTransferListener, isInteractive, openConnection, postProcessListeners, putTransfer, putTransfer, removeSessionListener, removeTransferListener, setInteractive, setPermissionsOverride, setReadTimeout, setSessionEventSupport, setTimeout, setTransferEventSupport, transfer, transfer, transfer, transfer

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.maven.wagon.Wagon

addSessionListener, addTransferListener, connect, connect, connect, connect, connect, connect, disconnect, getReadTimeout, getRepository, getTimeout, hasSessionListener, hasTransferListener, isInteractive, openConnection, removeSessionListener, removeTransferListener, setInteractive, setReadTimeout, setTimeout

Constructor Detail

ScpExternalWagon

public ScpExternalWagon()

Method Detail

openConnectionInternal

protected void openConnectionInternal()
                               throws AuthenticationException

Specified by:

openConnectionInternal in class AbstractWagon

Throws:

AuthenticationException

closeConnection

public void closeConnection()

Specified by:

closeConnection in class AbstractWagon

getIfNewer

public boolean getIfNewer(String resourceName,
                          File destination,
                          long timestamp)
                   throws TransferFailedException,
                          ResourceDoesNotExistException,
                          AuthorizationException

Specified by:

getIfNewer in interface Wagon

Throws:

TransferFailedException

ResourceDoesNotExistException

AuthorizationException

executeCommand

public void executeCommand(String command)
                    throws CommandExecutionException

Specified by:

executeCommand in interface CommandExecutor

Throws:

CommandExecutionException

executeCommand

public Streams executeCommand(String command,
                              boolean ignoreFailures)
                       throws CommandExecutionException

Specified by:

executeCommand in interface CommandExecutor

Throws:

CommandExecutionException

isPuTTY

protected boolean isPuTTY()

put

public void put(File source,
                String destination)
         throws TransferFailedException,
                ResourceDoesNotExistException,
                AuthorizationException

Specified by:

put in interface Wagon

Throws:

TransferFailedException

ResourceDoesNotExistException

AuthorizationException

get

public void get(String resourceName,
                File destination)
         throws TransferFailedException,
                ResourceDoesNotExistException,
                AuthorizationException

Specified by:

get in interface Wagon

Throws:

TransferFailedException

ResourceDoesNotExistException

AuthorizationException

getFileList

public List<String> getFileList(String destinationDirectory)
                         throws TransferFailedException,
                                ResourceDoesNotExistException,
                                AuthorizationException

Specified by:

getFileList in interface Wagon

Overrides:

getFileList in class AbstractWagon

Throws:

TransferFailedException

ResourceDoesNotExistException

AuthorizationException

putDirectory

public void putDirectory(File sourceDirectory,
                         String destinationDirectory)
                  throws TransferFailedException,
                         ResourceDoesNotExistException,
                         AuthorizationException

Specified by:

putDirectory in interface Wagon

Overrides:

putDirectory in class AbstractWagon

Throws:

TransferFailedException

ResourceDoesNotExistException

AuthorizationException

resourceExists

public boolean resourceExists(String resourceName)
                       throws TransferFailedException,
                              AuthorizationException

Specified by:

resourceExists in interface Wagon

Overrides:

resourceExists in class AbstractWagon

Throws:

TransferFailedException

AuthorizationException

supportsDirectoryCopy

public boolean supportsDirectoryCopy()

Specified by:

supportsDirectoryCopy in interface Wagon

Overrides:

supportsDirectoryCopy in class AbstractWagon

getScpExecutable

public String getScpExecutable()

setScpExecutable

public void setScpExecutable(String scpExecutable)

getSshExecutable

public String getSshExecutable()

setSshExecutable

public void setSshExecutable(String sshExecutable)

getScpArgs

public String getScpArgs()

setScpArgs

public void setScpArgs(String scpArgs)

getSshArgs

public String getSshArgs()

setSshArgs

public void setSshArgs(String sshArgs)