|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface TransferController
This interface defines contract the TransferController classes must implement. TransferController allows both synchronous and asynchronous transfer. Synchronous transfer means TransferController blocks until it gets a response. Asynchronous transfer means that TransferController doesn't block (fire and forget) and response will be received later through notification. Synchronous transfer is used for short time transfer (e.g. FTP LS command). It should not run in a thread. Asynchronous transfer is used for long time transfer (e.g. FTP PUT command). It should run in a thread.
Field Summary | |
---|---|
static int |
COMPLETED_STATUS
|
static int |
MAX_AUTH_ATTEMPTS
|
static java.lang.String |
PREPROCESSING_FILTER
|
static int |
RUNNING_STATUS
|
static int |
WAITING_STATUS
|
Method Summary | |
---|---|
void |
addChecksumListener(ChecksumListener listener)
|
void |
addCompressListener(CompressListener listener)
|
void |
addFilterListener(FilterListener listener)
|
void |
addProtocolListener(ProtocolListener listener)
|
void |
addSplitListener(SplitListener listener)
|
void |
addTransferListener(TransferListener listener)
|
void |
begin()
Start (fire and forget) asynchroneous transfer. |
void |
cancel()
Cancel transfer. |
java.lang.Object |
execute()
Start synchroneous transfer. |
java.lang.String |
getAuthentication()
|
java.lang.String |
getBlackList()
|
java.util.List |
getChecksumListeners()
|
long |
getChunkSize()
|
java.util.List |
getCompressListeners()
|
java.lang.String |
getEncoding()
|
java.lang.Object |
getExt()
|
TransferFilter |
getFilter()
Return default TransferFilter. |
TransferFilter |
getFilter(java.lang.String filterid)
Get TransferFilter for a given identifier. |
java.lang.String |
getFilterChain()
|
java.util.List |
getFilterIDs()
Return all filter identifiers. |
java.lang.String |
getFilterImpl()
Return the default filter implementation. |
java.lang.String |
getFilterImpl(java.lang.String filterid)
Return filter implementation for a given identifier. |
java.util.List |
getFilterListeners()
|
java.lang.String |
getHidden()
|
long |
getMaxDepth()
|
long |
getMaxFiles()
|
long |
getMaxSize()
|
long |
getMinSize()
|
java.lang.String |
getOverwrite()
|
java.util.HashMap |
getParameters(java.lang.String section)
|
java.lang.String |
getParamFile()
|
java.lang.String |
getPassword()
|
java.lang.String |
getPolicy()
|
TransferFilter |
getPreProcessingFilter()
Return PreProcessing TransferFilter. |
java.lang.String |
getPreProcessingFilterImpl()
Return the pre-processing filter implementation. |
java.util.List |
getProtocolListeners()
|
Conf |
getRawConf()
|
java.lang.String |
getResume()
|
long |
getResumeOffset()
|
int |
getRetry()
|
int |
getRetryDelay()
|
java.net.URL |
getServerUrl()
|
java.util.List |
getSource()
|
java.util.List |
getSplitListeners()
|
int |
getStatus()
|
java.util.List |
getTarget()
|
java.lang.String |
getTemplate()
|
long |
getTimeOut()
Returns underlying socket timeout. |
java.lang.String |
getTmpDir()
|
java.util.List |
getTransferListeners()
|
java.lang.String |
getUsername()
|
java.lang.String |
getWhiteList()
|
java.lang.String |
getZipFolder()
|
java.lang.String |
getZipIgnoreList()
|
long |
getZipMaxSize()
|
java.lang.String |
getZipOnFly()
|
void |
init()
Initialize transfer. |
boolean |
isThreaded()
|
void |
removeChecksumListener(ChecksumListener listener)
|
void |
removeCompressListener(CompressListener listener)
|
void |
removeFilterListener(FilterListener listener)
|
void |
removeProtocolListener(ProtocolListener listener)
|
void |
removeSplitListener(SplitListener listener)
|
void |
removeTransferListener(TransferListener listener)
|
void |
setAuthentication(java.lang.String authentication)
|
void |
setBlackList(java.lang.String lst)
|
void |
setChunkSize(long size)
|
void |
setEncoding(java.lang.String enc)
|
void |
setExt(java.lang.Object ext)
|
void |
setFilter(TransferFilter filter)
Set default TransferFilter. |
void |
setFilter(TransferFilter filter,
java.lang.String filterid)
Set TransferFilter for a given identifier. |
void |
setFilterChain(java.lang.String chain)
|
void |
setFilterIDs(java.util.List filterimpls)
Set all filter identifiers. |
void |
setFilterImpl(java.lang.String filterimpl)
Set the default filter implementation |
void |
setFilterImpl(java.lang.String filterimpl,
java.lang.String filterid)
Set Filter implementation for a given identifier |
void |
setHidden(java.lang.String hidden)
|
void |
setMaxDepth(long amount)
|
void |
setMaxFiles(long amount)
|
void |
setMaxSize(long size)
|
void |
setMinSize(long size)
|
void |
setOverwrite(java.lang.String overwrite)
|
void |
setParameters(java.util.HashMap params)
|
void |
setParamFile(java.lang.String param)
|
void |
setPassword(java.lang.String password)
|
void |
setPolicy(java.lang.String policy)
|
void |
setPreProcessingFilter(TransferFilter filter)
Set PreProcessing TransferFilter. |
void |
setPreProcessingFilterImpl(java.lang.String filterimpl)
Set the pre-processing filter implementation |
void |
setRawConf(Conf rawconf)
|
void |
setResume(java.lang.String resume)
|
void |
setRetry(int c)
|
void |
setRetryDelay(int delay)
|
void |
setServerUrl(java.net.URL url)
|
void |
setSource(java.util.List src)
|
void |
setStatus(int status)
|
void |
setTarget(java.util.List tar)
|
void |
setTemplate(java.lang.String template)
|
void |
setThreaded(boolean threaded)
|
void |
setTimeOut(long timeout)
Set socket timeout in milliseconds. |
void |
setTmpDir(java.lang.String folder)
|
void |
setUsername(java.lang.String login)
|
void |
setWhiteList(java.lang.String lst)
|
void |
setZipFolder(java.lang.String enabled)
|
void |
setZipIgnoreList(java.lang.String lst)
|
void |
setZipMaxSize(long size)
|
void |
setZipOnFly(java.lang.String zip)
|
Field Detail |
---|
static final int MAX_AUTH_ATTEMPTS
static final int WAITING_STATUS
static final int RUNNING_STATUS
static final int COMPLETED_STATUS
static final java.lang.String PREPROCESSING_FILTER
Method Detail |
---|
void setServerUrl(java.net.URL url)
java.net.URL getServerUrl()
void setSource(java.util.List src)
java.util.List getSource()
void setTarget(java.util.List tar)
java.util.List getTarget()
void setExt(java.lang.Object ext)
java.lang.Object getExt()
java.lang.String getUsername()
void setUsername(java.lang.String login)
java.lang.String getPassword()
void setPassword(java.lang.String password)
void setWhiteList(java.lang.String lst)
java.lang.String getWhiteList()
void setBlackList(java.lang.String lst)
java.lang.String getBlackList()
void setZipIgnoreList(java.lang.String lst)
java.lang.String getZipIgnoreList()
void setZipFolder(java.lang.String enabled)
java.lang.String getZipFolder()
void setZipMaxSize(long size)
long getZipMaxSize()
void setMaxSize(long size)
long getMaxSize()
void setMinSize(long size)
long getMinSize()
void setMaxFiles(long amount)
long getMaxFiles()
void setPolicy(java.lang.String policy)
java.lang.String getPolicy()
void setTemplate(java.lang.String template)
java.lang.String getTemplate()
void setOverwrite(java.lang.String overwrite)
java.lang.String getOverwrite()
void setResume(java.lang.String resume)
java.lang.String getResume()
long getResumeOffset()
void setAuthentication(java.lang.String authentication)
java.lang.String getAuthentication()
void setHidden(java.lang.String hidden)
java.lang.String getHidden()
void setZipOnFly(java.lang.String zip)
java.lang.String getZipOnFly()
void setMaxDepth(long amount)
long getMaxDepth()
void setChunkSize(long size)
long getChunkSize()
void setEncoding(java.lang.String enc)
java.lang.String getEncoding()
void setParamFile(java.lang.String param)
java.lang.String getParamFile()
void setTmpDir(java.lang.String folder)
java.lang.String getTmpDir()
void setTimeOut(long timeout)
timeout
- long getTimeOut()
int getRetry()
void setRetry(int c)
int getRetryDelay()
void setRetryDelay(int delay)
void setParameters(java.util.HashMap params)
java.util.HashMap getParameters(java.lang.String section)
java.lang.String getPreProcessingFilterImpl()
void setPreProcessingFilterImpl(java.lang.String filterimpl)
filterimpl
- TransferFilter getPreProcessingFilter()
void setPreProcessingFilter(TransferFilter filter)
filter
- java.util.List getFilterIDs()
void setFilterIDs(java.util.List filterimpls)
filterimpls
- java.lang.String getFilterImpl()
void setFilterImpl(java.lang.String filterimpl)
filterimpl
- java.lang.String getFilterImpl(java.lang.String filterid)
filterid
-
void setFilterImpl(java.lang.String filterimpl, java.lang.String filterid)
filterimpl
- filterid
- TransferFilter getFilter()
void setFilter(TransferFilter filter)
filter
- TransferFilter getFilter(java.lang.String filterid)
filterid
-
void setFilter(TransferFilter filter, java.lang.String filterid)
filter
- filterid
- java.lang.String getFilterChain()
void setFilterChain(java.lang.String chain)
Conf getRawConf()
void setRawConf(Conf rawconf)
boolean isThreaded()
void setThreaded(boolean threaded)
int getStatus()
void setStatus(int status)
void init() throws ClientException
ClientException
java.lang.Object execute() throws ClientException
ClientException
void begin()
void cancel()
void addTransferListener(TransferListener listener)
void removeTransferListener(TransferListener listener)
java.util.List getTransferListeners()
void addSplitListener(SplitListener listener)
void removeSplitListener(SplitListener listener)
java.util.List getSplitListeners()
void addCompressListener(CompressListener listener)
void removeCompressListener(CompressListener listener)
java.util.List getCompressListeners()
void addFilterListener(FilterListener listener)
void removeFilterListener(FilterListener listener)
java.util.List getFilterListeners()
void addProtocolListener(ProtocolListener listener)
void removeProtocolListener(ProtocolListener listener)
java.util.List getProtocolListeners()
void addChecksumListener(ChecksumListener listener)
void removeChecksumListener(ChecksumListener listener)
java.util.List getChecksumListeners()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |