jfileupload.transfer.client.core
Interface TransferController

All Known Implementing Classes:
AbstractTransferController, FTPTransfer, FTPUploadTransfer, HTTPTransfer, HTTPUploadTransfer

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

MAX_AUTH_ATTEMPTS

static final int MAX_AUTH_ATTEMPTS
See Also:
Constant Field Values

WAITING_STATUS

static final int WAITING_STATUS
See Also:
Constant Field Values

RUNNING_STATUS

static final int RUNNING_STATUS
See Also:
Constant Field Values

COMPLETED_STATUS

static final int COMPLETED_STATUS
See Also:
Constant Field Values

PREPROCESSING_FILTER

static final java.lang.String PREPROCESSING_FILTER
See Also:
Constant Field Values
Method Detail

setServerUrl

void setServerUrl(java.net.URL url)

getServerUrl

java.net.URL getServerUrl()

setSource

void setSource(java.util.List src)

getSource

java.util.List getSource()

setTarget

void setTarget(java.util.List tar)

getTarget

java.util.List getTarget()

setExt

void setExt(java.lang.Object ext)

getExt

java.lang.Object getExt()

getUsername

java.lang.String getUsername()

setUsername

void setUsername(java.lang.String login)

getPassword

java.lang.String getPassword()

setPassword

void setPassword(java.lang.String password)

setWhiteList

void setWhiteList(java.lang.String lst)

getWhiteList

java.lang.String getWhiteList()

setBlackList

void setBlackList(java.lang.String lst)

getBlackList

java.lang.String getBlackList()

setZipIgnoreList

void setZipIgnoreList(java.lang.String lst)

getZipIgnoreList

java.lang.String getZipIgnoreList()

setZipFolder

void setZipFolder(java.lang.String enabled)

getZipFolder

java.lang.String getZipFolder()

setZipMaxSize

void setZipMaxSize(long size)

getZipMaxSize

long getZipMaxSize()

setMaxSize

void setMaxSize(long size)

getMaxSize

long getMaxSize()

setMinSize

void setMinSize(long size)

getMinSize

long getMinSize()

setMaxFiles

void setMaxFiles(long amount)

getMaxFiles

long getMaxFiles()

setPolicy

void setPolicy(java.lang.String policy)

getPolicy

java.lang.String getPolicy()

setTemplate

void setTemplate(java.lang.String template)

getTemplate

java.lang.String getTemplate()

setOverwrite

void setOverwrite(java.lang.String overwrite)

getOverwrite

java.lang.String getOverwrite()

setResume

void setResume(java.lang.String resume)

getResume

java.lang.String getResume()

getResumeOffset

long getResumeOffset()

setAuthentication

void setAuthentication(java.lang.String authentication)

getAuthentication

java.lang.String getAuthentication()

setHidden

void setHidden(java.lang.String hidden)

getHidden

java.lang.String getHidden()

setZipOnFly

void setZipOnFly(java.lang.String zip)

getZipOnFly

java.lang.String getZipOnFly()

setMaxDepth

void setMaxDepth(long amount)

getMaxDepth

long getMaxDepth()

setChunkSize

void setChunkSize(long size)

getChunkSize

long getChunkSize()

setEncoding

void setEncoding(java.lang.String enc)

getEncoding

java.lang.String getEncoding()

setParamFile

void setParamFile(java.lang.String param)

getParamFile

java.lang.String getParamFile()

setTmpDir

void setTmpDir(java.lang.String folder)

getTmpDir

java.lang.String getTmpDir()

setTimeOut

void setTimeOut(long timeout)
Set socket timeout in milliseconds.

Parameters:
timeout -

getTimeOut

long getTimeOut()
Returns underlying socket timeout.

Returns:
timeout in milliseconds.

getRetry

int getRetry()

setRetry

void setRetry(int c)

getRetryDelay

int getRetryDelay()

setRetryDelay

void setRetryDelay(int delay)

setParameters

void setParameters(java.util.HashMap params)

getParameters

java.util.HashMap getParameters(java.lang.String section)

getPreProcessingFilterImpl

java.lang.String getPreProcessingFilterImpl()
Return the pre-processing filter implementation.

Returns:

setPreProcessingFilterImpl

void setPreProcessingFilterImpl(java.lang.String filterimpl)
Set the pre-processing filter implementation

Parameters:
filterimpl -

getPreProcessingFilter

TransferFilter getPreProcessingFilter()
Return PreProcessing TransferFilter.

Returns:

setPreProcessingFilter

void setPreProcessingFilter(TransferFilter filter)
Set PreProcessing TransferFilter.

Parameters:
filter -

getFilterIDs

java.util.List getFilterIDs()
Return all filter identifiers.

Returns:

setFilterIDs

void setFilterIDs(java.util.List filterimpls)
Set all filter identifiers.

Parameters:
filterimpls -

getFilterImpl

java.lang.String getFilterImpl()
Return the default filter implementation.

Returns:

setFilterImpl

void setFilterImpl(java.lang.String filterimpl)
Set the default filter implementation

Parameters:
filterimpl -

getFilterImpl

java.lang.String getFilterImpl(java.lang.String filterid)
Return filter implementation for a given identifier.

Parameters:
filterid -
Returns:

setFilterImpl

void setFilterImpl(java.lang.String filterimpl,
                   java.lang.String filterid)
Set Filter implementation for a given identifier

Parameters:
filterimpl -
filterid -

getFilter

TransferFilter getFilter()
Return default TransferFilter.

Returns:

setFilter

void setFilter(TransferFilter filter)
Set default TransferFilter.

Parameters:
filter -

getFilter

TransferFilter getFilter(java.lang.String filterid)
Get TransferFilter for a given identifier.

Parameters:
filterid -
Returns:

setFilter

void setFilter(TransferFilter filter,
               java.lang.String filterid)
Set TransferFilter for a given identifier.

Parameters:
filter -
filterid -

getFilterChain

java.lang.String getFilterChain()

setFilterChain

void setFilterChain(java.lang.String chain)

getRawConf

Conf getRawConf()

setRawConf

void setRawConf(Conf rawconf)

isThreaded

boolean isThreaded()

setThreaded

void setThreaded(boolean threaded)

getStatus

int getStatus()

setStatus

void setStatus(int status)

init

void init()
          throws ClientException
Initialize transfer.

Throws:
ClientException

execute

java.lang.Object execute()
                         throws ClientException
Start synchroneous transfer.

Throws:
ClientException

begin

void begin()
Start (fire and forget) asynchroneous transfer.


cancel

void cancel()
Cancel transfer.


addTransferListener

void addTransferListener(TransferListener listener)

removeTransferListener

void removeTransferListener(TransferListener listener)

getTransferListeners

java.util.List getTransferListeners()

addSplitListener

void addSplitListener(SplitListener listener)

removeSplitListener

void removeSplitListener(SplitListener listener)

getSplitListeners

java.util.List getSplitListeners()

addCompressListener

void addCompressListener(CompressListener listener)

removeCompressListener

void removeCompressListener(CompressListener listener)

getCompressListeners

java.util.List getCompressListeners()

addFilterListener

void addFilterListener(FilterListener listener)

removeFilterListener

void removeFilterListener(FilterListener listener)

getFilterListeners

java.util.List getFilterListeners()

addProtocolListener

void addProtocolListener(ProtocolListener listener)

removeProtocolListener

void removeProtocolListener(ProtocolListener listener)

getProtocolListeners

java.util.List getProtocolListeners()

addChecksumListener

void addChecksumListener(ChecksumListener listener)

removeChecksumListener

void removeChecksumListener(ChecksumListener listener)

getChecksumListeners

java.util.List getChecksumListeners()