org.apache.maven.wagon.providers.ssh.sshapi

Class AbstractSSHAPIWagon

java.lang.Object

org.apache.maven.wagon.AbstractWagon

org.apache.maven.wagon.StreamWagon

org.apache.maven.wagon.providers.ssh.sshapi.AbstractSSHAPIWagon

All Implemented Interfaces:

org.apache.maven.wagon.CommandExecutor, org.apache.maven.wagon.providers.ssh.SshWagon, org.apache.maven.wagon.StreamingWagon, org.apache.maven.wagon.Wagon

Direct Known Subclasses:

ScpWagon, SftpWagon

public abstract class AbstractSSHAPIWagon
extends org.apache.maven.wagon.StreamWagon
implements org.apache.maven.wagon.providers.ssh.SshWagon, org.apache.maven.wagon.CommandExecutor

AbstractJschWagon

Version:

$Id: AbstractJschWagon.java 1170464 2011-09-14 07:56:38Z olamy $

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	EXEC_CHANNEL
protected SshClient	session
protected org.apache.maven.wagon.providers.ssh.ScpHelper	sshTool

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

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

DEFAULT_CONNECTION_TIMEOUT, DEFAULT_READ_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
AbstractSSHAPIWagon()

Method Summary

Modifier and Type	Method and Description
void	closeConnection()
void	executeCommand(java.lang.String command)
org.apache.maven.wagon.Streams	executeCommand(java.lang.String command, boolean ignoreFailures)
java.util.List	getFileList(java.lang.String destinationDirectory)
org.apache.maven.wagon.providers.ssh.interactive.InteractiveUserInfo	getInteractiveUserInfo() Get the interactive user info.
org.apache.maven.wagon.providers.ssh.knownhost.KnownHostsProvider	getKnownHostsProvider() Get the known hosts provider.
protected void	handleGetException(org.apache.maven.wagon.resource.Resource resource, java.lang.Exception e)
void	openConnectionInternal()
void	putDirectory(java.io.File sourceDirectory, java.lang.String destinationDirectory)
boolean	resourceExists(java.lang.String resourceName)
void	setInteractiveUserInfo(org.apache.maven.wagon.providers.ssh.interactive.InteractiveUserInfo interactiveUserInfo) Set the interactive user info.
void	setKnownHostsProvider(org.apache.maven.wagon.providers.ssh.knownhost.KnownHostsProvider knownHostsProvider)
boolean	supportsDirectoryCopy()

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

checkInputStream, checkOutputStream, fillInputData, fillOutputData, get, getIfNewer, getIfNewerToStream, getInputStream, getOutputStream, getToStream, put, putFromStream, putFromStream, putFromStream

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, 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, get, getIfNewer, getReadTimeout, getRepository, getTimeout, hasSessionListener, hasTransferListener, isInteractive, openConnection, put, removeSessionListener, removeTransferListener, setInteractive, setReadTimeout, setTimeout

Field Detail

sshTool

protected org.apache.maven.wagon.providers.ssh.ScpHelper sshTool

session

protected SshClient session

EXEC_CHANNEL

protected static final java.lang.String EXEC_CHANNEL

See Also:

Constant Field Values

Constructor Detail

AbstractSSHAPIWagon

public AbstractSSHAPIWagon()

Method Detail

openConnectionInternal

public void openConnectionInternal()
                            throws org.apache.maven.wagon.authentication.AuthenticationException,
                                   org.apache.maven.wagon.ConnectionException

Specified by:

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

Throws:

org.apache.maven.wagon.authentication.AuthenticationException

org.apache.maven.wagon.ConnectionException

closeConnection

public void closeConnection()

Specified by:

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

executeCommand

public org.apache.maven.wagon.Streams executeCommand(java.lang.String command,
                                                     boolean ignoreFailures)
                                              throws org.apache.maven.wagon.CommandExecutionException

Specified by:

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

Throws:

org.apache.maven.wagon.CommandExecutionException

handleGetException

protected void handleGetException(org.apache.maven.wagon.resource.Resource resource,
                                  java.lang.Exception e)
                           throws org.apache.maven.wagon.TransferFailedException

Throws:

org.apache.maven.wagon.TransferFailedException

getFileList

public java.util.List getFileList(java.lang.String destinationDirectory)
                           throws org.apache.maven.wagon.TransferFailedException,
                                  org.apache.maven.wagon.ResourceDoesNotExistException,
                                  org.apache.maven.wagon.authorization.AuthorizationException

Specified by:

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

Overrides:

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

Throws:

org.apache.maven.wagon.TransferFailedException

org.apache.maven.wagon.ResourceDoesNotExistException

org.apache.maven.wagon.authorization.AuthorizationException

putDirectory

public void putDirectory(java.io.File sourceDirectory,
                         java.lang.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

resourceExists

public boolean resourceExists(java.lang.String resourceName)
                       throws org.apache.maven.wagon.TransferFailedException,
                              org.apache.maven.wagon.authorization.AuthorizationException

Specified by:

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

Overrides:

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

Throws:

org.apache.maven.wagon.TransferFailedException

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

executeCommand

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

Specified by:

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

Throws:

org.apache.maven.wagon.CommandExecutionException

getInteractiveUserInfo

public org.apache.maven.wagon.providers.ssh.interactive.InteractiveUserInfo getInteractiveUserInfo()

Get the interactive user info.

Returns:

interactive user info

getKnownHostsProvider

public org.apache.maven.wagon.providers.ssh.knownhost.KnownHostsProvider getKnownHostsProvider()

Get the known hosts provider.

Returns:

know hosts provider

setInteractiveUserInfo

public void setInteractiveUserInfo(org.apache.maven.wagon.providers.ssh.interactive.InteractiveUserInfo interactiveUserInfo)

Set the interactive user info.

Parameters:

interactiveUserInfo -

setKnownHostsProvider

public void setKnownHostsProvider(org.apache.maven.wagon.providers.ssh.knownhost.KnownHostsProvider knownHostsProvider)

Specified by:

setKnownHostsProvider in interface org.apache.maven.wagon.providers.ssh.SshWagon