Package adams.flow.standalone.rats.output

Class FtpUpload

  • All Implemented Interfaces:
    adams.core.AdditionalInformationHandler, adams.core.CleanUpHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.QuickInfoSupporter, adams.core.ShallowCopySupporter<AbstractRatOutput>, adams.core.SizeOfHandler, adams.core.Stoppable, adams.core.StoppableWithFeedback, adams.event.VariableChangeListener, RatOutput, Serializable
    public class FtpUpload
extends AbstractRatOutput
    Sends the incoming files to a FTP server. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -wait-ftp <int> (property: waitFTP)
    The number of milli-seconds to wait before FTP-ing the files.
    default: 0
    minimum: 0
 
    -remote-dir <java.lang.String> (property: remoteDir)
    The FTP directory to upload the file(s) to.
    default: /pub
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_RemoteDir

        protected String m_RemoteDir
        the directory to upload the file to.

      • m_WaitFTP

        protected int m_WaitFTP
        the waiting period in msec before FTPing the files.

      • m_Connection

        protected adams.flow.standalone.FTPConnection m_Connection
        the FTP connection to use.

    • Constructor Detail

      • FtpUpload

        public FtpUpload()

    • Method Detail

      • globalInfo

        public String globalInfo()
        Returns a string describing the object.
        Specified by:
        globalInfo in interface adams.core.GlobalInfoSupporter
        Specified by:
        globalInfo in class adams.core.option.AbstractOptionHandler
        Returns:
        a description suitable for displaying in the gui

      • defineOptions

        public void defineOptions()
        Adds options to the internal list of options.
        Specified by:
        defineOptions in interface adams.core.option.OptionHandler
        Overrides:
        defineOptions in class adams.core.option.AbstractOptionHandler

      • setWaitFTP

        public void setWaitFTP​(int value)
        Sets the number of milli-seconds to wait before FTPing the files.
        Parameters:
        value - the number of milli-seconds

      • getWaitFTP

        public int getWaitFTP()
        Returns the number of milli-seconds to wait before FTPing the files.
        Returns:
        the number of milli-seconds

      • waitFTPTipText

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

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

      • getQuickInfo

        public String getQuickInfo()
        Returns a quick info about the actor, which will be displayed in the GUI.
        Specified by:
        getQuickInfo in interface adams.core.QuickInfoSupporter
        Overrides:
        getQuickInfo in class AbstractRatOutput
        Returns:
        null if no info available, otherwise short string

      • check

        public String check()
        Hook method for performing checks.

        Checks for FTPConnection actor.
        Overrides:
        check in class AbstractRatOutput
        Returns:
        null if successful, otherwise error message

      • ftp

        protected String ftp​(String filename)
        Uploads the specified file to the FTP server.
        Parameters:
        filename - the file to upload
        Returns:
        null if successful, otherwise error message

      • doTransmit

        protected String doTransmit()
        Performs the actual transmission.
        Specified by:
        doTransmit in class AbstractRatOutput
        Returns:
        null if successful, otherwise error message