JobEntryFTPDelete (PDI Engine 8.3.0.0-0.2.3 API)

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

所有已实现的接口:

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.variables.VariableSpace, JobEntryInterface, ResourceHolderInterface
```
public class JobEntryFTPDelete
extends JobEntryBase
implements Cloneable, JobEntryInterface
```
This defines an FTP job entry.

从以下版本开始:

05-11-2003

作者:

Matt

字段概要

字段
限定符和类型	字段和说明
`static String`	`PROTOCOL_FTP`
`static String`	`PROTOCOL_FTPS`
`static String`	`PROTOCOL_SFTP`
`static String`	`PROTOCOL_SSH`
`String`	`SUCCESS_IF_ALL_FILES_DOWNLOADED`
`String`	`SUCCESS_IF_AT_LEAST_X_FILES_DOWNLOADED`
`String`	`SUCCESS_IF_ERRORS_LESS`

从类继承的字段 org.pentaho.di.job.entry.JobEntryBase
attributesMap, containerObjectId, entryStepSetVariablesMap, extensionDataMap, log, metaStore, parentJob, parentJobMeta, rep, variables

构造器概要

构造器
构造器和说明

JobEntryFTPDelete()

JobEntryFTPDelete(String n)

构造器
构造器和说明
`JobEntryFTPDelete()`
`JobEntryFTPDelete(String n)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`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)` Allows JobEntry objects to check themselves for consistency
`Object`	`clone()` This method is called when a job entry is duplicated in Spoon.
`boolean`	`evaluates()` This method must return true if the job entry supports the true/false outgoing hops.
`org.pentaho.di.core.Result`	`execute(org.pentaho.di.core.Result previousResult, int nr)` Needed for the Vector coming from sshclient.ls() *
`String`	`getFtpDirectory()`
`int`	`getFTPSConnectionType()`
`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)` Gets a list of all the resource dependencies that the step is depending on.
`String`	`getServerName()`
`String`	`getSocksProxyHost()`
`String`	`getSocksProxyPassword()`
`String`	`getSocksProxyPort()`
`String`	`getSocksProxyUsername()`
`String`	`getSuccessCondition()`
`int`	`getTimeout()`
`String`	`getUserName()`
`String`	`getWildcard()`
`String`	`getXML()` This method is called by PDI whenever a job entry needs to serialize its settings to XML.
`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, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.repository.ObjectId id_jobentry, List<org.pentaho.di.core.database.DatabaseMeta> databases, List<SlaveServer> slaveServers)` This method is called by PDI whenever a job entry needs to read its configuration from a PDI repository.
`void`	`loadXML(Node entrynode, List<org.pentaho.di.core.database.DatabaseMeta> databases, List<SlaveServer> slaveServers, Repository rep, org.pentaho.metastore.api.IMetaStore metaStore)` This method is called by PDI whenever a job entry needs to read its settings from XML.
`void`	`saveRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.repository.ObjectId id_job)` This method is called by PDI whenever a job entry needs to save its settings to a PDI repository.
`void`	`setActiveConnection(boolean passive)`
`void`	`setCopyPrevious(boolean copyprevious)`
`void`	`setFtpDirectory(String directory)`
`void`	`setFTPSConnectionType(int type)`
`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`	`setSocksProxyHost(String socksProxyHost)`
`void`	`setSocksProxyPassword(String socksProxyPassword)`
`void`	`setSocksProxyPort(String socksProxyPort)`
`void`	`setSocksProxyUsername(String socksProxyUsername)`
`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)`

从类继承的方法 org.pentaho.di.job.entry.JobEntryBase
check, clear, copyVariablesFrom, environmentSubstitute, environmentSubstitute, equals, exportResources, exportResources, fieldSubstitute, getAttribute, getAttributes, getAttributesMap, getBooleanValueOfVariable, getContainerObjectId, getDescription, getDialogClassName, getEntryStepSetVariable, getEntryStepSetVariablesMap, getExtensionDataMap, getFilename, getHolderType, getLogChannel, getLogChannelId, getLogLevel, getMetaStore, getName, getObjectCopy, getObjectId, getObjectName, getObjectRevision, getObjectType, getParent, getParentJob, getParentJobMeta, getParentVariableSpace, getPluginId, getRealFilename, getReferencedObjectDescriptions, getRegistrationDate, getRepository, getRepositoryDirectory, getSQLStatements, getSQLStatements, getSQLStatements, getTypeDesc, getTypeId, getUsedDatabaseConnections, getVariable, getVariable, getVariables, hasChanged, hashCode, hasRepositoryReferences, initializeVariablesFrom, injectVariables, isBasic, isDebug, isDetailed, isDummy, isEvaluation, isForcingSeparateLogging, isFTP, isGatheringMetrics, isHTTP, isJob, isMail, isReferencedObjectEnabled, isRowlevel, isSFTP, isShell, isSpecial, isStart, isTransformation, isUnconditional, listVariables, loadReferencedObject, loadReferencedObject, loadRep, loadXML, loadXML, logBasic, logBasic, logDebug, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logMinimal, logRowlevel, logRowlevel, lookupRepositoryReferences, parseRepositoryObjects, resetErrorsBeforeExecution, saveRep, setAttribute, setAttributes, setAttributesMap, setChanged, setChanged, setContainerObjectId, setDescription, setEntryStepSetVariable, setForcingSeparateLogging, setGatheringMetrics, setID, setLogLevel, setMetaStore, setName, setObjectId, setParentJob, setParentJobMeta, setParentVariableSpace, setPluginId, setRepository, setTypeId, setVariable, shareVariablesWith, toString

从类继承的方法 java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- 字段详细资料
  - PROTOCOL_FTP
```
public static final String PROTOCOL_FTP
```
    另请参阅:
    
    常量字段值
  - PROTOCOL_FTPS
```
public static final String PROTOCOL_FTPS
```
    另请参阅:
    
    常量字段值
  - PROTOCOL_SFTP
```
public static final String PROTOCOL_SFTP
```
    另请参阅:
    
    常量字段值
  - PROTOCOL_SSH
```
public static final String PROTOCOL_SSH
```
    另请参阅:
    
    常量字段值
  - 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
```
- 构造器详细资料
  - JobEntryFTPDelete
```
public JobEntryFTPDelete(String n)
```
  - JobEntryFTPDelete
```
public JobEntryFTPDelete()
```
- 方法详细资料
  - clone
```
public Object clone()
```
    从类复制的说明: 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.
    
    指定者:
    
    clone 在接口中 JobEntryInterface
    
    覆盖:
    
    clone 在类中 JobEntryBase
    
    返回:
    
    a clone of the object
  - getXML
```
public String getXML()
```
    从类复制的说明: 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.
    
    指定者:
    
    getXML 在接口中 JobEntryInterface
    
    覆盖:
    
    getXML 在类中 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
```
    从接口复制的说明: 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.
    
    指定者:
    
    loadXML 在接口中 JobEntryInterface
    
    覆盖:
    
    loadXML 在类中 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
```
    从接口复制的说明: 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.
    
    指定者:
    
    loadRep 在接口中 JobEntryInterface
    
    覆盖:
    
    loadRep 在类中 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
```
    从接口复制的说明: 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.
    
    指定者:
    
    saveRep 在接口中 JobEntryInterface
    
    覆盖:
    
    saveRep 在类中 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
  - isCopyPrevious
```
public boolean isCopyPrevious()
```
  - setCopyPrevious
```
public void setCopyPrevious(boolean copyprevious)
```
  - setUsePublicKey
```
public void setUsePublicKey(boolean publickey)
```
    参数:
    
    publickey - The publicpublickey to set.
  - isUsePublicKey
```
public boolean isUsePublicKey()
```
    返回:
    
    Returns the use public key.
  - setKeyFilename
```
public void setKeyFilename(String keyfilename)
```
    参数:
    
    keyfilename - The key filename to set.
  - getKeyFilename
```
public String getKeyFilename()
```
    返回:
    
    Returns the key filename.
  - setKeyFilePass
```
public void setKeyFilePass(String keyFilePass)
```
    参数:
    
    keyFilePass - The key file pass to set.
  - getKeyFilePass
```
public String getKeyFilePass()
```
    返回:
    
    Returns the key file pass.
  - getFTPSConnectionType
```
public int getFTPSConnectionType()
```
    返回:
    
    the connection type
  - setFTPSConnectionType
```
public void setFTPSConnectionType(int type)
```
    参数:
    
    connectionType - the connectionType to set
  - 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 the directory.
  - setFtpDirectory
```
public void setFtpDirectory(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.
  - getServerName
```
public String getServerName()
```
    返回:
    
    Returns the serverName.
  - setServerName
```
public void setServerName(String serverName)
```
    参数:
    
    serverName - The serverName to set.
  - setProtocol
```
public void setProtocol(String protocol)
```
  - getProtocol
```
public String getProtocol()
```
  - 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.
  - setTimeout
```
public void setTimeout(int timeout)
```
    参数:
    
    timeout - The timeout to set.
  - getTimeout
```
public int getTimeout()
```
    返回:
    
    Returns the timeout.
  - getProxyHost
```
public String getProxyHost()
```
    返回:
    
    Returns the hostname of the ftp-proxy.
  - setProxyHost
```
public void setProxyHost(String proxyHost)
```
    参数:
    
    proxyHost - The hostname of the proxy.
  - isUseProxy
```
public boolean isUseProxy()
```
  - setUseProxy
```
public void setUseProxy(boolean useproxy)
```
  - getProxyPassword
```
public String getProxyPassword()
```
    返回:
    
    Returns the password which is used to authenticate at the proxy.
  - setProxyPassword
```
public void setProxyPassword(String proxyPassword)
```
    参数:
    
    proxyPassword - The password which is used to authenticate at the proxy.
  - getPort
```
public String getPort()
```
    返回:
    
    Returns the port of the ftp.
  - setPort
```
public void setPort(String port)
```
    参数:
    
    proxyPort - The port of the ftp.
  - getProxyPort
```
public String getProxyPort()
```
    返回:
    
    Returns the port of the ftp-proxy.
  - setProxyPort
```
public void setProxyPort(String proxyPort)
```
    参数:
    
    proxyPort - The port of the ftp-proxy.
  - getProxyUsername
```
public String getProxyUsername()
```
    返回:
    
    Returns the username which is used to authenticate at the proxy.
  - setProxyUsername
```
public void setProxyUsername(String proxyUsername)
```
    参数:
    
    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)
```
    Needed for the Vector coming from sshclient.ls() *
    
    指定者:
    
    execute 在接口中 JobEntryInterface
    
    参数:
    
    previousResult - the previous result
    
    nr - the number of rows
    
    返回:
    
    the Result object from execution of this job entry
  - isDirectory
```
public boolean isDirectory(com.trilead.ssh2.SFTPv3Client sftpClient,
                           String filename)
```
    Checks if file is a directory
    
    参数:
    
    sftpClient -
    
    filename -
    
    返回:
    
    true, if filename is a directory
  - evaluates
```
public boolean evaluates()
```
    从类复制的说明: JobEntryBase
    
    This method must return true if the job entry supports the true/false outgoing hops. For JobEntryBase, this method always returns false
    
    指定者:
    
    evaluates 在接口中 JobEntryInterface
    
    覆盖:
    
    evaluates 在类中 JobEntryBase
    
    返回:
    
    false
  - isActiveConnection
```
public boolean isActiveConnection()
```
    返回:
    
    the activeConnection
  - setActiveConnection
```
public void setActiveConnection(boolean passive)
```
    参数:
    
    activeConnection - the activeConnection to set
  - 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)
```
    从类复制的说明: JobEntryBase
    
    Allows JobEntry objects to check themselves for consistency
    
    指定者:
    
    check 在接口中 JobEntryInterface
    
    覆盖:
    
    check 在类中 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
  - getResourceDependencies
```
public List<ResourceReference> getResourceDependencies(JobMeta jobMeta)
```
    从类复制的说明: JobEntryBase
    
    Gets a list of all the resource dependencies that the step is depending on. In JobEntryBase, this method returns an empty resource dependency list.
    
    指定者:
    
    getResourceDependencies 在接口中 JobEntryInterface
    
    覆盖:
    
    getResourceDependencies 在类中 JobEntryBase
    
    返回:
    
    an empty list of ResourceReferences
    
    另请参阅:
    
    ResourceReference
  - getSocksProxyHost
```
public String getSocksProxyHost()
```
    返回:
    
    Socks proxy host
  - getSocksProxyPort
```
public String getSocksProxyPort()
```
    返回:
    
    Socks proxy port
  - getSocksProxyUsername
```
public String getSocksProxyUsername()
```
    返回:
    
    Socks proxy username
  - getSocksProxyPassword
```
public String getSocksProxyPassword()
```
    返回:
    
    Socks proxy username
  - setSocksProxyHost
```
public void setSocksProxyHost(String socksProxyHost)
```
  - setSocksProxyPort
```
public void setSocksProxyPort(String socksProxyPort)
```
  - setSocksProxyUsername
```
public void setSocksProxyUsername(String socksProxyUsername)
```
  - setSocksProxyPassword
```
public void setSocksProxyPassword(String socksProxyPassword)
```

类 JobEntryFTPDelete

字段概要

从类继承的字段 org.pentaho.di.job.entry.JobEntryBase

构造器概要

方法概要

从类继承的方法 org.pentaho.di.job.entry.JobEntryBase

从类继承的方法 java.lang.Object

从接口继承的方法 org.pentaho.di.job.entry.JobEntryInterface

字段详细资料

PROTOCOL_FTP

PROTOCOL_FTPS

PROTOCOL_SFTP

PROTOCOL_SSH

SUCCESS_IF_AT_LEAST_X_FILES_DOWNLOADED

SUCCESS_IF_ERRORS_LESS

SUCCESS_IF_ALL_FILES_DOWNLOADED

构造器详细资料

JobEntryFTPDelete

JobEntryFTPDelete

方法详细资料

clone

getXML

loadXML

loadRep

saveRep

isCopyPrevious

setCopyPrevious

setUsePublicKey

isUsePublicKey

setKeyFilename

getKeyFilename

setKeyFilePass

getKeyFilePass

getFTPSConnectionType

setFTPSConnectionType

setLimitSuccess

getLimitSuccess

setSuccessCondition

getSuccessCondition

getFtpDirectory

setFtpDirectory

getPassword

setPassword

getServerName

setServerName

setProtocol

getProtocol

getUserName

setUserName

getWildcard

setWildcard

setTimeout

getTimeout

getProxyHost

setProxyHost

isUseProxy

setUseProxy

getProxyPassword

setProxyPassword

getPort

setPort

getProxyPort

setProxyPort

getProxyUsername

setProxyUsername

execute

isDirectory

evaluates

isActiveConnection

setActiveConnection

check

getResourceDependencies

getSocksProxyHost

getSocksProxyPort

getSocksProxyUsername

getSocksProxyPassword

setSocksProxyHost

setSocksProxyPort

setSocksProxyUsername

setSocksProxyPassword