com.taleo.integration.client.customstep.ftp
Class DownloadSftpStep

java.lang.Object
  extended by com.taleo.integration.client.step.BaseStep
      extended by com.taleo.integration.client.step.BaseCustomStep
          extended by com.taleo.integration.client.customstep.BaseCustomStep
              extended by com.taleo.integration.client.customstep.ftp.DownloadFtpStep
                  extended by com.taleo.integration.client.customstep.ftp.DownloadSftpStep
All Implemented Interfaces:
com.taleo.integration.client.step.CustomStep, com.taleo.integration.client.step.Step

public class DownloadSftpStep
extends DownloadFtpStep

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 DownloadFtpStep and the following additional parameters:

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
 
Fields inherited from class com.taleo.integration.client.customstep.ftp.DownloadFtpStep
filename, host, nbRetries, password, port, remoteDirectory, retryFactor, retryInterval, 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
DownloadSftpStep()
          Constructor without arguments.
 
Method Summary
 void download(File localFile)
          Download the file from the SFTP server and put the result in the specified local file.
 String getDescription()
           
 String getIdentifier()
           
 String getName()
           
 String getPassphrase()
          Get the passphrase.
 String getPrivateKey()
          Get the private key.
 void init(com.taleo.ws.integration.client.GlobalConfig config)
           
 void setPassphrase(String passphrase)
          Set the passphrase.
 void setPrivateKey(String privateKey)
          Set the private key.
 
Methods inherited from class com.taleo.integration.client.customstep.ftp.DownloadFtpStep
execute, getFilename, getHost, getNbRetries, getPassword, getPort, getRemoteDirectory, getRetryFactor, getRetryInterval, getUsername, setFilename, setHost, setNbRetries, setPassword, setPort, setRemoteDirectory, setRetryFactor, setRetryInterval, setUsername
 
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
 

Constructor Detail

DownloadSftpStep

public DownloadSftpStep()
Constructor without arguments.

Method Detail

getIdentifier

public String getIdentifier()
Specified by:
getIdentifier in interface com.taleo.integration.client.step.CustomStep
Specified by:
getIdentifier in interface com.taleo.integration.client.step.Step
Overrides:
getIdentifier in class DownloadFtpStep

getDescription

public String getDescription()
Specified by:
getDescription in interface com.taleo.integration.client.step.CustomStep
Specified by:
getDescription in interface com.taleo.integration.client.step.Step
Overrides:
getDescription in class DownloadFtpStep

getName

public String getName()
Specified by:
getName in interface com.taleo.integration.client.step.CustomStep
Specified by:
getName in interface com.taleo.integration.client.step.Step
Overrides:
getName in class DownloadFtpStep

getPrivateKey

public String getPrivateKey()
Get the private key.

Returns:

setPrivateKey

public void setPrivateKey(String privateKey)
Set the private key.

Parameters:
privateKey -

getPassphrase

public String getPassphrase()
Get the passphrase.

Returns:

setPassphrase

public void setPassphrase(String passphrase)
Set the passphrase.

Parameters:
passphrase -

init

public void init(com.taleo.ws.integration.client.GlobalConfig config)
Overrides:
init in class DownloadFtpStep

download

public void download(File localFile)
              throws Exception
Download the file from the SFTP server and put the result in the specified local file.

Overrides:
download in class DownloadFtpStep
Parameters:
localFile - The local file to contain the downloaded data.
Throws:
Exception