Package org.apache.maven.wagon.providers.ssh.jsch

Class 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 AbstractJschWagon
    SFTP protocol wagon.
    Author:
    Brett Porter

    • 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.CommandExecutor

        ROLE

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

        DEFAULT_CONNECTION_TIMEOUT, DEFAULT_READ_TIMEOUT, ROLE

    • Constructor Summary

      Constructors 
      Constructor Description
      SftpWagon()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method 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<java.lang.String> getFileList​(java.lang.String destinationDirectory)  
      int getOctalMode​(java.lang.String mode)  
      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.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, getBufferCapacityForTransfer, 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

      • 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

      • openConnectionInternal

        public void openConnectionInternal()
                            throws org.apache.maven.wagon.authentication.AuthenticationException
        Overrides:
        openConnectionInternal in class AbstractJschWagon
        Throws:
        org.apache.maven.wagon.authentication.AuthenticationException

      • 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 AbstractJschWagon
        Throws:
        org.apache.maven.wagon.TransferFailedException
        org.apache.maven.wagon.ResourceDoesNotExistException
        org.apache.maven.wagon.authorization.AuthorizationException

      • getFileList

        public java.util.List<java.lang.String> 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 AbstractJschWagon
        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 AbstractJschWagon
        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)