Package org.apache.maven.wagon.providers.ftp

Class FtpWagon

  • All Implemented Interfaces:
    org.apache.maven.wagon.StreamingWagon, org.apache.maven.wagon.Wagon
    Direct Known Subclasses:
    FtpHttpWagon, FtpsWagon
    public class FtpWagon
extends org.apache.maven.wagon.StreamWagon
    FtpWagon

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

        DEFAULT_CONNECTION_TIMEOUT, DEFAULT_READ_TIMEOUT, ROLE

    • Constructor Summary

      Constructors 
      Constructor Description
      FtpWagon()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void closeConnection()  
      protected org.apache.commons.net.ftp.FTPClient createClient()  
      void fillInputData​(org.apache.maven.wagon.InputData inputData)  
      void fillOutputData​(org.apache.maven.wagon.OutputData outputData)  
      protected void fireGetCompleted​(org.apache.maven.wagon.resource.Resource resource, java.io.File localFile)  
      protected void firePutCompleted​(org.apache.maven.wagon.resource.Resource resource, java.io.File file)  
      protected void fireSessionDebug​(java.lang.String msg)  
      java.lang.String getControlEncoding()  
      java.util.List<java.lang.String> getFileList​(java.lang.String destinationDirectory)  
      boolean isPassiveMode()  
      protected void openConnectionInternal()  
      void putDirectory​(java.io.File sourceDirectory, java.lang.String destinationDirectory)  
      boolean resourceExists​(java.lang.String resourceName)  
      void setControlEncoding​(java.lang.String controlEncoding)  
      void setPassiveMode​(boolean passiveMode)  
      boolean 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, cleanupGetTransfer, cleanupPutTransfer, connect, connect, connect, connect, connect, connect, createParentDirectories, disconnect, finishGetTransfer, finishPutTransfer, fireGetInitiated, fireGetStarted, firePutInitiated, firePutStarted, fireSessionConnectionRefused, 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, 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, getReadTimeout, getRepository, getTimeout, hasSessionListener, hasTransferListener, isInteractive, openConnection, removeSessionListener, removeTransferListener, setInteractive, setReadTimeout, setTimeout

    • Constructor Detail

      • FtpWagon

        public FtpWagon()

    • Method Detail

      • isPassiveMode

        public boolean isPassiveMode()

      • setPassiveMode

        public void setPassiveMode​(boolean passiveMode)

      • openConnectionInternal

        protected void openConnectionInternal()
                               throws org.apache.maven.wagon.ConnectionException,
                                      org.apache.maven.wagon.authentication.AuthenticationException
        Specified by:
        openConnectionInternal in class org.apache.maven.wagon.AbstractWagon
        Throws:
        org.apache.maven.wagon.ConnectionException
        org.apache.maven.wagon.authentication.AuthenticationException

      • createClient

        protected org.apache.commons.net.ftp.FTPClient createClient()

      • firePutCompleted

        protected void firePutCompleted​(org.apache.maven.wagon.resource.Resource resource,
                                java.io.File file)
        Overrides:
        firePutCompleted in class org.apache.maven.wagon.AbstractWagon

      • fireGetCompleted

        protected void fireGetCompleted​(org.apache.maven.wagon.resource.Resource resource,
                                java.io.File localFile)
        Overrides:
        fireGetCompleted in class org.apache.maven.wagon.AbstractWagon

      • closeConnection

        public void closeConnection()
                     throws org.apache.maven.wagon.ConnectionException
        Specified by:
        closeConnection in class org.apache.maven.wagon.StreamWagon
        Throws:
        org.apache.maven.wagon.ConnectionException

      • 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

      • 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

      • fireSessionDebug

        protected void fireSessionDebug​(java.lang.String msg)
        Overrides:
        fireSessionDebug in class org.apache.maven.wagon.AbstractWagon

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

      • 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

      • getControlEncoding

        public java.lang.String getControlEncoding()

      • setControlEncoding

        public void setControlEncoding​(java.lang.String controlEncoding)