Package adams.flow.transformer

Class SFTPGet

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, TechnicalInformationHandler, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable
    public class SFTPGet
extends AbstractTransformer
implements TechnicalInformationHandler
    Downloads a remote file and forwards the local file name via secure FTP (SFTP).

    For more information see:

    (2011). JSch - JSch is a pure Java implementation of SSH2..

    Input/output:
    - accepts:
       java.lang.String
    - generates:
       java.lang.String


    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: SFTPGet
 
    -annotation <adams.core.base.BaseAnnotation> (property: annotations)
    The annotations to attach to this actor.
    default: 
 
    -skip <boolean> (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded 
    as it is.
    default: false
 
    -stop-flow-on-error <boolean> (property: stopFlowOnError)
    If set to true, the flow execution at this level gets stopped in case this 
    actor encounters an error; the error gets propagated; useful for critical 
    actors.
    default: false
 
    -silent <boolean> (property: silent)
    If enabled, then no errors are output in the console; Note: the enclosing 
    actor handler must have this enabled as well.
    default: false
 
    -remote-dir <java.lang.String> (property: remoteDir)
    The SFTP directory to download the file from.
    default: 
 
    -output-dir <adams.core.io.PlaceholderDirectory> (property: outputDirectory)
    The directory to store the downloaded files in.
    default: ${CWD}
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_RemoteDir

        protected String m_RemoteDir
        the directory to list.

      • m_Connection

        protected SSHConnection m_Connection
        the SSH connection to use.

    • Constructor Detail

      • SFTPGet

        public SFTPGet()

    • Method Detail

      • getTechnicalInformation

        public TechnicalInformation getTechnicalInformation()
        Returns an instance of a TechnicalInformation object, containing detailed information about the technical background of this class, e.g., paper reference or book this class is based on.
        Specified by:
        getTechnicalInformation in interface TechnicalInformationHandler
        Returns:
        the technical information about this class

      • setRemoteDir

        public void setRemoteDir​(String value)
        Sets the remote directory.
        Parameters:
        value - the remote directory

      • getRemoteDir

        public String getRemoteDir()
        Returns the remote directory.
        Returns:
        the remote directory.

      • remoteDirTipText

        public String remoteDirTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setOutputDirectory

        public void setOutputDirectory​(PlaceholderDirectory value)
        Sets the directory to store the downloaded files in.
        Parameters:
        value - the directory

      • getOutputDirectory

        public PlaceholderDirectory getOutputDirectory()
        Returns the directory to store the downloaded files in.
        Returns:
        the directory

      • outputDirectoryTipText

        public String outputDirectoryTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • accepts

        public Class[] accepts()
        Returns the class that the consumer accepts.
        Specified by:
        accepts in interface InputConsumer
        Returns:
        the Class of objects that can be processed

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Specified by:
        generates in interface OutputProducer
        Returns:
        the Class of the generated tokens

      • doExecute

        protected String doExecute()
        Executes the flow item.
        Specified by:
        doExecute in class AbstractActor
        Returns:
        null if everything is fine, otherwise error message