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

Class SftpWagon

java.lang.Object

org.apache.maven.wagon.AbstractWagon

org.apache.maven.wagon.StreamWagon

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

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

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

public class SftpWagon
extends AbstractSSHAPIWagon

SFTP protocol wagon via SSHAPI. Based on the JSch SFTP Wagon.

Version:

$Id: SftpWagon.java 1172843 2011-09-19 21:28:04Z hboutemy $

Author:

Brett Porter

Field Summary

Fields inherited from class org.apache.maven.wagon.providers.ssh.sshapi.AbstractSSHAPIWagon

EXEC_CHANNEL, session, 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
SftpWagon()

Method Summary

Modifier and Type	Method and Description
protected void	cleanupGetTransfer(org.apache.maven.wagon.resource.Resource resource)
protected void	cleanupPutTransfer(org.apache.maven.wagon.resource.Resource resource)
void	closeConnection()
void	fillInputData(org.apache.maven.wagon.InputData inputData)
void	fillOutputData(org.apache.maven.wagon.OutputData outputData)
protected void	finishPutTransfer(org.apache.maven.wagon.resource.Resource resource, java.io.InputStream input, java.io.OutputStream output)
int	getDirectoryMode(org.apache.maven.wagon.repository.RepositoryPermissions permissions)
java.util.List	getFileList(java.lang.String destinationDirectory)
int	getOctalMode(java.lang.String mode) Get the integer permission value given an octal mode string.
void	openConnectionInternal()
void	putDirectory(java.io.File sourceDirectory, java.lang.String destinationDirectory)
boolean	resourceExists(java.lang.String resourceName)

Methods inherited from class org.apache.maven.wagon.providers.ssh.sshapi.AbstractSSHAPIWagon

executeCommand, executeCommand, getInteractiveUserInfo, getKnownHostsProvider, handleGetException, setInteractiveUserInfo, setKnownHostsProvider, supportsDirectoryCopy

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

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

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

addSessionListener, addTransferListener, connect, connect, connect, connect, connect, connect, createParentDirectories, disconnect, finishGetTransfer, 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

Constructor Detail

SftpWagon

public SftpWagon()

Method Detail

closeConnection

public void closeConnection()

Overrides:

closeConnection in class AbstractSSHAPIWagon

openConnectionInternal

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

Overrides:

openConnectionInternal in class AbstractSSHAPIWagon

Throws:

org.apache.maven.wagon.authentication.AuthenticationException

org.apache.maven.wagon.ConnectionException

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 AbstractSSHAPIWagon

Throws:

org.apache.maven.wagon.TransferFailedException

org.apache.maven.wagon.ResourceDoesNotExistException

org.apache.maven.wagon.authorization.AuthorizationException

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 AbstractSSHAPIWagon

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 AbstractSSHAPIWagon

Throws:

org.apache.maven.wagon.TransferFailedException

org.apache.maven.wagon.authorization.AuthorizationException

cleanupGetTransfer

protected void cleanupGetTransfer(org.apache.maven.wagon.resource.Resource resource)

Overrides:

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

cleanupPutTransfer

protected void cleanupPutTransfer(org.apache.maven.wagon.resource.Resource resource)

Overrides:

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

finishPutTransfer

protected void finishPutTransfer(org.apache.maven.wagon.resource.Resource resource,
                                 java.io.InputStream input,
                                 java.io.OutputStream output)
                          throws org.apache.maven.wagon.TransferFailedException

Overrides:

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

Throws:

org.apache.maven.wagon.TransferFailedException

fillInputData

public void fillInputData(org.apache.maven.wagon.InputData inputData)
                   throws org.apache.maven.wagon.TransferFailedException,
                          org.apache.maven.wagon.ResourceDoesNotExistException

Specified by:

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

Throws:

org.apache.maven.wagon.TransferFailedException

org.apache.maven.wagon.ResourceDoesNotExistException

fillOutputData

public void fillOutputData(org.apache.maven.wagon.OutputData outputData)
                    throws org.apache.maven.wagon.TransferFailedException

Specified by:

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

Throws:

org.apache.maven.wagon.TransferFailedException

getDirectoryMode

public int getDirectoryMode(org.apache.maven.wagon.repository.RepositoryPermissions permissions)

Parameters:

permissions - repository's permissions

Returns:

the directory mode for the repository or -1 if it wasn't set

getOctalMode

public int getOctalMode(java.lang.String mode)

Get the integer permission value given an octal mode string.

Parameters:

mode - mode string

Returns:

integer permission value