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

Class AbstractExternalWagon

java.lang.Object

org.apache.maven.wagon.AbstractWagon

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

All Implemented Interfaces:

ExternalWagon, WagonHasAuthenticationInfo, Wagon

Direct Known Subclasses:

AbstractSshWagon, RsyncExternalWagon

public abstract class AbstractExternalWagon
extends AbstractWagon
implements ExternalWagon

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
AbstractExternalWagon()

Method Summary

Modifier and Type	Method	Description
protected void	closeConnection()
protected abstract Commandline	createBaseCommandLine(File privateKey, String... options)
void	executeCopyCommand(Resource resource, File localFile, boolean put, String... options)
void	executeCopyCommand(Resource resource, String remoteFile, File localFile, boolean put, String... options)
void	fireSessionDebug(String message)
void	fireTransferDebug(String message)
void	get(String resourceName, File destination)
boolean	getIfNewer(String resourceName, File destination, long timestamp)
protected void	openConnectionInternal()
void	put(File source, String destination)
protected abstract void	putMkdirRemote(String destination)
protected abstract void	putSetPermissionRemote(Resource resource, String destination)
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, fireSessionDisconnected, fireSessionDisconnecting, fireSessionError, fireSessionLoggedIn, fireSessionLoggedOff, fireSessionOpened, fireSessionOpening, fireTransferError, fireTransferProgress, getAuthenticationInfo, getBufferCapacityForTransfer, getFileList, getPath, getPermissionsOverride, getProxyInfo, getProxyInfo, getReadTimeout, getRepository, getSessionEventSupport, getTimeout, getTransfer, getTransfer, getTransfer, getTransfer, getTransfer, getTransfer, getTransferEventSupport, hasSessionListener, hasTransferListener, isInteractive, openConnection, postProcessListeners, putDirectory, putTransfer, putTransfer, removeSessionListener, removeTransferListener, resourceExists, 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.providers.rsync.external.ExternalWagon

getExecutable

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

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

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

buildRemoteHost, getAuthenticationInfo

Constructor Detail

AbstractExternalWagon

public AbstractExternalWagon()

Method Detail

closeConnection

protected void closeConnection()
                        throws ConnectionException

Specified by:

closeConnection in class AbstractWagon

Throws:

ConnectionException

createBaseCommandLine

protected abstract Commandline createBaseCommandLine(File privateKey,
                                                     String... options)

executeCopyCommand

public void executeCopyCommand(Resource resource,
                               File localFile,
                               boolean put,
                               String... options)
                        throws TransferFailedException,
                               ResourceDoesNotExistException,
                               AuthorizationException

Specified by:

executeCopyCommand in interface ExternalWagon

Throws:

TransferFailedException

ResourceDoesNotExistException

AuthorizationException

executeCopyCommand

public void executeCopyCommand(Resource resource,
                               String remoteFile,
                               File localFile,
                               boolean put,
                               String... options)
                        throws TransferFailedException,
                               ResourceDoesNotExistException,
                               AuthorizationException

Specified by:

executeCopyCommand in interface ExternalWagon

Throws:

TransferFailedException

ResourceDoesNotExistException

AuthorizationException

fireTransferDebug

public void fireTransferDebug(String message)

Overrides:

fireTransferDebug in class AbstractWagon

fireSessionDebug

public void fireSessionDebug(String message)

Overrides:

fireSessionDebug in class AbstractWagon

get

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

Specified by:

get in interface Wagon

Throws:

TransferFailedException

ResourceDoesNotExistException

AuthorizationException

getIfNewer

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

Specified by:

getIfNewer in interface Wagon

Throws:

TransferFailedException

ResourceDoesNotExistException

AuthorizationException

openConnectionInternal

protected void openConnectionInternal()
                               throws ConnectionException,
                                      AuthenticationException

Specified by:

openConnectionInternal in class AbstractWagon

Throws:

ConnectionException

AuthenticationException

put

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

Specified by:

put in interface Wagon

Throws:

TransferFailedException

ResourceDoesNotExistException

AuthorizationException

supportsDirectoryCopy

public boolean supportsDirectoryCopy()

Specified by:

supportsDirectoryCopy in interface ExternalWagon

Specified by:

supportsDirectoryCopy in interface Wagon

Overrides:

supportsDirectoryCopy in class AbstractWagon

putMkdirRemote

protected abstract void putMkdirRemote(String destination)
                                throws AuthorizationException,
                                       ResourceDoesNotExistException,
                                       TransferFailedException

Throws:

AuthorizationException

ResourceDoesNotExistException

TransferFailedException

putSetPermissionRemote

protected abstract void putSetPermissionRemote(Resource resource,
                                               String destination)
                                        throws TransferFailedException

Throws:

TransferFailedException