com.taleo.integration.client.customstep.ftp
Class DownloadSftpPreStep
java.lang.Object
com.taleo.integration.client.step.BaseStep
com.taleo.integration.client.step.BaseCustomStep
com.taleo.integration.client.customstep.BaseCustomStep
com.taleo.integration.client.customstep.ftp.BaseSftpStep
com.taleo.integration.client.customstep.ftp.DownloadSftpPreStep
- All Implemented Interfaces:
- com.taleo.integration.client.step.CustomStep, com.taleo.integration.client.step.Step
public class DownloadSftpPreStep
- extends BaseSftpStep
Processing step to download a file from an SFTP server and make it the
current file in the pipeline.
This step takes all parameters from its base class
BaseSftpStep
and the
following additional parameters:
- filename: The filename to get from the FTP server.
This class is dependent on:
Here are two examples of how to define this custom step in the TCC
configuration file:
- Author:
- Romain Guay, Taleo Corporation
Field Summary |
protected java.lang.String |
filename
The filename. |
Fields inherited from class com.taleo.integration.client.step.BaseCustomStep |
parameters |
Fields inherited from class com.taleo.integration.client.step.BaseStep |
commType, ERROR_NULL_GLOBAL_CONFIG, ERROR_NULL_PIPELINE, ERROR_NULL_STEP_CONFIG, productCode, tempFolder, type, version |
Method Summary |
void |
download(java.io.File localFile)
Download the file from the SFTP server and put the result in the
specified local file. |
void |
execute(com.taleo.ws.integration.client.Pipeline pipeline)
|
java.lang.String |
getDescription()
|
java.lang.String |
getFilename()
Get the filename. |
java.lang.String |
getIdentifier()
|
java.lang.String |
getName()
|
com.taleo.ws.integration.client.SupportedPipeline |
getSupportedPipeline()
|
void |
init(com.taleo.ws.integration.client.GlobalConfig config)
|
void |
setFilename(java.lang.String filename)
Set the filename. |
Methods inherited from class com.taleo.integration.client.customstep.ftp.BaseSftpStep |
getHost, getNbRetries, getPassphrase, getPassword, getPort, getPrivateKey, getProxyHost, getProxyPort, getRemoteDirectory, getRetryFactor, getRetryInterval, getSftpChannel, getUsername, logout, setHost, setNbRetries, setPassphrase, setPassword, setPort, setPrivateKey, setProxyHost, setProxyPort, setRemoteDirectory, setRetryFactor, setRetryInterval, setUsername |
Methods inherited from class com.taleo.integration.client.step.BaseCustomStep |
getType, init |
Methods inherited from class com.taleo.integration.client.step.BaseStep |
getAllProcessSupportPipeline, getCurrentFile, getCurrentFile, getCurrentMessage, getPostProcessSupportPipeline, getPreProcessSupportPipeline, isOriginalFile, validateLastStepType, validateMessageType, validatePipeline |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.taleo.integration.client.step.Step |
validatePipeline |
filename
protected java.lang.String filename
- The filename.
DownloadSftpPreStep
public DownloadSftpPreStep()
- Constructor without arguments.
getFilename
public java.lang.String getFilename()
- Get the filename.
- Returns:
setFilename
public void setFilename(java.lang.String filename)
- Set the filename.
- Parameters:
filename
-
getIdentifier
public java.lang.String getIdentifier()
- Specified by:
getIdentifier
in interface com.taleo.integration.client.step.CustomStep
- Specified by:
getIdentifier
in interface com.taleo.integration.client.step.Step
- Specified by:
getIdentifier
in class com.taleo.integration.client.step.BaseCustomStep
getDescription
public java.lang.String getDescription()
- Specified by:
getDescription
in interface com.taleo.integration.client.step.CustomStep
- Specified by:
getDescription
in interface com.taleo.integration.client.step.Step
- Specified by:
getDescription
in class com.taleo.integration.client.step.BaseCustomStep
getName
public java.lang.String getName()
- Specified by:
getName
in interface com.taleo.integration.client.step.CustomStep
- Specified by:
getName
in interface com.taleo.integration.client.step.Step
- Specified by:
getName
in class com.taleo.integration.client.step.BaseCustomStep
init
public void init(com.taleo.ws.integration.client.GlobalConfig config)
- Overrides:
init
in class BaseSftpStep
getSupportedPipeline
public com.taleo.ws.integration.client.SupportedPipeline getSupportedPipeline()
- Specified by:
getSupportedPipeline
in interface com.taleo.integration.client.step.Step
- Overrides:
getSupportedPipeline
in class com.taleo.integration.client.step.BaseCustomStep
execute
public void execute(com.taleo.ws.integration.client.Pipeline pipeline)
throws com.taleo.integration.client.step.StepException
- Throws:
com.taleo.integration.client.step.StepException
download
public void download(java.io.File localFile)
throws java.lang.Exception
- Download the file from the SFTP server and put the result in the
specified local file.
- Parameters:
localFile
- The local file to contain the downloaded data.
- Throws:
java.lang.Exception