Class JobEntrySFTP

  • 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 JobEntrySFTP
    extends JobEntryBase
    implements Cloneable, JobEntryInterface
    This defines a SFTP job entry.
    • Constructor Detail

      • JobEntrySFTP

        public JobEntrySFTP​(String n)
      • JobEntrySFTP

        public JobEntrySFTP()
    • 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
        clone in class JobEntryBase
        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
        getXML in class JobEntryBase
        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
        loadXML in class JobEntryBase
        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.
        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
        loadRep in class JobEntryBase
        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
        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
        saveRep in class JobEntryBase
        rep - the repository
        metaStore - the MetaStore to use
        id_job - the id_job
        org.pentaho.di.core.exception.KettleException - if any errors occur during the save
      • getScpDirectory

        public String getScpDirectory()
        Returns the directory.
      • setScpDirectory

        public void setScpDirectory​(String directory)
        directory - The directory to set.
      • getPassword

        public String getPassword()
        Returns the password.
      • setPassword

        public void setPassword​(String password)
        password - The password to set.
      • getCompression

        public String getCompression()
        Returns the compression.
      • setCompression

        public void setCompression​(String compression)
        compression - The compression to set.
      • getServerName

        public String getServerName()
        Returns the serverName.
      • setServerName

        public void setServerName​(String serverName)
        serverName - The serverName to set.
      • getUserName

        public String getUserName()
        Returns the userName.
      • setUserName

        public void setUserName​(String userName)
        userName - The userName to set.
      • getWildcard

        public String getWildcard()
        Returns the wildcard.
      • setWildcard

        public void setWildcard​(String wildcard)
        wildcard - The wildcard to set.
      • setAddToResult

        public void setAddToResult​(boolean isaddresultin)
      • isAddToResult

        public boolean isAddToResult()
      • getTargetDirectory

        public String getTargetDirectory()
        Returns the targetDirectory.
      • isCreateTargetFolder

        public boolean isCreateTargetFolder()
      • setCreateTargetFolder

        public void setCreateTargetFolder​(boolean createtargetfolder)
      • isCopyPrevious

        public boolean isCopyPrevious()
      • setCopyPrevious

        public void setCopyPrevious​(boolean copyprevious)
      • setTargetDirectory

        public void setTargetDirectory​(String targetDirectory)
        targetDirectory - The targetDirectory to set.
      • setRemove

        public void setRemove​(boolean remove)
        remove - The remove to set.
      • getRemove

        public boolean getRemove()
        Returns the remove.
      • getServerPort

        public String getServerPort()
      • setServerPort

        public void setServerPort​(String serverPort)
      • isUseKeyFile

        public boolean isUseKeyFile()
      • setUseKeyFile

        public void setUseKeyFile​(boolean value)
      • getKeyFilename

        public String getKeyFilename()
      • setKeyFilename

        public void setKeyFilename​(String value)
      • getKeyPassPhrase

        public String getKeyPassPhrase()
      • setKeyPassPhrase

        public void setKeyPassPhrase​(String value)
      • getProxyType

        public String getProxyType()
      • setProxyType

        public void setProxyType​(String value)
      • getProxyHost

        public String getProxyHost()
      • setProxyHost

        public void setProxyHost​(String value)
      • getProxyPort

        public String getProxyPort()
      • setProxyPort

        public void setProxyPort​(String value)
      • getProxyUsername

        public String getProxyUsername()
      • setProxyUsername

        public void setProxyUsername​(String value)
      • getProxyPassword

        public String getProxyPassword()
      • setProxyPassword

        public void setProxyPassword​(String value)
      • 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
        previousResult - the previous result
        nr - the number of rows
        the Result object from execution of this job entry
      • getRealPassword

        public String getRealPassword​(String password)
      • 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
        evaluates in class JobEntryBase
      • 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
        check in class JobEntryBase
        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
      • main

        public static void main​(String[] args)