org.apache.maven.wagon.providers.ssh
Class AbstractSshWagon

java.lang.Object
  org.apache.maven.wagon.AbstractWagon
      org.apache.maven.wagon.providers.ssh.AbstractSshWagon

All Implemented Interfaces:

org.apache.maven.wagon.CommandExecutor, org.apache.maven.wagon.Wagon

Direct Known Subclasses:

ScpWagon, SftpWagon

public abstract class AbstractSshWagon
extends org.apache.maven.wagon.AbstractWagon
implements org.apache.maven.wagon.CommandExecutor

Common SSH operations.

Version:

$Id: AbstractSshWagon.java 396016 2006-04-21 21:53:52Z carlos $

Author:

Brett Porter

Field Summary

static int	DEFAULT_SSH_PORT
static String	EXEC_CHANNEL
protected com.jcraft.jsch.Session	session
static int	SOCKS5_PROXY_PORT

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

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

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

ROLE

Constructor Summary

AbstractSshWagon()

Method Summary

void	closeConnection()
void	executeCommand(String command)
InteractiveUserInfo	getInteractiveUserInfo()
KnownHostsProvider	getKnownHostsProvider()
protected void	handleGetException(org.apache.maven.wagon.resource.Resource resource, Exception e, File destination)
void	openConnection()
void	putDirectory(File sourceDirectory, String destinationDirectory)
protected String	readLine(InputStream in)
protected static void	sendEom(OutputStream out)
void	setInteractiveUserInfo(InteractiveUserInfo interactiveUserInfo)
void	setKnownHostsProvider(KnownHostsProvider knownHostsProvider)
boolean	supportsDirectoryCopy()

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

addSessionListener, addTransferListener, 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, getPath, getProxyInfo, getRepository, getSessionEventSupport, getTransfer, getTransfer, getTransferEventSupport, hasSessionListener, hasTransferListener, isInteractive, postProcessListeners, putTransfer, removeSessionListener, removeTransferListener, setInteractive, setSessionEventSupport, setTransferEventSupport, 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, disconnect, get, getIfNewer, getRepository, hasSessionListener, hasTransferListener, isInteractive, put, removeSessionListener, removeTransferListener, setInteractive

Field Detail

DEFAULT_SSH_PORT

public static final int DEFAULT_SSH_PORT

See Also:

Constant Field Values

SOCKS5_PROXY_PORT

public static final int SOCKS5_PROXY_PORT

See Also:

Constant Field Values

session

protected com.jcraft.jsch.Session session

EXEC_CHANNEL

public static final String EXEC_CHANNEL

See Also:

Constant Field Values

Constructor Detail

AbstractSshWagon

public AbstractSshWagon()

Method Detail

openConnection

public void openConnection()
                    throws org.apache.maven.wagon.authentication.AuthenticationException

Specified by:

openConnection in interface org.apache.maven.wagon.Wagon

Throws:

org.apache.maven.wagon.authentication.AuthenticationException

executeCommand

public void executeCommand(String command)
                    throws org.apache.maven.wagon.CommandExecutionException

Specified by:

executeCommand in interface org.apache.maven.wagon.CommandExecutor

Throws:

org.apache.maven.wagon.CommandExecutionException

readLine

protected String readLine(InputStream in)
                   throws IOException

Throws:

IOException

sendEom

protected static void sendEom(OutputStream out)
                       throws IOException

Throws:

IOException

closeConnection

public void closeConnection()

Specified by:

closeConnection in class org.apache.maven.wagon.AbstractWagon

handleGetException

protected void handleGetException(org.apache.maven.wagon.resource.Resource resource,
                                  Exception e,
                                  File destination)
                           throws org.apache.maven.wagon.TransferFailedException,
                                  org.apache.maven.wagon.ResourceDoesNotExistException

Throws:

org.apache.maven.wagon.TransferFailedException

org.apache.maven.wagon.ResourceDoesNotExistException

getKnownHostsProvider

public final KnownHostsProvider getKnownHostsProvider()

setKnownHostsProvider

public final void setKnownHostsProvider(KnownHostsProvider knownHostsProvider)

getInteractiveUserInfo

public InteractiveUserInfo getInteractiveUserInfo()

setInteractiveUserInfo

public void setInteractiveUserInfo(InteractiveUserInfo interactiveUserInfo)

putDirectory

public void putDirectory(File sourceDirectory,
                         String destinationDirectory)
                  throws org.apache.maven.wagon.TransferFailedException,
                         org.apache.maven.wagon.ResourceDoesNotExistException,
                         org.apache.maven.wagon.authorization.AuthorizationException

Specified by:

putDirectory in interface org.apache.maven.wagon.Wagon

Overrides:

putDirectory in class org.apache.maven.wagon.AbstractWagon

Throws:

org.apache.maven.wagon.TransferFailedException

org.apache.maven.wagon.ResourceDoesNotExistException

org.apache.maven.wagon.authorization.AuthorizationException

supportsDirectoryCopy

public boolean supportsDirectoryCopy()

Specified by:

supportsDirectoryCopy in interface org.apache.maven.wagon.Wagon

Overrides:

supportsDirectoryCopy in class org.apache.maven.wagon.AbstractWagon