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

Class AbstractJschWagon

  • 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 AbstractJschWagon
extends org.apache.maven.wagon.StreamWagon
implements org.apache.maven.wagon.providers.ssh.SshWagon, org.apache.maven.wagon.CommandExecutor
    AbstractJschWagon

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected static java.lang.String EXEC_CHANNEL  
      protected com.jcraft.jsch.Session session  
      protected org.apache.maven.wagon.providers.ssh.ScpHelper sshTool  

      • 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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void closeConnection()  
      void executeCommand​(java.lang.String command)  
      org.apache.maven.wagon.Streams executeCommand​(java.lang.String command, boolean ignoreFailures)  
      org.apache.maven.wagon.Streams executeCommand​(java.lang.String command, boolean ignoreStdErr, boolean ignoreNoneZeroExitCode)  
      java.util.List<java.lang.String> getFileList​(java.lang.String destinationDirectory)  
      org.apache.maven.wagon.providers.ssh.interactive.InteractiveUserInfo getInteractiveUserInfo()  
      org.apache.maven.wagon.providers.ssh.knownhost.KnownHostsProvider getKnownHostsProvider()  
      java.lang.String getPreferredAuthentications()  
      java.lang.String getStrictHostKeyChecking()  
      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)  
      void setKnownHostsProvider​(org.apache.maven.wagon.providers.ssh.knownhost.KnownHostsProvider knownHostsProvider)  
      void setPreferredAuthentications​(java.lang.String preferredAuthentications)  
      void setStrictHostKeyChecking​(java.lang.String strictHostKeyChecking)  
      void setUIKeyboardInteractive​(com.jcraft.jsch.UIKeyboardInteractive uIKeyboardInteractive)  
      boolean supportsDirectoryCopy()  
      protected void transfer​(org.apache.maven.wagon.resource.Resource resource, java.io.InputStream input, java.io.OutputStream output, int requestType, long maxSize)

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

    • Field Detail

      • sshTool

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

      • session

        protected com.jcraft.jsch.Session session

    • Constructor Detail

      • AbstractJschWagon

        public AbstractJschWagon()

    • Method Detail

      • openConnectionInternal

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

      • 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 ignoreStdErr,
                                                     boolean ignoreNoneZeroExitCode)
                                              throws org.apache.maven.wagon.CommandExecutionException
        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<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

      • 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

      • 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

      • getInteractiveUserInfo

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

      • getKnownHostsProvider

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

      • setInteractiveUserInfo

        public void setInteractiveUserInfo​(org.apache.maven.wagon.providers.ssh.interactive.InteractiveUserInfo 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

      • setUIKeyboardInteractive

        public void setUIKeyboardInteractive​(com.jcraft.jsch.UIKeyboardInteractive uIKeyboardInteractive)

      • getPreferredAuthentications

        public java.lang.String getPreferredAuthentications()

      • setPreferredAuthentications

        public void setPreferredAuthentications​(java.lang.String preferredAuthentications)

      • getStrictHostKeyChecking

        public java.lang.String getStrictHostKeyChecking()

      • setStrictHostKeyChecking

        public void setStrictHostKeyChecking​(java.lang.String strictHostKeyChecking)

      • transfer

        protected void transfer​(org.apache.maven.wagon.resource.Resource resource,
                        java.io.InputStream input,
                        java.io.OutputStream output,
                        int requestType,
                        long maxSize)
                 throws java.io.IOException
        Overrides:
        transfer in class org.apache.maven.wagon.AbstractWagon
        Throws:
        java.io.IOException