|
||||||||||
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
public abstract class BaseFtpStep
Abstract class for FTP steps.
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:
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. |
java.lang.String |
PROXY_TYPE_FTP
|
java.lang.String |
PROXY_TYPE_HTTP
|
java.lang.String |
PROXY_TYPE_NONE
The proxy types. |
protected java.lang.String |
proxyHost
The proxy host. |
protected java.lang.String |
proxyPassword
The proxy password (AES128 encrypted or clear). |
protected int |
proxyPort
The proxy port. |
protected java.lang.String |
proxyType
The proxy type. |
protected java.lang.String |
proxyUsername
The proxy username. |
protected java.lang.String |
remoteDirectory
The FTP remote directory. |
protected int |
retryFactor
The retry factor. |
protected int |
retryInterval
The interval between retries, in seconds. |
java.lang.String |
TRANSFER_MODE_ACTIVE
The transfer modes. |
java.lang.String |
TRANSFER_MODE_PASSIVE
|
int |
TRANSFER_TYPE_ASCII
|
int |
TRANSFER_TYPE_BINARY
The transfer types. |
protected java.lang.String |
transferMode
The transfer mode. |
protected int |
transferType
The transfer type. |
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 | |
---|---|
BaseFtpStep()
Constructor without arguments. |
Method Summary | |
---|---|
protected org.apache.commons.net.ftp.FTPClient |
getFtpClient()
Get the FTP Client. |
java.lang.String |
getHost()
Get the FTP host. |
int |
getNbRetries()
Get the number of retries. |
java.lang.String |
getPassword()
Get the FTP password. |
int |
getPort()
Get the FTP port. |
java.lang.String |
getProxyHost()
Get the proxy host. |
java.lang.String |
getProxyPassword()
Get the proxy password. |
int |
getProxyPort()
Get the proxy port. |
java.lang.String |
getProxyType()
Get the proxy type. |
java.lang.String |
getProxyUsername()
Get the proxy username. |
java.lang.String |
getRemoteDirectory()
Get the FTP remote directory. |
int |
getRetryFactor()
Get the retry factor. |
int |
getRetryInterval()
Get the retry interval, in seconds. |
java.lang.String |
getTransferMode()
Get the transfer mode. |
int |
getTransferType()
Get the transfer type. |
java.lang.String |
getUsername()
Get the FTP username. |
void |
init(com.taleo.ws.integration.client.GlobalConfig config)
|
protected void |
logout()
Log out the FTP Client. |
void |
setHost(java.lang.String host)
Set the FTP host. |
void |
setNbRetries(int nbRetries)
Set the number of retries. |
void |
setPassword(java.lang.String password)
Set the FTP password. |
void |
setPort(int port)
Set the FTP port. |
void |
setProxyHost(java.lang.String proxyHost)
Set the proxy host. |
void |
setProxyPassword(java.lang.String proxyPassword)
Set the proxy password. |
void |
setProxyPort(int proxyPort)
Set the proxy port. |
void |
setProxyType(java.lang.String proxyType)
Set the proxy type. |
void |
setProxyUsername(java.lang.String proxyUsername)
Set the proxy username. |
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 |
setTransferMode(java.lang.String transferMode)
Set the transfer mode (TRANSFER_MODE_ACTIVE or TRANSFER_MODE_PASSIVE). |
void |
setTransferType(int transferType)
Set the transfer type (TRANSFER_TYPE_BINARY or TRANSFER_TYPE_ASCII). |
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 |
---|
public final int TRANSFER_TYPE_BINARY
public final int TRANSFER_TYPE_ASCII
public final java.lang.String TRANSFER_MODE_ACTIVE
public final java.lang.String TRANSFER_MODE_PASSIVE
public final java.lang.String PROXY_TYPE_NONE
public final java.lang.String PROXY_TYPE_FTP
public final java.lang.String PROXY_TYPE_HTTP
protected java.lang.String host
protected int port
protected java.lang.String username
protected java.lang.String password
protected java.lang.String remoteDirectory
protected int nbRetries
protected int retryInterval
protected int retryFactor
protected int transferType
protected java.lang.String transferMode
protected java.lang.String proxyType
protected java.lang.String proxyHost
protected int proxyPort
protected java.lang.String proxyUsername
protected java.lang.String proxyPassword
Constructor Detail |
---|
public BaseFtpStep()
Method Detail |
---|
public java.lang.String getHost()
public void setHost(java.lang.String host)
host
- public java.lang.String getPassword()
public void setPassword(java.lang.String password)
password
- public int getPort()
public void setPort(int port)
port
- public java.lang.String getRemoteDirectory()
public void setRemoteDirectory(java.lang.String remoteDirectory)
remoteDirectory
- public java.lang.String getUsername()
public void setUsername(java.lang.String username)
username
- 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 int getTransferType()
public void setTransferType(int transferType)
transferType
- public java.lang.String getTransferMode()
public void setTransferMode(java.lang.String transferMode)
transferMode
- public java.lang.String getProxyType()
public void setProxyType(java.lang.String proxyType)
proxyType
- public java.lang.String getProxyHost()
public void setProxyHost(java.lang.String proxyHost)
proxyHost
- public int getProxyPort()
public void setProxyPort(int proxyPort)
proxyPort
- public java.lang.String getProxyUsername()
public void setProxyUsername(java.lang.String proxyUsername)
proxyUsername
- public java.lang.String getProxyPassword()
public void setProxyPassword(java.lang.String proxyPassword)
proxyPassword
- public void init(com.taleo.ws.integration.client.GlobalConfig config)
init
in class BaseCustomStep
protected org.apache.commons.net.ftp.FTPClient getFtpClient() throws java.io.IOException
java.io.IOException
FTPException
FTPIllegalReplyException
protected void logout()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |