JobEntryFTPSGet (PDI Engine 8.2.0.1-349 API)

java.lang.Object
- org.pentaho.di.job.entry.JobEntryBase
- - org.pentaho.di.job.entries.ftpsget.JobEntryFTPSGet

All Implemented Interfaces:

Cloneable, AttributesInterface, CheckResultSourceInterface, ExtensionDataInterface, LoggingObjectInterface, VariableSpace, JobEntryInterface, ResourceHolderInterface
```
public class JobEntryFTPSGet
extends JobEntryBase
implements Cloneable, JobEntryInterface
```
This defines an FTPS job entry.

Since:

08-03-2010

Author:

Samatar

Field Summary

Fields
Modifier and Type	Field and Description
`static String[]`	`FILE_EXISTS_ACTIONS`
`static int`	`ifFileExistsCreateUniq`
`static int`	`ifFileExistsFail`
`static int`	`ifFileExistsSkip`
`String`	`SUCCESS_IF_AT_LEAST_X_FILES_DOWNLOADED`
`String`	`SUCCESS_IF_ERRORS_LESS`
`String`	`SUCCESS_IF_NO_ERRORS`

Fields inherited from class org.pentaho.di.job.entry.JobEntryBase
attributesMap, containerObjectId, entryStepSetVariablesMap, extensionDataMap, log, metaStore, parentJob, parentJobMeta, rep, variables

Constructor Summary

Constructors
Constructor and Description

JobEntryFTPSGet()

JobEntryFTPSGet(String n)

Constructors
Constructor and Description
`JobEntryFTPSGet()`
`JobEntryFTPSGet(String n)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`check(List<CheckResultInterface> remarks, JobMeta jobMeta, 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.
`Result`	`execute(Result previousResult, int nr)` Execute the job entry.
`int`	`getConnectionType()`
`String`	`getDateTimeFormat()`
`static String`	`getFileExistsAction(int actionId)`
`static int`	`getFileExistsIndex(String desc)`
`String`	`getFTPSDirectory()`
`int`	`getIfFileExists()`
`String`	`getLimit()`
`String`	`getMoveToDirectory()`
`String`	`getPassword()`
`String`	`getPort()`
`String`	`getProxyHost()`
`String`	`getProxyPassword()`
`String`	`getProxyPort()`
`String`	`getProxyUsername()`
`boolean`	`getRemove()`
`List<ResourceReference>`	`getResourceDependencies(JobMeta jobMeta)` Gets a list of all the resource dependencies that the step is depending on.
`String`	`getServerName()`
`String`	`getSuccessCondition()`
`String`	`getTargetDirectory()`
`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`	`isAddDateBeforeExtension()`
`boolean`	`isAddToResult()`
`boolean`	`isBinaryMode()`
`boolean`	`isCreateMoveFolder()`
`boolean`	`isDateInFilename()`
`boolean`	`isMoveFiles()`
`boolean`	`isOnlyGettingNewFiles()`
`boolean`	`isSpecifyFormat()`
`boolean`	`isTimeInFilename()`
`void`	`loadRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, ObjectId id_jobentry, List<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<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.
`protected boolean`	`needsDownload(String filename)` See if the filename on the FTPS server needs downloading.
`String`	`normalizePath(String path)` normalize / to \ and remove trailing slashes from a path
`void`	`saveRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, 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`	`setAddDateBeforeExtension(boolean AddDateBeforeExtension)`
`void`	`setAddToResult(boolean isaddresultin)`
`void`	`setBinaryMode(boolean binaryMode)`
`void`	`setConnectionType(int type)`
`void`	`setCreateMoveFolder(boolean createmovefolderin)`
`void`	`setDateInFilename(boolean adddate)`
`void`	`setDateTimeFormat(String date_time_format)`
`void`	`setFTPSDirectory(String directory)`
`void`	`setIfFileExists(int ifFileExists)`
`void`	`setLimit(String nr_limitin)`
`void`	`setMoveFiles(boolean movefilesin)`
`void`	`setMoveToDirectory(String movetoin)`
`void`	`setOnlyGettingNewFiles(boolean onlyGettingNewFilesin)`
`void`	`setPassword(String password)`
`void`	`setPort(String port)`
`void`	`setProxyHost(String proxyHost)`
`void`	`setProxyPassword(String proxyPassword)`
`void`	`setProxyPort(String proxyPort)`
`void`	`setProxyUsername(String proxyUsername)`
`void`	`setRemove(boolean remove)`
`void`	`setServerName(String serverName)`
`void`	`setSpecifyFormat(boolean SpecifyFormat)`
`void`	`setSuccessCondition(String success_condition)`
`void`	`setTargetDirectory(String targetDirectory)`
`void`	`setTimeInFilename(boolean addtime)`
`void`	`setTimeout(int timeout)`
`void`	`setUserName(String userName)`
`void`	`setWildcard(String wildcard)`

Methods inherited from class 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

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - FILE_EXISTS_ACTIONS
```
public static final String[] FILE_EXISTS_ACTIONS
```
  - ifFileExistsSkip
```
public static final int ifFileExistsSkip
```
    See Also:
    
    Constant Field Values
  - ifFileExistsCreateUniq
```
public static final int ifFileExistsCreateUniq
```
    See Also:
    
    Constant Field Values
  - ifFileExistsFail
```
public static final int ifFileExistsFail
```
    See Also:
    
    Constant Field Values
  - 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_NO_ERRORS
```
public String SUCCESS_IF_NO_ERRORS
```
- Constructor Detail
  - JobEntryFTPSGet
```
public JobEntryFTPSGet(String n)
```
  - JobEntryFTPSGet
```
public JobEntryFTPSGet()
```
- 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<DatabaseMeta> databases,
                    List<SlaveServer> slaveServers,
                    Repository rep,
                    org.pentaho.metastore.api.IMetaStore metaStore)
             throws 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:
    
    KettleXMLException - if any errors occur during the loading of the XML
  - loadRep
```
public void loadRep(Repository rep,
                    org.pentaho.metastore.api.IMetaStore metaStore,
                    ObjectId id_jobentry,
                    List<DatabaseMeta> databases,
                    List<SlaveServer> slaveServers)
             throws 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:
    
    KettleException - if any errors occur during the load
  - saveRep
```
public void saveRep(Repository rep,
                    org.pentaho.metastore.api.IMetaStore metaStore,
                    ObjectId id_job)
             throws 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:
    
    KettleException - if any errors occur during the save
  - setLimit
```
public void setLimit(String nr_limitin)
```
  - getLimit
```
public String getLimit()
```
  - setSuccessCondition
```
public void setSuccessCondition(String success_condition)
```
  - getSuccessCondition
```
public String getSuccessCondition()
```
  - setCreateMoveFolder
```
public void setCreateMoveFolder(boolean createmovefolderin)
```
  - isCreateMoveFolder
```
public boolean isCreateMoveFolder()
```
  - setAddDateBeforeExtension
```
public void setAddDateBeforeExtension(boolean AddDateBeforeExtension)
```
  - isAddDateBeforeExtension
```
public boolean isAddDateBeforeExtension()
```
  - setAddToResult
```
public void setAddToResult(boolean isaddresultin)
```
  - isAddToResult
```
public boolean isAddToResult()
```
  - setDateInFilename
```
public void setDateInFilename(boolean adddate)
```
  - isDateInFilename
```
public boolean isDateInFilename()
```
  - setTimeInFilename
```
public void setTimeInFilename(boolean addtime)
```
  - isTimeInFilename
```
public boolean isTimeInFilename()
```
  - isSpecifyFormat
```
public boolean isSpecifyFormat()
```
  - setSpecifyFormat
```
public void setSpecifyFormat(boolean SpecifyFormat)
```
  - getDateTimeFormat
```
public String getDateTimeFormat()
```
  - setDateTimeFormat
```
public void setDateTimeFormat(String date_time_format)
```
  - isMoveFiles
```
public boolean isMoveFiles()
```
    Returns:
    
    Returns the movefiles.
  - setMoveFiles
```
public void setMoveFiles(boolean movefilesin)
```
    Parameters:
    
    movefilesin - The movefiles to set.
  - getMoveToDirectory
```
public String getMoveToDirectory()
```
    Returns:
    
    Returns the movetodirectory.
  - setMoveToDirectory
```
public void setMoveToDirectory(String movetoin)
```
    Parameters:
    
    movetoin - The movetodirectory to set.
  - isBinaryMode
```
public boolean isBinaryMode()
```
    Returns:
    
    Returns the binaryMode.
  - setBinaryMode
```
public void setBinaryMode(boolean binaryMode)
```
    Parameters:
    
    binaryMode - The binaryMode to set.
  - getFTPSDirectory
```
public String getFTPSDirectory()
```
    Returns:
    
    Returns the directory.
  - setFTPSDirectory
```
public void setFTPSDirectory(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.
  - getPort
```
public String getPort()
```
    Returns:
    
    Returns the port.
  - setPort
```
public void setPort(String port)
```
    Parameters:
    
    port - The port 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.
  - getTargetDirectory
```
public String getTargetDirectory()
```
    Returns:
    
    Returns the targetDirectory.
  - setTargetDirectory
```
public void setTargetDirectory(String targetDirectory)
```
    Parameters:
    
    targetDirectory - The targetDirectory to set.
  - setTimeout
```
public void setTimeout(int timeout)
```
    Parameters:
    
    timeout - The timeout to set.
  - getTimeout
```
public int getTimeout()
```
    Returns:
    
    Returns the timeout.
  - setRemove
```
public void setRemove(boolean remove)
```
    Parameters:
    
    remove - The remove to set.
  - getRemove
```
public boolean getRemove()
```
    Returns:
    
    Returns the remove.
  - isOnlyGettingNewFiles
```
public boolean isOnlyGettingNewFiles()
```
    Returns:
    
    Returns the onlyGettingNewFiles.
  - setOnlyGettingNewFiles
```
public void setOnlyGettingNewFiles(boolean onlyGettingNewFilesin)
```
    Parameters:
    
    onlyGettingNewFiles - The onlyGettingNewFiles to set.
  - getProxyHost
```
public String getProxyHost()
```
    Returns:
    
    Returns the hostname of the FTPS-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 FTPS-proxy.
  - setProxyPort
```
public void setProxyPort(String proxyPort)
```
    Parameters:
    
    proxyPort - The port of the FTPS-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.
  - getIfFileExists
```
public int getIfFileExists()
```
  - setIfFileExists
```
public void setIfFileExists(int ifFileExists)
```
  - getFileExistsAction
```
public static String getFileExistsAction(int actionId)
```
  - getFileExistsIndex
```
public static int getFileExistsIndex(String desc)
```
  - execute
```
public Result execute(Result previousResult,
                      int nr)
               throws 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:
    
    KettleException - if any Kettle exceptions occur
  - normalizePath
```
public String normalizePath(String path)
                     throws Exception
```
    normalize / to \ and remove trailing slashes from a path
    
    Parameters:
    
    path -
    
    Returns:
    
    normalized path
    
    Throws:
    
    Exception
  - 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
  - needsDownload
```
protected boolean needsDownload(String filename)
```
    See if the filename on the FTPS server needs downloading. The default is to check the presence of the file in the target directory. If you need other functionality, extend this class and build it into a plugin.
    
    Parameters:
    
    filename - The local filename to check
    
    remoteFileSize - The size of the remote file
    
    Returns:
    
    true if the file needs downloading
  - isActiveConnection
```
public boolean isActiveConnection()
```
    Returns:
    
    the activeConnection
  - getConnectionType
```
public int getConnectionType()
```
    Returns:
    
    the conenction type
  - setConnectionType
```
public void setConnectionType(int type)
```
    Parameters:
    
    connectionType - the connectionType to set
  - setActiveConnection
```
public void setActiveConnection(boolean passive)
```
    Parameters:
    
    activeConnection - the activeConnection to set
  - getResourceDependencies
```
public List<ResourceReference> getResourceDependencies(JobMeta jobMeta)
```
    Description copied from class: 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.
    
    Specified by:
    
    getResourceDependencies in interface JobEntryInterface
    
    Overrides:
    
    getResourceDependencies in class JobEntryBase
    
    Returns:
    
    an empty list of ResourceReferences
    
    See Also:
    
    ResourceReference
  - check
```
public void check(List<CheckResultInterface> remarks,
                  JobMeta jobMeta,
                  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

Class JobEntryFTPSGet

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class org.pentaho.di.job.entry.JobEntryBase

Methods inherited from class java.lang.Object

Methods inherited from interface org.pentaho.di.job.entry.JobEntryInterface

Field Detail

FILE_EXISTS_ACTIONS

ifFileExistsSkip

ifFileExistsCreateUniq

ifFileExistsFail

SUCCESS_IF_AT_LEAST_X_FILES_DOWNLOADED

SUCCESS_IF_ERRORS_LESS

SUCCESS_IF_NO_ERRORS

Constructor Detail

JobEntryFTPSGet

JobEntryFTPSGet

Method Detail

clone

getXML

loadXML

loadRep

saveRep

setLimit

getLimit

setSuccessCondition

getSuccessCondition

setCreateMoveFolder

isCreateMoveFolder

setAddDateBeforeExtension

isAddDateBeforeExtension

setAddToResult

isAddToResult

setDateInFilename

isDateInFilename

setTimeInFilename

isTimeInFilename

isSpecifyFormat

setSpecifyFormat

getDateTimeFormat

setDateTimeFormat

isMoveFiles

setMoveFiles

getMoveToDirectory

setMoveToDirectory

isBinaryMode

setBinaryMode

getFTPSDirectory

setFTPSDirectory

getPassword

setPassword

getServerName

setServerName

getPort

setPort

getUserName

setUserName

getWildcard

setWildcard

getTargetDirectory

setTargetDirectory

setTimeout

getTimeout

setRemove

getRemove

isOnlyGettingNewFiles

setOnlyGettingNewFiles

getProxyHost

setProxyHost

getProxyPassword

setProxyPassword

getProxyPort

setProxyPort

getProxyUsername

setProxyUsername

getIfFileExists

setIfFileExists

getFileExistsAction