Package org.pentaho.di.job.entries.sftpput

Class JobEntrySFTPPUT

  • 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 JobEntrySFTPPUT
extends JobEntryBase
implements Cloneable, JobEntryInterface
    This defines an SFTP put job entry.
    Since:
    05-11-2003
    Author:
    Matt

    • Field Detail

      • afterFTPSDesc

        public static final String[] afterFTPSDesc

      • afterFTPSCode

        public static final String[] afterFTPSCode

    • Constructor Detail

      • JobEntrySFTPPUT

        public JobEntrySFTPPUT​(String n)

      • JobEntrySFTPPUT

        public JobEntrySFTPPUT()

    • 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

      • getAfterSFTPPutCode

        public static String getAfterSFTPPutCode​(int i)

      • 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

      • getAfterSFTPPutByCode

        public static int getAfterSFTPPutByCode​(String tt)

      • getAfterSFTPPutDesc

        public static String getAfterSFTPPutDesc​(int i)

      • getAfterSFTPPutByDesc

        public static int getAfterSFTPPutByDesc​(String tt)

      • 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

      • setCreateDestinationFolder

        public void setCreateDestinationFolder​(boolean createDestinationFolder)
        Parameters:
        createDestinationFolder - The create destination folder flag to set.

      • isCreateDestinationFolder

        public boolean isCreateDestinationFolder()
        Returns:
        Returns the create destination folder flag

      • setSuccessWhenNoFile

        public void setSuccessWhenNoFile​(boolean successWhenNoFile)
        Parameters:
        successWhenNoFile - The successWhenNoFile flag to set.

      • isSuccessWhenNoFile

        public boolean isSuccessWhenNoFile()
        Returns:
        Returns the create successWhenNoFile folder flag

      • setDestinationFolder

        public void setDestinationFolder​(String destinationfolderin)

      • getDestinationFolder

        public String getDestinationFolder()

      • getAfterFTPS

        public int getAfterFTPS()
        Returns:
        Returns the afterFTPS.

      • setAfterFTPS

        public void setAfterFTPS​(int value)
        Parameters:
        value - The afterFTPS to set.

      • getScpDirectory

        public String getScpDirectory()
        Returns:
        Returns the directory.

      • setScpDirectory

        public void setScpDirectory​(String directory)
        Parameters:
        directory - The directory 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 localDirectory)
        Parameters:
        localDirectory - The localDirectory to set.

      • isCopyPrevious

        public boolean isCopyPrevious()

      • setCopyPrevious

        public void setCopyPrevious​(boolean copyprevious)

      • isCopyPreviousFiles

        public boolean isCopyPreviousFiles()

      • setCopyPreviousFiles

        public void setCopyPreviousFiles​(boolean copypreviousfiles)

      • isAddFilenameResut

        public boolean isAddFilenameResut()

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

      • setAddFilenameResut

        public void setAddFilenameResut​(boolean addFilenameResut)

      • getCompression

        public String getCompression()
        Returns:
        Returns the compression.

      • setCompression

        public void setCompression​(String compression)
        Parameters:
        compression - The compression to set.

      • getServerPort

        public String getServerPort()

      • setServerPort

        public void setServerPort​(String serverPort)

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

      • isCreateRemoteFolder

        public boolean isCreateRemoteFolder()

      • setCreateRemoteFolder

        public void setCreateRemoteFolder​(boolean value)

      • execute

        public org.pentaho.di.core.Result execute​(org.pentaho.di.core.Result previousResult,
                                          int nr)
                                   throws org.pentaho.di.core.exception.KettleException
        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
        Throws:
        org.pentaho.di.core.exception.KettleException - if any Kettle exceptions occur

      • 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