Package org.apache.maven.wagon.providers.rsync.external

Class RsyncExternalWagon

java.lang.Object

org.apache.maven.wagon.AbstractWagon

org.apache.maven.wagon.providers.rsync.external.AbstractExternalWagon

org.apache.maven.wagon.providers.rsync.external.RsyncExternalWagon

All Implemented Interfaces:

ExternalWagon, RsyncWagon, WagonHasAuthenticationInfo, Wagon

public class RsyncExternalWagon
extends AbstractExternalWagon
implements RsyncWagon

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

Author:

Haolun Zhang

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

DEFAULT_CONNECTION_TIMEOUT, DEFAULT_READ_TIMEOUT, ROLE

Constructor Summary

Constructors

Constructor	Description
RsyncExternalWagon()

Method Summary

Modifier and Type	Method	Description
String	buildRemoteHost()	The hostname of the remote server prefixed with the username, which comes either from the repository URL or from the authenticationInfo.
Commandline	createBaseCommandLine(File privateKey, String... options)
String	getExecutable()
List<String>	getFileList(String destinationDirectory)
boolean	isInteractive()
void	putDirectory(File sourceDirectory, String destinationDirectory)
void	putMkdirRemote(String destination)
void	putSetPermissionRemote(Resource resource, String destination)
boolean	resourceExists(String resourceName)
void	setInteractive(boolean interactive)

Methods inherited from class org.apache.maven.wagon.providers.rsync.external.AbstractExternalWagon

closeConnection, executeCopyCommand, executeCopyCommand, fireSessionDebug, fireTransferDebug, get, getIfNewer, openConnectionInternal, put, 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, fireSessionDisconnected, fireSessionDisconnecting, fireSessionError, fireSessionLoggedIn, fireSessionLoggedOff, fireSessionOpened, fireSessionOpening, fireTransferError, fireTransferProgress, getAuthenticationInfo, getBufferCapacityForTransfer, getPath, getPermissionsOverride, getProxyInfo, getProxyInfo, getReadTimeout, getRepository, getSessionEventSupport, getTimeout, getTransfer, getTransfer, getTransfer, getTransfer, getTransfer, getTransfer, getTransferEventSupport, hasSessionListener, hasTransferListener, openConnection, postProcessListeners, putTransfer, putTransfer, removeSessionListener, removeTransferListener, 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.providers.rsync.external.ExternalWagon

executeCopyCommand, executeCopyCommand, supportsDirectoryCopy

Methods inherited from interface org.apache.maven.wagon.providers.rsync.external.RsyncWagon

createBaseCommandLine, createRemoteDirectory, getRsyncArgs, getRsyncExecutable

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

addSessionListener, addTransferListener, connect, connect, connect, connect, connect, connect, disconnect, get, getIfNewer, getReadTimeout, getRepository, getTimeout, hasSessionListener, hasTransferListener, openConnection, put, removeSessionListener, removeTransferListener, setReadTimeout, setTimeout

Methods inherited from interface org.apache.maven.wagon.providers.rsync.external.WagonHasAuthenticationInfo

getAuthenticationInfo

Constructor Detail

RsyncExternalWagon

public RsyncExternalWagon()

Method Detail

buildRemoteHost

public String buildRemoteHost()

Description copied from interface: WagonHasAuthenticationInfo

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

Specified by:

buildRemoteHost in interface WagonHasAuthenticationInfo

Returns:

remote host string

createBaseCommandLine

public Commandline createBaseCommandLine(File privateKey,
                                         String... options)

Specified by:

createBaseCommandLine in class AbstractExternalWagon

getExecutable

public String getExecutable()

Specified by:

getExecutable in interface ExternalWagon

getFileList

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

Specified by:

getFileList in interface Wagon

Overrides:

getFileList in class AbstractWagon

Throws:

TransferFailedException

ResourceDoesNotExistException

isInteractive

public boolean isInteractive()

Specified by:

isInteractive in interface Wagon

Overrides:

isInteractive in class AbstractWagon

putDirectory

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

Specified by:

putDirectory in interface RsyncWagon

Specified by:

putDirectory in interface Wagon

Overrides:

putDirectory in class AbstractWagon

Throws:

TransferFailedException

ResourceDoesNotExistException

AuthorizationException

putMkdirRemote

public void putMkdirRemote(String destination)
                    throws AuthorizationException,
                           ResourceDoesNotExistException,
                           TransferFailedException

Specified by:

putMkdirRemote in interface RsyncWagon

Specified by:

putMkdirRemote in class AbstractExternalWagon

Throws:

AuthorizationException

ResourceDoesNotExistException

TransferFailedException

putSetPermissionRemote

public void putSetPermissionRemote(Resource resource,
                                   String destination)
                            throws TransferFailedException

Specified by:

putSetPermissionRemote in interface RsyncWagon

Specified by:

putSetPermissionRemote in class AbstractExternalWagon

Throws:

TransferFailedException

resourceExists

public boolean resourceExists(String resourceName)
                       throws TransferFailedException

Specified by:

resourceExists in interface Wagon

Overrides:

resourceExists in class AbstractWagon

Throws:

TransferFailedException

setInteractive

public void setInteractive(boolean interactive)

Specified by:

setInteractive in interface Wagon

Overrides:

setInteractive in class AbstractWagon