org.apache.maven.wagon.providers.ssh

Class AbstractSshWagon

Implemented Interfaces:
CommandExecutor, SshWagon, Wagon
Known Direct Subclasses:
AbstractGanymedWagon, AbstractJschWagon, ScpExternalWagon

public abstract class AbstractSshWagon
extends AbstractWagon
implements CommandExecutor, SshWagon

Common SSH operations.
Version:
$Id: AbstractSshWagon.java 485738 2006-12-11 16:22:26Z joakime $
Author:
Brett Porter

Field Summary

protected static int
DEFAULT_SSH_PORT
protected static char
PATH_SEPARATOR
protected InteractiveUserInfo
interactiveUserInfo
protected KnownHostsProvider
knownHostsProvider

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

DEFAULT_BUFFER_SIZE, authenticationInfo, interactive, proxyInfo, repository, sessionEventSupport, transferEventSupport

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

ROLE

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

ROLE

Method Summary

void
executeCommand(String command)
protected int
getDirectoryMode(RepositoryPermissions permissions)
List
getFileList(String destinationDirectory)
boolean
getIfNewer(String resourceName, File destination, long timestamp)
InteractiveUserInfo
getInteractiveUserInfo()
KnownHostsProvider
getKnownHostsProvider()
protected int
getOctalMode(String mode)
protected String
getOctalMode(RepositoryPermissions permissions)
protected int
getPort()
protected File
getPrivateKey()
protected static Resource
getResource(String resourceName)
protected static String
getResourceDirectory(String resourceName)
protected static String
getResourceFilename(String r)
protected void
handleGetException(Resource resource, Exception e, File destination)
void
openConnection()
void
putDirectory(File sourceDirectory, String destinationDirectory)
boolean
resourceExists(String resourceName)
void
setInteractiveUserInfo(InteractiveUserInfo interactiveUserInfo)
void
setKnownHostsProvider(KnownHostsProvider knownHostsProvider)
boolean
supportsDirectoryCopy()

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

addSessionListener, addTransferListener, closeConnection, connect, connect, connect, connect, createParentDirectories, createZip, disconnect, fireGetCompleted, fireGetInitiated, fireGetStarted, firePutCompleted, firePutInitiated, firePutStarted, fireSessionConnectionRefused, fireSessionDebug, fireSessionDisconnected, fireSessionDisconnecting, fireSessionError, fireSessionLoggedIn, fireSessionLoggedOff, fireSessionOpened, fireSessionOpening, fireTransferDebug, fireTransferError, fireTransferProgress, getAuthenticationInfo, getFileList, getPath, getProxyInfo, getRepository, getSessionEventSupport, getTransfer, getTransfer, getTransferEventSupport, hasSessionListener, hasTransferListener, isInteractive, postProcessListeners, putDirectory, putTransfer, removeSessionListener, removeTransferListener, resourceExists, setInteractive, setSessionEventSupport, setTransferEventSupport, supportsDirectoryCopy, transfer, transfer, transfer

Field Details

DEFAULT_SSH_PORT

protected static final int DEFAULT_SSH_PORT
Field Value:
22

PATH_SEPARATOR

protected static final char PATH_SEPARATOR
Field Value:
'/'

interactiveUserInfo

protected InteractiveUserInfo interactiveUserInfo

knownHostsProvider

protected KnownHostsProvider knownHostsProvider

Method Details

executeCommand

public void executeCommand(String command)
            throws CommandExecutionException
Specified by:
executeCommand in interface CommandExecutor

getDirectoryMode

protected int getDirectoryMode(RepositoryPermissions permissions)
Parameters:
permissions - repository's permissions
Returns:
the directory mode for the repository or -1 if it wasn't set

getFileList

public List getFileList(String destinationDirectory)
            throws TransferFailedException,
                   ResourceDoesNotExistException,
                   AuthorizationException
Specified by:
getFileList in interface Wagon
Overrides:
getFileList in interface AbstractWagon

getIfNewer

public boolean getIfNewer(String resourceName,
                          File destination,
                          long timestamp)
            throws TransferFailedException,
                   ResourceDoesNotExistException,
                   AuthorizationException
Specified by:
getIfNewer in interface Wagon

getInteractiveUserInfo

public InteractiveUserInfo getInteractiveUserInfo()

getKnownHostsProvider

public final KnownHostsProvider getKnownHostsProvider()

getOctalMode

protected int getOctalMode(String mode)

getOctalMode

protected String getOctalMode(RepositoryPermissions permissions)

getPort

protected int getPort()

getPrivateKey

protected File getPrivateKey()

getResource

protected static Resource getResource(String resourceName)

getResourceDirectory

protected static String getResourceDirectory(String resourceName)

getResourceFilename

protected static String getResourceFilename(String r)

handleGetException

protected void handleGetException(Resource resource,
                                  Exception e,
                                  File destination)
            throws TransferFailedException,
                   ResourceDoesNotExistException

openConnection

public void openConnection()
            throws AuthenticationException
Specified by:
openConnection in interface Wagon

putDirectory

public void putDirectory(File sourceDirectory,
                         String destinationDirectory)
            throws TransferFailedException,
                   ResourceDoesNotExistException,
                   AuthorizationException
Specified by:
putDirectory in interface Wagon
Overrides:
putDirectory in interface AbstractWagon

resourceExists

public boolean resourceExists(String resourceName)
            throws TransferFailedException,
                   AuthorizationException
Specified by:
resourceExists in interface Wagon
Overrides:
resourceExists in interface AbstractWagon

setInteractiveUserInfo

public void setInteractiveUserInfo(InteractiveUserInfo interactiveUserInfo)

setKnownHostsProvider

public final void setKnownHostsProvider(KnownHostsProvider knownHostsProvider)
Specified by:
setKnownHostsProvider in interface SshWagon

supportsDirectoryCopy

public boolean supportsDirectoryCopy()
Specified by:
supportsDirectoryCopy in interface Wagon
Overrides:
supportsDirectoryCopy in interface AbstractWagon