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

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.BaseSftpStep
All Implemented Interfaces:
com.taleo.integration.client.step.CustomStep, com.taleo.integration.client.step.Step
Direct Known Subclasses:
DeleteSftpStep, DownloadSftpPreStep, UploadSftpStep

public abstract class BaseSftpStep
extends BaseCustomStep

Abstract class for SFTP steps.

This step takes all parameters from its base class BaseCustomStep and the following additional parameters:

This class is dependent on:

Author:
Romain Guay, Oracle Corporation

Field Summary
protected  java.lang.String host
          The FTP host.
protected  int nbRetries
          The number of retries.
protected  java.lang.String password
          The FTP password (AES128 encrypted or clear).
protected  int port
          The FTP port.
protected  java.lang.String proxyHost
          The proxy host.
protected  int proxyPort
          The proxy port.
protected  java.lang.String remoteDirectory
          The FTP remote directory.
protected  int retryFactor
          The retry factor.
protected  int retryInterval
          The interval between retries, in seconds.
protected  java.lang.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
BaseSftpStep()
          Constructor without arguments.
 
Method Summary
 java.lang.String getHost()
          Get the FTP host.
 int getNbRetries()
          Get the number of retries.
 java.lang.String getPassphrase()
          Get the passphrase.
 java.lang.String getPassword()
          Get the FTP password.
 int getPort()
          Get the FTP port.
 java.lang.String getPrivateKey()
          Get the private key.
 java.lang.String getProxyHost()
          Get the proxy host.
 int getProxyPort()
          Get the proxy port.
 java.lang.String getRemoteDirectory()
          Get the FTP remote directory.
 int getRetryFactor()
          Get the retry factor.
 int getRetryInterval()
          Get the retry interval, in seconds.
protected  com.jcraft.jsch.ChannelSftp getSftpChannel()
          Get the SFTP channel.
 java.lang.String getUsername()
          Get the FTP username.
 void init(com.taleo.ws.integration.client.GlobalConfig config)
           
protected  void logout()
          Log out the SFTP Channel.
 void setHost(java.lang.String host)
          Set the FTP host.
 void setNbRetries(int nbRetries)
          Set the number of retries.
 void setPassphrase(java.lang.String passphrase)
          Set the passphrase.
 void setPassword(java.lang.String password)
          Set the FTP password.
 void setPort(int port)
          Set the FTP port.
 void setPrivateKey(java.lang.String privateKey)
          Set the private key.
 void setProxyHost(java.lang.String proxyHost)
          Set the proxy host.
 void setProxyPort(int proxyPort)
          Set the proxy port.
 void setRemoteDirectory(java.lang.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(java.lang.String username)
          Set the FTP username.
 
Methods inherited from class com.taleo.integration.client.customstep.BaseCustomStep
createTempFile, createTempFile, getEncoding, getTempFolder, isActive, registerParameterName, setActive, setEncoding, validateParameterNames
 
Methods inherited from class com.taleo.integration.client.step.BaseCustomStep
getDescription, getIdentifier, getName, getSupportedPipeline, 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
execute, validatePipeline
 

Field Detail

host

protected java.lang.String host
The FTP host.


port

protected int port
The FTP port.


username

protected java.lang.String username
The FTP username.


password

protected java.lang.String password
The FTP password (AES128 encrypted or clear).


remoteDirectory

protected java.lang.String remoteDirectory
The FTP remote directory.


nbRetries

protected int nbRetries
The number of retries.


retryInterval

protected int retryInterval
The interval between retries, in seconds.


retryFactor

protected int retryFactor
The retry factor.


proxyHost

protected java.lang.String proxyHost
The proxy host.


proxyPort

protected int proxyPort
The proxy port.

Constructor Detail

BaseSftpStep

public BaseSftpStep()
Constructor without arguments.

Method Detail

getHost

public java.lang.String getHost()
Get the FTP host.

Returns:

setHost

public void setHost(java.lang.String host)
Set the FTP host.

Parameters:
host -

getPassword

public java.lang.String getPassword()
Get the FTP password.

Returns:

setPassword

public void setPassword(java.lang.String password)
Set the FTP password.

Parameters:
password -

getPort

public int getPort()
Get the FTP port.

Returns:

setPort

public void setPort(int port)
Set the FTP port.

Parameters:
port -

getRemoteDirectory

public java.lang.String getRemoteDirectory()
Get the FTP remote directory.

Returns:

setRemoteDirectory

public void setRemoteDirectory(java.lang.String remoteDirectory)
Set the FTP remote directory.

Parameters:
remoteDirectory -

getUsername

public java.lang.String getUsername()
Get the FTP username.

Returns:

setUsername

public void setUsername(java.lang.String username)
Set the FTP username.

Parameters:
username -

getNbRetries

public int getNbRetries()
Get the number of retries.

Returns:

setNbRetries

public void setNbRetries(int nbRetries)
Set the number of retries.

Parameters:
nbRetries -

getRetryInterval

public int getRetryInterval()
Get the retry interval, in seconds.

Returns:

setRetryInterval

public void setRetryInterval(int retryInterval)
Set the retry interval, in seconds.

Parameters:
retryInterval -

getRetryFactor

public int getRetryFactor()
Get the retry factor.

Returns:

setRetryFactor

public void setRetryFactor(int retryFactor)
Set the retry factor.

Parameters:
retryFactor -

getPrivateKey

public java.lang.String getPrivateKey()
Get the private key.

Returns:

setPrivateKey

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

Parameters:
privateKey -

getPassphrase

public java.lang.String getPassphrase()
Get the passphrase.

Returns:

setPassphrase

public void setPassphrase(java.lang.String passphrase)
Set the passphrase.

Parameters:
passphrase -

getProxyHost

public java.lang.String getProxyHost()
Get the proxy host.

Returns:

setProxyHost

public void setProxyHost(java.lang.String proxyHost)
Set the proxy host.

Parameters:
proxyHost -

getProxyPort

public int getProxyPort()
Get the proxy port.

Returns:

setProxyPort

public void setProxyPort(int proxyPort)
Set the proxy port.

Parameters:
proxyPort -

init

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

getSftpChannel

protected com.jcraft.jsch.ChannelSftp getSftpChannel()
                                              throws com.jcraft.jsch.JSchException,
                                                     java.io.IOException
Get the SFTP channel.

Returns:
The open SFTP channel.
Throws:
java.io.IOException
com.jcraft.jsch.JSchException

logout

protected void logout()
Log out the SFTP Channel.