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

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.BaseFtpStep
                  extended by com.taleo.integration.client.customstep.ftp.UploadFtpStep
All Implemented Interfaces:
com.taleo.integration.client.step.CustomStep, com.taleo.integration.client.step.Step

public class UploadFtpStep
extends BaseFtpStep

Processing step to upload files on an FTP server.

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

This class is dependent on:

Here are 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.
protected  java.lang.String filePattern
          The file pattern.
 
Fields inherited from class com.taleo.integration.client.customstep.ftp.BaseFtpStep
host, nbRetries, password, port, PROXY_TYPE_FTP, PROXY_TYPE_HTTP, PROXY_TYPE_NONE, proxyHost, proxyPassword, proxyPort, proxyType, proxyUsername, remoteDirectory, retryFactor, retryInterval, TRANSFER_MODE_ACTIVE, TRANSFER_MODE_PASSIVE, TRANSFER_TYPE_ASCII, TRANSFER_TYPE_BINARY, transferMode, transferType, 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
UploadFtpStep()
          Constructor without arguments.
 
Method Summary
protected  void doUpload(org.apache.commons.net.ftp.FTPClient ftp, java.io.File file, java.lang.String remoteDirectory, java.lang.String remoteFilename)
          Private method to upload the file to the FTP server.
 void execute(com.taleo.ws.integration.client.Pipeline pipeline)
           
 java.lang.String getDescription()
           
 java.lang.String getFilename()
          Get the filename.
 java.lang.String getFilePattern()
          Get the file pattern.
 java.lang.String getIdentifier()
           
 java.lang.String getName()
           
 void init(com.taleo.ws.integration.client.GlobalConfig config)
           
 void setFilename(java.lang.String filename)
          Set the filename.
 void setFilePattern(java.lang.String filePattern)
          Set the file pattern.
 void upload(java.io.File file, java.lang.String remoteDirectory, java.lang.String remoteFilename)
          Upload a file to the FTP server in the given remote directory and with the provided name.
 
Methods inherited from class com.taleo.integration.client.customstep.ftp.BaseFtpStep
getFtpClient, getHost, getNbRetries, getPassword, getPort, getProxyHost, getProxyPassword, getProxyPort, getProxyType, getProxyUsername, getRemoteDirectory, getRetryFactor, getRetryInterval, getTransferMode, getTransferType, getUsername, logout, setHost, setNbRetries, setPassword, setPort, setProxyHost, setProxyPassword, setProxyPort, setProxyType, setProxyUsername, setRemoteDirectory, setRetryFactor, setRetryInterval, setTransferMode, setTransferType, setUsername
 
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
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
validatePipeline
 

Field Detail

filename

protected java.lang.String filename
The filename.


filePattern

protected java.lang.String filePattern
The file pattern.

Constructor Detail

UploadFtpStep

public UploadFtpStep()
Constructor without arguments.

Method Detail

getFilename

public java.lang.String getFilename()
Get the filename.

Returns:

setFilename

public void setFilename(java.lang.String filename)
Set the filename.

Parameters:
filename -

getFilePattern

public java.lang.String getFilePattern()
Get the file pattern.

Returns:

setFilePattern

public void setFilePattern(java.lang.String filePattern)
Set the file pattern.

Parameters:
filePattern -

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 BaseFtpStep

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

upload

public void upload(java.io.File file,
                   java.lang.String remoteDirectory,
                   java.lang.String remoteFilename)
            throws java.lang.Exception
Upload a file to the FTP server in the given remote directory and with the provided name.

Parameters:
file - The file to upload.
remoteDirectory - The remote directory.
remoteFilename - The remote file name.
Throws:
java.lang.Exception

doUpload

protected void doUpload(org.apache.commons.net.ftp.FTPClient ftp,
                        java.io.File file,
                        java.lang.String remoteDirectory,
                        java.lang.String remoteFilename)
                 throws java.lang.Exception
Private method to upload the file to the FTP server. Does not logout, calling method must do it.

Parameters:
ftp - The FTP client.
file - The file to upload.
remoteDirectory - The remote directory.
remoteFilename - The remote file name.
Throws:
java.lang.Exception