Package adams.flow.standalone

Class FTPConnection

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, PasswordPrompter, PasswordSupporter, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InteractiveActor, OptionalPasswordPrompt, StopModeSupporter, Serializable, Comparable, EventListener, org.apache.commons.net.ProtocolCommandListener
    public class FTPConnection
extends AbstractStandalone
implements org.apache.commons.net.ProtocolCommandListener, OptionalPasswordPrompt, PasswordPrompter
    Provides access to a FTP host.
    If debugging is enabled, the FTP commands issued by other actors will get printed as debug output of this actor.

    Valid options are: 

    -D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to 
    the console (0 = off).
    default: 0
    minimum: 0
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: FTPConnection
 
    -annotation <adams.core.base.BaseText> (property: annotations)
    The annotations to attach to this actor.
    default: 
 
    -skip (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded 
    as it is.
 
    -stop-flow-on-error (property: stopFlowOnError)
    If set to true, the flow gets stopped in case this actor encounters an error;
     useful for critical actors.
 
    -host <java.lang.String> (property: host)
    The host (name/IP address) to connect to.
    default: 
 
    -user <java.lang.String> (property: user)
    The FTP user to use for connecting.
 
    -password <adams.core.base.BasePassword> (property: password)
    The password of the FTP user to use for connecting.
 
    -passive (property: usePassiveMode)
    If enabled, passive mode is used instead.
 
    -binary (property: useBinaryMode)
    If enabled, binary mode is used instead of ASCII.
 
    -prompt-for-password (property: promptForPassword)
    If enabled, the user gets prompted for enter a password if none has been 
    provided in the setup.
 
    -stop-if-canceled (property: stopFlowIfCanceled)
    If enabled, the flow gets stopped in case the user cancels the dialog.
 
    -custom-stop-message <java.lang.String> (property: customStopMessage)
    The custom stop message to use in case a user cancelation stops the flow 
    (default is the full name of the actor)
    default:
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Host

        protected String m_Host
        the FTP host.

      • m_User

        protected String m_User
        the FTP user to use.

      • m_Password

        protected BasePassword m_Password
        the FTP password to use.

      • m_UsePassiveMode

        protected boolean m_UsePassiveMode
        whether to use passive mode.

      • m_UseBinaryMode

        protected boolean m_UseBinaryMode
        whether to use binary file transfer mode.

      • m_ActualPassword

        protected BasePassword m_ActualPassword
        the actual SMTP password to use.

      • m_PromptForPassword

        protected boolean m_PromptForPassword
        whether to prompt the user for a password if none provided.

      • m_StopFlowIfCanceled

        protected boolean m_StopFlowIfCanceled
        whether to stop the flow if canceled.

      • m_StopMode

        protected StopMode m_StopMode
        how to perform the stop.

      • m_CustomStopMessage

        protected String m_CustomStopMessage
        the custom stop message to use if flow gets stopped due to cancelation.

      • m_Client

        protected org.apache.commons.net.ftp.FTPClient m_Client
        the FTP client object.

    • Constructor Detail

      • FTPConnection

        public FTPConnection()

    • Method Detail

      • reset

        protected void reset()
        Resets the actor.
        Overrides:
        reset in class AbstractActor

      • setHost

        public void setHost​(String value)
        Sets the host to connect to.
        Parameters:
        value - the host name/ip

      • getHost

        public String getHost()
        Returns the host to connect to.
        Returns:
        the host name/ip

      • hostTipText

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

      • setUser

        public void setUser​(String value)
        Sets the FTP user to use.
        Parameters:
        value - the user name

      • getUser

        public String getUser()
        Returns the FTP user name to use.
        Returns:
        the user name

      • userTipText

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

      • passwordTipText

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

      • setUsePassiveMode

        public void setUsePassiveMode​(boolean value)
        Sets whether to use passive mode.
        Parameters:
        value - if true passive mode is used

      • getUsePassiveMode

        public boolean getUsePassiveMode()
        Returns whether passive mode is used.
        Returns:
        true if passive mode is used

      • usePassiveModeTipText

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

      • setUseBinaryMode

        public void setUseBinaryMode​(boolean value)
        Sets whether to use binary mode.
        Parameters:
        value - if true binary mode is used

      • getUseBinaryMode

        public boolean getUseBinaryMode()
        Returns whether binary mode is used.
        Returns:
        true if binary mode is used

      • useBinaryModeTipText

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

      • setStopFlowIfCanceled

        public void setStopFlowIfCanceled​(boolean value)
        Sets whether to stop the flow if dialog canceled.
        Specified by:
        setStopFlowIfCanceled in interface InteractiveActor
        Parameters:
        value - if true flow gets stopped if dialog canceled

      • getStopFlowIfCanceled

        public boolean getStopFlowIfCanceled()
        Returns whether to stop the flow if dialog canceled.
        Specified by:
        getStopFlowIfCanceled in interface InteractiveActor
        Returns:
        true if the flow gets stopped if dialog canceled

      • stopFlowIfCanceledTipText

        public String stopFlowIfCanceledTipText()
        Returns the tip text for this property.
        Specified by:
        stopFlowIfCanceledTipText in interface InteractiveActor
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setCustomStopMessage

        public void setCustomStopMessage​(String value)
        Sets the custom message to use when stopping the flow.
        Specified by:
        setCustomStopMessage in interface InteractiveActor
        Parameters:
        value - the stop message

      • getCustomStopMessage

        public String getCustomStopMessage()
        Returns the custom message to use when stopping the flow.
        Specified by:
        getCustomStopMessage in interface InteractiveActor
        Returns:
        the stop message

      • customStopMessageTipText

        public String customStopMessageTipText()
        Returns the tip text for this property.
        Specified by:
        customStopMessageTipText in interface InteractiveActor
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • stopModeTipText

        public String stopModeTipText()
        Returns the tip text for this property.
        Specified by:
        stopModeTipText in interface StopModeSupporter
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • doInteract

        public String doInteract()
        Performs the interaction with the user.
        Specified by:
        doInteract in interface InteractiveActor
        Returns:
        null if successfully interacted, otherwise error message

      • supportsHeadlessInteraction

        public boolean supportsHeadlessInteraction()
        Returns whether headless interaction is supported.
        Specified by:
        supportsHeadlessInteraction in interface InteractiveActor
        Returns:
        true if interaction in headless environment is possible

      • doInteractHeadless

        public String doInteractHeadless()
        Performs the interaction with the user in a headless environment.
        Specified by:
        doInteractHeadless in interface InteractiveActor
        Returns:
        true if successfully interacted

      • getFTPClient

        public org.apache.commons.net.ftp.FTPClient getFTPClient()
        Returns the FTP client object.
        Returns:
        the FTP client, null if failed to connect

      • doExecute

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

      • connect

        protected String connect()
        Starts up a FTP session.
        Returns:
        null if OK, otherwise error message

      • disconnect

        public void disconnect()
        Disconnects the FTP session, if necessary.

      • wrapUp

        public void wrapUp()
        Cleans up after the execution has finished.
        Specified by:
        wrapUp in interface Actor
        Overrides:
        wrapUp in class AbstractActor

      • protocolCommandSent

        public void protocolCommandSent​(org.apache.commons.net.ProtocolCommandEvent event)
        This method is invoked by a ProtocolCommandEvent source after sending a protocol command to a server.
        Specified by:
        protocolCommandSent in interface org.apache.commons.net.ProtocolCommandListener
        Parameters:
        event - The ProtocolCommandEvent fired.

      • protocolReplyReceived

        public void protocolReplyReceived​(org.apache.commons.net.ProtocolCommandEvent event)
        This method is invoked by a ProtocolCommandEvent source after receiving a reply from a server.
        Specified by:
        protocolReplyReceived in interface org.apache.commons.net.ProtocolCommandListener
        Parameters:
        event - The ProtocolCommandEvent fired.