Class ScpExternalWagon

java.lang.Object
org.apache.maven.wagon.AbstractWagon
org.apache.maven.wagon.providers.ssh.external.ScpExternalWagon
All Implemented Interfaces:
org.apache.maven.wagon.CommandExecutor, org.apache.maven.wagon.Wagon
Direct Known Subclasses:
ScpExternalCommandExecutor

public class ScpExternalWagon extends org.apache.maven.wagon.AbstractWagon implements org.apache.maven.wagon.CommandExecutor
SCP deployer using "external" scp program. To allow for ssh-agent type behavior, until we can construct a Java SSH Agent and interface for JSch.
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
     
  • Method Summary

    Modifier and Type
    Method
    Description
    void
     
    void
     
    org.apache.maven.wagon.Streams
    executeCommand(String command, boolean ignoreFailures)
     
    void
    get(String resourceName, File destination)
     
    getFileList(String destinationDirectory)
     
    boolean
    getIfNewer(String resourceName, File destination, long timestamp)
     
     
     
     
     
    protected boolean
     
    protected void
     
    void
    put(File source, String destination)
     
    void
    putDirectory(File sourceDirectory, String destinationDirectory)
     
    boolean
    resourceExists(String resourceName)
     
    void
    setScpArgs(String scpArgs)
     
    void
    setScpExecutable(String scpExecutable)
     
    void
    setSshArgs(String sshArgs)
     
    void
    setSshExecutable(String sshExecutable)
     
    boolean
     

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

    • ScpExternalWagon

      public ScpExternalWagon()
  • Method Details

    • openConnectionInternal

      protected 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.AbstractWagon
    • getIfNewer

      public boolean getIfNewer(String resourceName, File destination, long timestamp) throws org.apache.maven.wagon.TransferFailedException, org.apache.maven.wagon.ResourceDoesNotExistException, org.apache.maven.wagon.authorization.AuthorizationException
      Specified by:
      getIfNewer in interface org.apache.maven.wagon.Wagon
      Throws:
      org.apache.maven.wagon.TransferFailedException
      org.apache.maven.wagon.ResourceDoesNotExistException
      org.apache.maven.wagon.authorization.AuthorizationException
    • executeCommand

      public void executeCommand(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(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
    • isPuTTY

      protected boolean isPuTTY()
    • put

      public void put(File source, String destination) throws org.apache.maven.wagon.TransferFailedException, org.apache.maven.wagon.ResourceDoesNotExistException, org.apache.maven.wagon.authorization.AuthorizationException
      Specified by:
      put in interface org.apache.maven.wagon.Wagon
      Throws:
      org.apache.maven.wagon.TransferFailedException
      org.apache.maven.wagon.ResourceDoesNotExistException
      org.apache.maven.wagon.authorization.AuthorizationException
    • get

      public void get(String resourceName, File destination) throws org.apache.maven.wagon.TransferFailedException, org.apache.maven.wagon.ResourceDoesNotExistException, org.apache.maven.wagon.authorization.AuthorizationException
      Specified by:
      get in interface org.apache.maven.wagon.Wagon
      Throws:
      org.apache.maven.wagon.TransferFailedException
      org.apache.maven.wagon.ResourceDoesNotExistException
      org.apache.maven.wagon.authorization.AuthorizationException
    • getFileList

      public List<String> getFileList(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(File sourceDirectory, 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(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
    • getScpExecutable

      public String getScpExecutable()
    • setScpExecutable

      public void setScpExecutable(String scpExecutable)
    • getSshExecutable

      public String getSshExecutable()
    • setSshExecutable

      public void setSshExecutable(String sshExecutable)
    • getScpArgs

      public String getScpArgs()
    • setScpArgs

      public void setScpArgs(String scpArgs)
    • getSshArgs

      public String getSshArgs()
    • setSshArgs

      public void setSshArgs(String sshArgs)