Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.pentaho.di.job.entries.ftpdelete
Class JobEntryFTPDelete

    java.lang.Object
      org.pentaho.di.job.entry.JobEntryBase
          org.pentaho.di.job.entries.ftpdelete.JobEntryFTPDelete

All Implemented Interfaces:
  Cloneable, org.pentaho.di.core.CheckResultSourceInterface, org.pentaho.di.core.variables.VariableSpace, JobEntryInterface, ResourceHolderInterface

    public class JobEntryFTPDelete

extends JobEntryBase
implements Cloneable, JobEntryInterface

This defines an FTP job entry.

Since:
  05-11-2003
Author:
  Matt

Field Summary
`String` | `SUCCESS_IF_ALL_FILES_DOWNLOADED`
`String` | `SUCCESS_IF_AT_LEAST_X_FILES_DOWNLOADED`
`String` | `SUCCESS_IF_ERRORS_LESS`

Fields inherited from class org.pentaho.di.job.entry.JobEntryBase
`category_order`

Constructor Summary
`JobEntryFTPDelete()`
`JobEntryFTPDelete(JobEntryBase jeb)`
`JobEntryFTPDelete(String n)`

Method Summary
`void` | `check(List<org.pentaho.di.core.CheckResultInterface> remarks, JobMeta jobMeta)` Support for overrides not having to put in a check method
`Object` | `clone()`
`boolean` | `evaluates()` check whether or not this job entry evaluates.
`org.pentaho.di.core.Result` | `execute(org.pentaho.di.core.Result previousResult, int nr, Repository rep, Job parentJob)`
`String` | `getFtpDirectory()`
`String` | `getKeyFilename()`
`String` | `getKeyFilePass()`
`String` | `getLimitSuccess()`
`String` | `getPassword()`
`String` | `getPort()`
`String` | `getProtocol()`
`String` | `getProxyHost()`
`String` | `getProxyPassword()`
`String` | `getProxyPort()`
`String` | `getProxyUsername()`
`List<ResourceReference>` | `getResourceDependencies(JobMeta jobMeta)` Get a list of all the resource dependencies that the step is depending on.
`String` | `getServerName()`
`String` | `getSuccessCondition()`
`int` | `getTimeout()`
`String` | `getUserName()`
`String` | `getWildcard()`
`String` | `getXML()`
`boolean` | `isActiveConnection()`
`boolean` | `isCopyPrevious()`
`boolean` | `isDirectory(com.trilead.ssh2.SFTPv3Client sftpClient, String filename)` Checks if file is a directory
`boolean` | `isUseProxy()`
`boolean` | `isUsePublicKey()`
`void` | `loadRep(Repository rep, long id_jobentry, List<org.pentaho.di.core.database.DatabaseMeta> databases, List<SlaveServer> slaveServers)`
`void` | `loadXML(Node entrynode, List<org.pentaho.di.core.database.DatabaseMeta> databases, List<SlaveServer> slaveServers, Repository rep)`
`void` | `saveRep(Repository rep, long id_job)`
`void` | `setActiveConnection(boolean passive)`
`void` | `setCopyPrevious(boolean copyprevious)`
`void` | `setFtpDirectory(String directory)`
`void` | `setKeyFilename(String keyfilename)`
`void` | `setKeyFilePass(String keyFilePass)`
`void` | `setLimitSuccess(String nr_limit_successin)`
`void` | `setPassword(String password)`
`void` | `setPort(String port)`
`void` | `setProtocol(String protocol)`
`void` | `setProxyHost(String proxyHost)`
`void` | `setProxyPassword(String proxyPassword)`
`void` | `setProxyPort(String proxyPort)`
`void` | `setProxyUsername(String proxyUsername)`
`void` | `setServerName(String serverName)`
`void` | `setSuccessCondition(String success_condition)`
`void` | `setTimeout(int timeout)`
`void` | `setUseProxy(boolean useproxy)`
`void` | `setUsePublicKey(boolean publickey)`
`void` | `setUserName(String userName)`
`void` | `setWildcard(String wildcard)`

Methods inherited from class org.pentaho.di.job.entry.JobEntryBase
`clear, copyVariablesFrom, environmentSubstitute, environmentSubstitute, exportResources, getBooleanValueOfVariable, getConfigId, getDescription, getDialogClassName, getFilename, getHolderType, getID, getJobEntryType, getName, getParentVariableSpace, getPluginID, getRealFilename, getSQLStatements, getSQLStatements, getTypeCode, getTypeCode, getTypeDesc, getTypeDesc, getTypeId, getUsedDatabaseConnections, getVariable, getVariable, hasChanged, initializeVariablesFrom, injectVariables, isDummy, isEvaluation, isFTP, isHTTP, isJob, isMail, isSFTP, isShell, isSpecial, isStart, isTransformation, isUnconditional, listVariables, loadXML, parseRepositoryObjects, resetErrorsBeforeExecution, setChanged, setChanged, setConfigId, setDescription, setID, setJobEntryType, setName, setParentVariableSpace, setPluginID, setVariable, shareVariablesWith, toString`

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Methods inherited from interface org.pentaho.di.job.entry.JobEntryInterface
`clear, exportResources, getConfigId, getDescription, getDialogClassName, getFilename, getID, getJobEntryType, getName, getPluginID, getRealFilename, getSQLStatements, getSQLStatements, getTypeCode, getUsedDatabaseConnections, hasChanged, isDummy, isEvaluation, isJob, isMail, isShell, isSpecial, isStart, isTransformation, isUnconditional, resetErrorsBeforeExecution, setChanged, setChanged, setConfigId, setDescription, setID, setJobEntryType, setName, setPluginID`

Field Detail

### SUCCESS_IF_AT_LEAST_X_FILES_DOWNLOADED

    public String SUCCESS_IF_AT_LEAST_X_FILES_DOWNLOADED

### SUCCESS_IF_ERRORS_LESS

    public String SUCCESS_IF_ERRORS_LESS

### SUCCESS_IF_ALL_FILES_DOWNLOADED

    public String SUCCESS_IF_ALL_FILES_DOWNLOADED

Constructor Detail

### JobEntryFTPDelete

    public JobEntryFTPDelete(String n)

### JobEntryFTPDelete

    public JobEntryFTPDelete()

### JobEntryFTPDelete

    public JobEntryFTPDelete(JobEntryBase jeb)

Method Detail

### clone

    public Object clone()

  Specified by:
    `clone` in interface `JobEntryInterface`
  Overrides:
    `clone` in class `JobEntryBase`

### getXML

    public String getXML()

  Specified by:
    `getXML` in interface `JobEntryInterface`
  Overrides:
    `getXML` in class `JobEntryBase`

### loadXML

    public void loadXML(Node entrynode,
                        List<org.pentaho.di.core.database.DatabaseMeta> databases,
                        List<SlaveServer> slaveServers,
                        Repository rep)
                 throws org.pentaho.di.core.exception.KettleXMLException

  Specified by:
    `loadXML` in interface `JobEntryInterface`
  Throws:
    `org.pentaho.di.core.exception.KettleXMLException`

### loadRep

    public void loadRep(Repository rep,
                        long id_jobentry,
                        List<org.pentaho.di.core.database.DatabaseMeta> databases,
                        List<SlaveServer> slaveServers)
                 throws org.pentaho.di.core.exception.KettleException

  Specified by:
    `loadRep` in interface `JobEntryInterface`
  Overrides:
    `loadRep` in class `JobEntryBase`
  Throws:
    `org.pentaho.di.core.exception.KettleException`

### saveRep

    public void saveRep(Repository rep,
                        long id_job)
                 throws org.pentaho.di.core.exception.KettleException

  Specified by:
    `saveRep` in interface `JobEntryInterface`
  Overrides:
    `saveRep` in class `JobEntryBase`
  Throws:
    `org.pentaho.di.core.exception.KettleException`

### isCopyPrevious

    public boolean isCopyPrevious()

### setCopyPrevious

    public void setCopyPrevious(boolean copyprevious)

### setUsePublicKey

    public void setUsePublicKey(boolean publickey)

  Parameters:
    `publickey` - The publicpublickey to set.

### isUsePublicKey

    public boolean isUsePublicKey()

  Returns:
    Returns the use public key.

### setKeyFilename

    public void setKeyFilename(String keyfilename)

  Parameters:
    `keyfilename` - The key filename to set.

### getKeyFilename

    public String getKeyFilename()

  Returns:
    Returns the key filename.

### setKeyFilePass

    public void setKeyFilePass(String keyFilePass)

  Parameters:
    `keyFilePass` - The key file pass to set.

### getKeyFilePass

    public String getKeyFilePass()

  Returns:
    Returns the key file pass.

### setLimitSuccess

    public void setLimitSuccess(String nr_limit_successin)

### getLimitSuccess

    public String getLimitSuccess()

### setSuccessCondition

    public void setSuccessCondition(String success_condition)

### getSuccessCondition

    public String getSuccessCondition()

### getFtpDirectory

    public String getFtpDirectory()

  Returns:
    Returns the directory.

### setFtpDirectory

    public void setFtpDirectory(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.

### setProtocol

    public void setProtocol(String protocol)

### getProtocol

    public String getProtocol()

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

### setTimeout

    public void setTimeout(int timeout)

  Parameters:
    `timeout` - The timeout to set.

### getTimeout

    public int getTimeout()

  Returns:
    Returns the timeout.

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

### isUseProxy

    public boolean isUseProxy()

### setUseProxy

    public void setUseProxy(boolean useproxy)

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

### getPort

    public String getPort()

  Returns:
    Returns the port of the ftp.

### setPort

    public void setPort(String port)

  Parameters:
    `proxyPort` - The port of the ftp.

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

### 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,
                                              Repository rep,
                                              Job parentJob)

  Specified by:
    `execute` in interface `JobEntryInterface`

### isDirectory

    public boolean isDirectory(com.trilead.ssh2.SFTPv3Client sftpClient,
                               String filename)

  Checks if file is a directory

  Parameters:
    `sftpClient` -
    `filename` -
  Returns:
    true, if filename is a directory

### evaluates

    public boolean evaluates()

  Description copied from class: `JobEntryBase`
  check whether or not this job entry evaluates.

  Specified by:
    `evaluates` in interface `JobEntryInterface`
  Overrides:
    `evaluates` in class `JobEntryBase`
  Returns:
    true if the job entry evaluates

### isActiveConnection

    public boolean isActiveConnection()

  Returns:
    the activeConnection

### setActiveConnection

    public void setActiveConnection(boolean passive)

  Parameters:
    `activeConnection` - the activeConnection to set

### check

    public void check(List<org.pentaho.di.core.CheckResultInterface> remarks,
                      JobMeta jobMeta)

  Description copied from class: `JobEntryBase`
  Support for overrides not having to put in a check method

  Specified by:
    `check` in interface `JobEntryInterface`
  Overrides:
    `check` in class `JobEntryBase`
  Parameters:
    `remarks` - CheckResults from checking the job entry
    `jobMeta` - JobMeta information letting threading back to the JobMeta possible

### getResourceDependencies

    public List<ResourceReference> getResourceDependencies(JobMeta jobMeta)

  Description copied from class: `JobEntryBase`
  Get a list of all the resource dependencies that the step is depending on.

  Specified by:
    `getResourceDependencies` in interface `JobEntryInterface`
  Overrides:
    `getResourceDependencies` in class `JobEntryBase`
  Returns:
    a list of all the resource dependencies that the step is depending on

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD