Package 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.

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.String	scpArgs	Arguments to pass to the SCP command.
private java.lang.String	scpExecutable	The external SCP command to use - default is scp.
private static int	SSH_FATAL_EXIT_CODE
private java.lang.String	sshArgs	Arguments to pass to the SSH command.
private java.lang.String	sshExecutable	The external SSH command to use - default is ssh.
private ScpHelper	sshTool

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, ROLE

Constructor Summary

Constructors

Constructor	Description
ScpExternalWagon()

Method Summary

Modifier and Type	Method	Description
private java.lang.String	buildRemoteHost()
void	closeConnection()
private org.codehaus.plexus.util.cli.Commandline	createBaseCommandLine(boolean putty, java.lang.String executable, java.io.File privateKey)
void	executeCommand(java.lang.String command)
Streams	executeCommand(java.lang.String command, boolean ignoreFailures)
private void	executeScpCommand(Resource resource, java.io.File localFile, boolean put)
void	get(java.lang.String resourceName, java.io.File destination)	Downloads specified resource from the repository to given file.
java.util.List<java.lang.String>	getFileList(java.lang.String destinationDirectory)	Returns a List of strings naming the files and directories in the directory denoted by this abstract pathname.
boolean	getIfNewer(java.lang.String resourceName, java.io.File destination, long timestamp)	Downloads specified resource from the repository if it was modified since specified date.
java.lang.String	getScpArgs()
java.lang.String	getScpExecutable()
java.lang.String	getSshArgs()
java.lang.String	getSshExecutable()
protected boolean	isPuTTY()
(package private) boolean	isPuTTYSCP()
private java.lang.String	normalizeResource(Resource resource)
protected void	openConnectionInternal()
void	put(java.io.File source, java.lang.String destination)	Copy a file from local system to remote
void	putDirectory(java.io.File sourceDirectory, java.lang.String destinationDirectory)	Copy a directory from local system to remote
boolean	resourceExists(java.lang.String resourceName)	Check if a remote resource exists
void	setScpArgs(java.lang.String scpArgs)
void	setScpExecutable(java.lang.String scpExecutable)
void	setSshArgs(java.lang.String sshArgs)
void	setSshExecutable(java.lang.String sshExecutable)
boolean	supportsDirectoryCopy()	Flag indicating if this wagon supports directory copy operations.

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

Field Detail

scpExecutable

private java.lang.String scpExecutable

The external SCP command to use - default is scp.

sshExecutable

private java.lang.String sshExecutable

The external SSH command to use - default is ssh.

scpArgs

private java.lang.String scpArgs

Arguments to pass to the SCP command.

sshArgs

private java.lang.String sshArgs

Arguments to pass to the SSH command.

sshTool

private ScpHelper sshTool

SSH_FATAL_EXIT_CODE

private static final int SSH_FATAL_EXIT_CODE

See Also:

Constant Field Values

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(java.lang.String resourceName,
                          java.io.File destination,
                          long timestamp)
                   throws TransferFailedException,
                          ResourceDoesNotExistException,
                          AuthorizationException

Description copied from interface: Wagon

Downloads specified resource from the repository if it was modified since specified date. The date is measured in milliseconds, between the current time and midnight, January 1, 1970 UTC and aligned to GMT timezone.

Specified by:

getIfNewer in interface Wagon

Returns:

true if newer resource has been downloaded, false if resource in the repository is older or has the same age.

Throws:

TransferFailedException

ResourceDoesNotExistException

AuthorizationException

buildRemoteHost

private java.lang.String buildRemoteHost()

Returns:

The hostname of the remote server prefixed with the username, which comes either from the repository URL or from the authenticationInfo.

executeCommand

public void executeCommand(java.lang.String command)
                    throws CommandExecutionException

Specified by:

executeCommand in interface CommandExecutor

Throws:

CommandExecutionException

executeCommand

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

Specified by:

executeCommand in interface CommandExecutor

Throws:

CommandExecutionException

isPuTTY

protected boolean isPuTTY()

createBaseCommandLine

private org.codehaus.plexus.util.cli.Commandline createBaseCommandLine(boolean putty,
                                                                       java.lang.String executable,
                                                                       java.io.File privateKey)

executeScpCommand

private void executeScpCommand(Resource resource,
                               java.io.File localFile,
                               boolean put)
                        throws TransferFailedException,
                               ResourceDoesNotExistException,
                               AuthorizationException

Throws:

TransferFailedException

ResourceDoesNotExistException

AuthorizationException

isPuTTYSCP

boolean isPuTTYSCP()

normalizeResource

private java.lang.String normalizeResource(Resource resource)

put

public void put(java.io.File source,
                java.lang.String destination)
         throws TransferFailedException,
                ResourceDoesNotExistException,
                AuthorizationException

Description copied from interface: Wagon

Copy a file from local system to remote

Specified by:

put in interface Wagon

Parameters:

source - the local file

destination - the remote destination

Throws:

TransferFailedException

ResourceDoesNotExistException

AuthorizationException

get

public void get(java.lang.String resourceName,
                java.io.File destination)
         throws TransferFailedException,
                ResourceDoesNotExistException,
                AuthorizationException

Description copied from interface: Wagon

Downloads specified resource from the repository to given file.

Specified by:

get in interface Wagon

Throws:

TransferFailedException

ResourceDoesNotExistException

AuthorizationException

getFileList

public java.util.List<java.lang.String> getFileList(java.lang.String destinationDirectory)
                                             throws TransferFailedException,
                                                    ResourceDoesNotExistException,
                                                    AuthorizationException

Description copied from interface: Wagon

Returns a List of strings naming the files and directories in the directory denoted by this abstract pathname.

If this abstract pathname does not denote a directory, or does not exist, then this method throws ResourceDoesNotExistException. Otherwise a List of strings is returned, one for each file or directory in the directory. Names denoting the directory itself and the directory's parent directory are not included in the result. Each string is a file name rather than a complete path.

There is no guarantee that the name strings in the resulting list will appear in any specific order; they are not, in particular, guaranteed to appear in alphabetical order.

Specified by:

getFileList in interface Wagon

Overrides:

getFileList in class AbstractWagon

Parameters:

destinationDirectory - directory to list contents of

Returns:

A List of strings naming the files and directories in the directory denoted by this abstract pathname. The List will be empty if the directory is empty.

Throws:

TransferFailedException - if there's an error trying to access the remote side

ResourceDoesNotExistException - if destinationDirectory does not exist or is not a directory

AuthorizationException - if not authorized to list the contents of the directory

putDirectory

public void putDirectory(java.io.File sourceDirectory,
                         java.lang.String destinationDirectory)
                  throws TransferFailedException,
                         ResourceDoesNotExistException,
                         AuthorizationException

Description copied from interface: Wagon

Copy a directory from local system to remote

Specified by:

putDirectory in interface Wagon

Overrides:

putDirectory in class AbstractWagon

Parameters:

sourceDirectory - the local directory

destinationDirectory - the remote destination

Throws:

TransferFailedException

ResourceDoesNotExistException

AuthorizationException

resourceExists

public boolean resourceExists(java.lang.String resourceName)
                       throws TransferFailedException,
                              AuthorizationException

Description copied from interface: Wagon

Check if a remote resource exists

Specified by:

resourceExists in interface Wagon

Overrides:

resourceExists in class AbstractWagon

Returns:

whether the resource exists or not

Throws:

TransferFailedException - if there's an error trying to access the remote side

AuthorizationException - if not authorized to verify the existence of the resource

supportsDirectoryCopy

public boolean supportsDirectoryCopy()

Description copied from interface: Wagon

Flag indicating if this wagon supports directory copy operations.

Specified by:

supportsDirectoryCopy in interface Wagon

Overrides:

supportsDirectoryCopy in class AbstractWagon

Returns:

whether if this wagon supports directory operations

getScpExecutable

public java.lang.String getScpExecutable()

setScpExecutable

public void setScpExecutable(java.lang.String scpExecutable)

getSshExecutable

public java.lang.String getSshExecutable()

setSshExecutable

public void setSshExecutable(java.lang.String sshExecutable)

getScpArgs

public java.lang.String getScpArgs()

setScpArgs

public void setScpArgs(java.lang.String scpArgs)

getSshArgs

public java.lang.String getSshArgs()

setSshArgs

public void setSshArgs(java.lang.String sshArgs)