|
||||||||||
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.BaseFtpStep
com.taleo.integration.client.customstep.ftp.UploadFtpStep
public class UploadFtpStep
Processing step to upload files on an FTP server.
This step takes all parameters from its base class
BaseFtpStep
and the
following additional parameters:
WildcardFileFilter
, in
the file names only. Pattern is case sensitive. If the pattern includes
multiple files, all of them will be uploaded in sequence. If absent, only the
current workflow file will be uploaded.
Multiple patterns can be set by separating them with a pipe (|). The special dot (.) pattern represents the current workflow file.
If multiple file patterns are provided, correspondingly multiple remote directories cans be set too, using the same pipe (|) delimiter. If the number of patterns is larger than the number of remote directories, the last directory will be used for remaining patterns.
This class is dependent on:
Here are examples of how to define this custom step in the TCC configuration file:
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 |
---|
protected java.lang.String filename
protected java.lang.String filePattern
Constructor Detail |
---|
public UploadFtpStep()
Method Detail |
---|
public java.lang.String getFilename()
public void setFilename(java.lang.String filename)
filename
- public java.lang.String getFilePattern()
public void setFilePattern(java.lang.String filePattern)
filePattern
- public java.lang.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 java.lang.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 java.lang.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 BaseFtpStep
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 upload(java.io.File file, java.lang.String remoteDirectory, java.lang.String remoteFilename) throws java.lang.Exception
file
- The file to upload.remoteDirectory
- The remote directory.remoteFilename
- The remote file name.
java.lang.Exception
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
ftp
- The FTP client.file
- The file to upload.remoteDirectory
- The remote directory.remoteFilename
- The remote file name.
java.lang.Exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |