Package org.apache.ivy.plugins.repository.vsftp

Class VsftpRepository

java.lang.Object
org.apache.ivy.plugins.repository.AbstractRepository
org.apache.ivy.plugins.repository.vsftp.VsftpRepository
All Implemented Interfaces:
Repository
public class VsftpRepository extends AbstractRepository
Repository using SecureCRT vsftp command line program to access an sftp repository This is especially useful to leverage the gssapi authentication supported by SecureCRT. In cases where usual sftp is enough, prefer the 100% java solution of sftp repository. This requires SecureCRT to be in the PATH. Tested with SecureCRT 5.0.5

  • Constructor Details

    • VsftpRepository

      public VsftpRepository()

    • VsftpRepository

      public VsftpRepository(TimeoutConstraint timeoutConstraint)

  • Method Details

    • getResource

      public Resource getResource(String source) throws IOException
      Description copied from interface: Repository
      Return the resource associated with a specified identifier. If the resource does not exist, it should return a Resource with exists() returning false. An IOException should only be thrown when a real IO problem occurs, like the impossibility to connect to a server.
      Parameters:
      source - A string identifying the resource.
      Returns:
      The resource associated with the resource identifier.
      Throws:
      IOException - On error while trying to get resource.

    • getInitResource

      protected Resource getInitResource(String source) throws IOException
      Throws:
      IOException

    • get

      public void get(String source, File destination) throws IOException
      Description copied from interface: Repository
      Fetch a resource from the repository.
      Parameters:
      source - A string identifying the resource to be fetched.
      destination - Where to place the fetched resource.
      Throws:
      IOException - On retrieval failure.

    • list

      public List<String> list(String parent) throws IOException
      Description copied from interface: Repository
      Return a listing of resources names
      Parameters:
      parent - The parent directory from which to generate the listing.
      Returns:
      A listing of the parent directory's file content
      Throws:
      IOException - On listing failure.

    • put

      public void put(File source, String destination, boolean overwrite) throws IOException
      Overrides:
      put in class AbstractRepository
      Throws:
      IOException

    • sendCommand

      protected String sendCommand(String command) throws IOException
      Throws:
      IOException

    • sendCommand

      protected void sendCommand(String command, Pattern expectedResponse) throws IOException
      Throws:
      IOException

    • sendCommand

      protected void sendCommand(String command, Pattern expectedResponse, long timeout) throws IOException
      The behaviour of vsftp with some commands is to log the resulting message on the error stream, even if everything is ok. So it's quite difficult if there was an error or not. Hence we compare the response with the expected message and deal with it. The problem is that this is very specific to the version of vsftp used for the test, That's why expected messages are obtained using overriddable protected methods.
      Parameters:
      command - String
      expectedResponse - Pattern
      timeout - long
      Throws:
      IOException - if something goes wrong

    • sendCommand

      protected String sendCommand(String command, boolean sendErrorAsResponse) throws IOException
      Throws:
      IOException

    • sendCommand

      protected String sendCommand(String command, boolean sendErrorAsResponse, boolean single) throws IOException
      Throws:
      IOException

    • sendCommand

      protected String sendCommand(String command, boolean sendErrorAsResponse, long timeout) throws IOException
      Throws:
      IOException

    • sendCommand

      protected String sendCommand(String command, boolean sendErrorAsResponse, boolean single, long timeout) throws IOException
      Throws:
      IOException

    • readResponse

      protected String readResponse(boolean sendErrorAsResponse) throws IOException
      Throws:
      IOException

    • readResponse

      protected String readResponse(boolean sendErrorAsResponse, long timeout) throws IOException
      Throws:
      IOException

    • ensureConnectionOpened

      protected void ensureConnectionOpened() throws IOException
      Throws:
      IOException

    • disconnect

      public void disconnect()

    • lslToResource

      protected Resource lslToResource(String file, String responseLine)
      Parses a ls -l line and transforms it in a resource
      Parameters:
      file - ditto
      responseLine - ditto
      Returns:
      Resource

    • getSingleCommand

      protected String getSingleCommand(String command)

    • getConnectionCommand

      protected String getConnectionCommand()

    • getExpectedDownloadMessage

      protected Pattern getExpectedDownloadMessage(String source, File to)

    • getExpectedRemoveMessage

      protected Pattern getExpectedRemoveMessage(String destination)

    • getExpectedUploadMessage

      protected Pattern getExpectedUploadMessage(File source, String to)

    • getAuthentication

      public String getAuthentication()

    • setAuthentication

      public void setAuthentication(String authentication)

    • getHost

      public String getHost()

    • setHost

      public void setHost(String host)

    • getUsername

      public String getUsername()

    • setUsername

      public void setUsername(String username)

    • toString

      public String toString()
      Overrides:
      toString in class AbstractRepository

    • setReuseConnection

      public void setReuseConnection(long time)
      Sets the reuse connection time. The same connection will be reused if the time here does not last between two commands. O indicates that the connection should never be reused
      Parameters:
      time - long

    • getReadTimeout

      public long getReadTimeout()

    • setReadTimeout

      public void setReadTimeout(long readTimeout)