|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.taleo.integration.client.step.BaseStep
com.taleo.integration.client.step.BaseCustomStep
com.taleo.integration.client.customstep.BaseCustomStep
com.taleo.integration.client.customstep.ftp.DownloadFtpStep
public class DownloadFtpStep
Processing step to download a file from an FTP server and make it the current file in the pipeline.
When using this step, the request file does not have to be specified when calling TCC. In fact, if one is specified, it will be ignored.
This step takes all parameters from its base class
BaseCustomStep
and the
following additional parameters:
retryInterval
between each attempt. It multiplies the last time
waited by this amount. For example. if retryInterval
is 10
seconds and the retry factor is 2, wait time will be successively 10, 20, 40
seconds and so on, until the maximum number of retries has been reached
(default: 1).This class is dependent on:
Here is an example of how to define this custom step in the TCC configuration file:
Field Summary | |
---|---|
protected String |
filename
The filename. |
protected String |
host
The FTP host. |
protected int |
nbRetries
The number of retries. |
protected String |
password
The FTP password (AES128 encrypyed or unencrypted). |
protected int |
port
The FTP port. |
protected String |
remoteDirectory
The FTP remote directory. |
protected int |
retryFactor
The retry factor. |
protected int |
retryInterval
The interval between retries, in seconds. |
protected String |
username
The FTP username. |
Fields inherited from class com.taleo.integration.client.customstep.BaseCustomStep |
---|
parameterNames |
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 |
Constructor Summary | |
---|---|
DownloadFtpStep()
Constructor without arguments. |
Method Summary | |
---|---|
void |
download(File localFile)
Download the file from the FTP server and put the result in the specified local file. |
void |
execute(com.taleo.ws.integration.client.Pipeline pipeline)
|
String |
getDescription()
|
String |
getFilename()
Get the filename. |
String |
getHost()
Get the FTP host. |
String |
getIdentifier()
|
String |
getName()
|
int |
getNbRetries()
Get the number of retries. |
String |
getPassword()
Get the FTP password. |
int |
getPort()
Get the FTP port. |
String |
getRemoteDirectory()
Get the FTP remote directory. |
int |
getRetryFactor()
Get the retry factor. |
int |
getRetryInterval()
Get the retry interval, in seconds. |
String |
getUsername()
Get the FTP username. |
void |
init(com.taleo.ws.integration.client.GlobalConfig config)
|
void |
setFilename(String filename)
Set the filename. |
void |
setHost(String host)
Set the FTP host. |
void |
setNbRetries(int nbRetries)
Set the number of retries. |
void |
setPassword(String password)
Set the FTP password. |
void |
setPort(int port)
Set the FTP port. |
void |
setRemoteDirectory(String remoteDirectory)
Set the FTP remote directory. |
void |
setRetryFactor(int retryFactor)
Set the retry factor. |
void |
setRetryInterval(int retryInterval)
Set the retry interval, in seconds. |
void |
setUsername(String username)
Set the FTP username. |
Methods inherited from class com.taleo.integration.client.customstep.BaseCustomStep |
---|
getEncoding, isActive, registerParameterName, setActive, setEncoding, validateParameterNames |
Methods inherited from class com.taleo.integration.client.step.BaseCustomStep |
---|
getSupportedPipeline, getType, init |
Methods inherited from class com.taleo.integration.client.step.BaseStep |
---|
getAllProcessSupportPipeline, getCurrentFile, getCurrentFile, getCurrentMessage, getPostProcessSupportPipeline, getPreProcessSupportPipeline, 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 |
Field Detail |
---|
protected String host
protected int port
protected String username
protected String password
protected String remoteDirectory
protected String filename
protected int nbRetries
protected int retryInterval
protected int retryFactor
Constructor Detail |
---|
public DownloadFtpStep()
Method Detail |
---|
public String getHost()
public void setHost(String host)
host
- public String getPassword()
public void setPassword(String password)
password
- public int getPort()
public void setPort(int port)
port
- public String getRemoteDirectory()
public void setRemoteDirectory(String remoteDirectory)
remoteDirectory
- public String getUsername()
public void setUsername(String username)
username
- public String getFilename()
public void setFilename(String filename)
filename
- public int getNbRetries()
public void setNbRetries(int nbRetries)
nbRetries
- public int getRetryInterval()
public void setRetryInterval(int retryInterval)
retryInterval
- public int getRetryFactor()
public void setRetryFactor(int retryFactor)
retryFactor
- public String getIdentifier()
getIdentifier
in interface com.taleo.integration.client.step.CustomStep
getIdentifier
in interface com.taleo.integration.client.step.Step
getIdentifier
in class com.taleo.integration.client.step.BaseCustomStep
public String getDescription()
getDescription
in interface com.taleo.integration.client.step.CustomStep
getDescription
in interface com.taleo.integration.client.step.Step
getDescription
in class com.taleo.integration.client.step.BaseCustomStep
public String getName()
getName
in interface com.taleo.integration.client.step.CustomStep
getName
in interface com.taleo.integration.client.step.Step
getName
in class com.taleo.integration.client.step.BaseCustomStep
public void init(com.taleo.ws.integration.client.GlobalConfig config)
init
in class BaseCustomStep
public void execute(com.taleo.ws.integration.client.Pipeline pipeline) throws com.taleo.integration.client.step.StepException
com.taleo.integration.client.step.StepException
public void download(File localFile) throws Exception
localFile
- The local file to contain the downloaded data.
Exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |