Package org.pentaho.di.job.entries.ftpput

Class JobEntryFTPPUT

  • All Implemented Interfaces:
    Cloneable, org.pentaho.di.core.AttributesInterface, org.pentaho.di.core.CheckResultSourceInterface, org.pentaho.di.core.ExtensionDataInterface, org.pentaho.di.core.logging.LoggingObjectInterface, org.pentaho.di.core.logging.LoggingObjectLifecycleInterface, org.pentaho.di.core.variables.VariableSpace, JobEntryInterface, ResourceHolderInterface
    public class JobEntryFTPPUT
extends JobEntryBase
implements Cloneable, JobEntryInterface
    This defines an FTP put job entry.
    Since:
    15-09-2007
    Author:
    Samatar

    • Constructor Detail

      • JobEntryFTPPUT

        public JobEntryFTPPUT​(String n)

      • JobEntryFTPPUT

        public JobEntryFTPPUT()

    • Method Detail

      • clone

        public Object clone()
        Description copied from class: JobEntryBase
        This method is called when a job entry is duplicated in Spoon. It needs to return a deep copy of this job entry object. It is essential that the implementing class creates proper deep copies if the job entry configuration is stored in modifiable objects, such as lists or custom helper objects.
        Specified by:
        clone in interface JobEntryInterface
        Overrides:
        clone in class JobEntryBase
        Returns:
        a clone of the object

      • getXML

        public String getXML()
        Description copied from class: JobEntryBase
        This method is called by PDI whenever a job entry needs to serialize its settings to XML. It is called when saving a job in Spoon. The method returns an XML string, containing the serialized settings. The string contains a series of XML tags, typically one tag per setting. The helper class org.pentaho.di.core.xml.XMLHandler is typically used to construct the XML string.
        Specified by:
        getXML in interface JobEntryInterface
        Overrides:
        getXML in class JobEntryBase
        Returns:
        the xml representation of the job entry

      • loadXML

        public void loadXML​(Node entrynode,
                    List<org.pentaho.di.core.database.DatabaseMeta> databases,
                    List<SlaveServer> slaveServers,
                    Repository rep,
                    org.pentaho.metastore.api.IMetaStore metaStore)
             throws org.pentaho.di.core.exception.KettleXMLException
        Description copied from interface: JobEntryInterface
        This method is called by PDI whenever a job entry needs to read its settings from XML. The XML node containing the job entry's settings is passed in as an argument. Again, the helper class org.pentaho.di.core.xml.XMLHandler is typically used to conveniently read the settings from the XML node.
        Specified by:
        loadXML in interface JobEntryInterface
        Overrides:
        loadXML in class JobEntryBase
        Parameters:
        entrynode - the top-level XML node
        databases - the list of databases
        slaveServers - the list of slave servers
        rep - the repository object
        metaStore - The metaStore to optionally load from.
        Throws:
        org.pentaho.di.core.exception.KettleXMLException - if any errors occur during the loading of the XML

      • loadRep

        public void loadRep​(Repository rep,
                    org.pentaho.metastore.api.IMetaStore metaStore,
                    org.pentaho.di.repository.ObjectId id_jobentry,
                    List<org.pentaho.di.core.database.DatabaseMeta> databases,
                    List<SlaveServer> slaveServers)
             throws org.pentaho.di.core.exception.KettleException
        Description copied from interface: JobEntryInterface
        This method is called by PDI whenever a job entry needs to read its configuration from a PDI repository. The job entry id given in the arguments should be used as the identifier when using the repository's serialization methods.
        Specified by:
        loadRep in interface JobEntryInterface
        Overrides:
        loadRep in class JobEntryBase
        Parameters:
        rep - the repository object
        metaStore - the MetaStore to use
        id_jobentry - the id of the job entry
        databases - the list of databases
        slaveServers - the list of slave servers
        Throws:
        org.pentaho.di.core.exception.KettleException - if any errors occur during the load

      • saveRep

        public void saveRep​(Repository rep,
                    org.pentaho.metastore.api.IMetaStore metaStore,
                    org.pentaho.di.repository.ObjectId id_job)
             throws org.pentaho.di.core.exception.KettleException
        Description copied from interface: JobEntryInterface
        This method is called by PDI whenever a job entry needs to save its settings to a PDI repository. The repository object passed in as the first argument provides a convenient set of methods for serializing job entry settings. When calling repository serialization methods, job id and job entry id are required. The job id is passed in to saveRep() as an argument, and the job entry id can be obtained by a call to getObjectId() inherited from the base class.
        Specified by:
        saveRep in interface JobEntryInterface
        Overrides:
        saveRep in class JobEntryBase
        Parameters:
        rep - the repository
        metaStore - the MetaStore to use
        id_job - the id_job
        Throws:
        org.pentaho.di.core.exception.KettleException - if any errors occur during the save

      • isBinaryMode

        public boolean isBinaryMode()
        Returns:
        Returns the binaryMode.

      • setBinaryMode

        public void setBinaryMode​(boolean binaryMode)
        Parameters:
        binaryMode - The binaryMode to set.

      • setTimeout

        public void setTimeout​(int timeout)
        Parameters:
        timeout - The timeout to set.

      • getTimeout

        public int getTimeout()
        Returns:
        Returns the timeout.

      • isOnlyPuttingNewFiles

        public boolean isOnlyPuttingNewFiles()
        Returns:
        Returns the onlyGettingNewFiles.

      • setOnlyPuttingNewFiles

        public void setOnlyPuttingNewFiles​(boolean onlyPuttingNewFiles)
        Parameters:
        onlyPuttingNewFiles - Only transfer new files to the remote host

      • getControlEncoding

        public String getControlEncoding()
        Get the control encoding to be used for ftp'ing
        Returns:
        the used encoding

      • setControlEncoding

        public void setControlEncoding​(String encoding)
        Set the encoding to be used for ftp'ing. This determines how names are translated in dir e.g. It does impact the contents of the files being ftp'ed.
        Parameters:
        encoding - The encoding to be used.

      • getRemoteDirectory

        public String getRemoteDirectory()
        Returns:
        Returns the remoteDirectory.

      • setRemoteDirectory

        public void setRemoteDirectory​(String directory)
        Parameters:
        directory - The remoteDirectory to set.

      • getPassword

        public String getPassword()
        Returns:
        Returns the password.

      • setPassword

        public void setPassword​(String password)
        Parameters:
        password - The password to set.

      • getServerName

        public String getServerName()
        Returns:
        Returns the serverName.

      • setServerName

        public void setServerName​(String serverName)
        Parameters:
        serverName - The serverName to set.

      • getUserName

        public String getUserName()
        Returns:
        Returns the userName.

      • setUserName

        public void setUserName​(String userName)
        Parameters:
        userName - The userName to set.

      • getWildcard

        public String getWildcard()
        Returns:
        Returns the wildcard.

      • setWildcard

        public void setWildcard​(String wildcard)
        Parameters:
        wildcard - The wildcard to set.

      • getLocalDirectory

        public String getLocalDirectory()
        Returns:
        Returns the localDirectory.

      • setLocalDirectory

        public void setLocalDirectory​(String directory)
        Parameters:
        directory - The localDirectory to set.

      • setRemove

        public void setRemove​(boolean remove)
        Parameters:
        remove - The remove to set.

      • getRemove

        public boolean getRemove()
        Returns:
        Returns the remove.

      • getServerPort

        public String getServerPort()

      • setServerPort

        public void setServerPort​(String serverPort)

      • isActiveConnection

        public boolean isActiveConnection()
        Returns:
        the activeConnection

      • setActiveConnection

        public void setActiveConnection​(boolean activeConnection)
        Parameters:
        activeConnection - set to true to get an active FTP connection

      • getProxyHost

        public String getProxyHost()
        Returns:
        Returns the hostname of the ftp-proxy.

      • setProxyHost

        public void setProxyHost​(String proxyHost)
        Parameters:
        proxyHost - The hostname of the proxy.

      • getProxyPassword

        public String getProxyPassword()
        Returns:
        Returns the password which is used to authenticate at the proxy.

      • setProxyPassword

        public void setProxyPassword​(String proxyPassword)
        Parameters:
        proxyPassword - The password which is used to authenticate at the proxy.

      • getProxyPort

        public String getProxyPort()
        Returns:
        Returns the port of the ftp-proxy.

      • setProxyPort

        public void setProxyPort​(String proxyPort)
        Parameters:
        proxyPort - The port of the ftp-proxy.

      • getProxyUsername

        public String getProxyUsername()
        Returns:
        Returns the username which is used to authenticate at the proxy.

      • setSocksProxyHost

        public void setSocksProxyHost​(String socksProxyHost)
        Parameters:
        socksProxyHost - The socks proxy host to set

      • setSocksProxyPort

        public void setSocksProxyPort​(String socksProxyPort)
        Parameters:
        socksProxyPort - The socks proxy port to set

      • setSocksProxyUsername

        public void setSocksProxyUsername​(String socksProxyUsername)
        Parameters:
        socksProxyUsername - The socks proxy username to set

      • setSocksProxyPassword

        public void setSocksProxyPassword​(String socksProxyPassword)
        Parameters:
        socksProxyPassword - The socks proxy password to set

      • getSocksProxyHost

        public String getSocksProxyHost()
        Returns:
        The sox proxy host name

      • getSocksProxyPort

        public String getSocksProxyPort()
        Returns:
        The socks proxy port

      • getSocksProxyUsername

        public String getSocksProxyUsername()
        Returns:
        The socks proxy username

      • getSocksProxyPassword

        public String getSocksProxyPassword()
        Returns:
        The socks proxy password

      • setProxyUsername

        public void setProxyUsername​(String proxyUsername)
        Parameters:
        proxyUsername - The username which is used to authenticate at the proxy.

      • execute

        public org.pentaho.di.core.Result execute​(org.pentaho.di.core.Result previousResult,
                                          int nr)
        Description copied from interface: JobEntryInterface
        Execute the job entry. The previous result and number of rows are provided to the method for the purpose of chaining job entries, transformations, etc.
        Specified by:
        execute in interface JobEntryInterface
        Parameters:
        previousResult - the previous result
        nr - the number of rows
        Returns:
        the Result object from execution of this job entry

      • evaluates

        public boolean evaluates()
        Description copied from class: JobEntryBase
        This method must return true if the job entry supports the true/false outgoing hops. For JobEntryBase, this method always returns false
        Specified by:
        evaluates in interface JobEntryInterface
        Overrides:
        evaluates in class JobEntryBase
        Returns:
        false

      • check

        public void check​(List<org.pentaho.di.core.CheckResultInterface> remarks,
                  JobMeta jobMeta,
                  org.pentaho.di.core.variables.VariableSpace space,
                  Repository repository,
                  org.pentaho.metastore.api.IMetaStore metaStore)
        Description copied from class: JobEntryBase
        Allows JobEntry objects to check themselves for consistency
        Specified by:
        check in interface JobEntryInterface
        Overrides:
        check in class JobEntryBase
        Parameters:
        remarks - List of CheckResult objects indicating consistency status
        jobMeta - the metadata object for the job entry
        space - the variable space to resolve string expressions with variables with
        repository - the repository to load Kettle objects from
        metaStore - the MetaStore to load common elements from

      • hookInOtherParsers

        protected void hookInOtherParsers​(com.enterprisedt.net.ftp.FTPClient ftpClient)
                           throws com.enterprisedt.net.ftp.FTPException,
                                  IOException
        Hook in known parsers, and then those that have been specified in the variable ftp.file.parser.class.names
        Parameters:
        ftpClient -
        Throws:
        com.enterprisedt.net.ftp.FTPException
        IOException