javazoom.transfer.client.core
Interface TransferController

All Known Implementing Classes:
AbstractTransferController

public interface TransferController

This interface defines contract the TransferController classes must implement. TransferController allows both synchroneous and asynchroneous transfer. Synchroneous transfer means TransferController blocks until it gets a response. Asynchroneous transfer means that TransferController doesn't block (fire and forget) and reponse will be received later through notification. Synchroneous transfer is used for short time transfer (e.g. FTP LS command). It should not run in a thread. Asynchroneous transfer is used for long time transfer (e.g. FTP PUT command). It should run in a thread.


Method Summary
 void addCompressListener(CompressListener listener)
           
 void addFilterListener(FilterListener 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.
 long getChunkSize()
           
 java.util.List getCompressListeners()
           
 java.lang.String getEncoding()
           
 java.lang.Object getExt()
           
 TransferFilter getFilter()
           
 java.lang.String getFilterImpl()
           
 java.util.List getFilterListeners()
           
 java.lang.String getHidden()
           
 long getMaxDepth()
           
 long getMaxFiles()
           
 long getMaxSize()
           
 java.lang.String getOverwrite()
           
 java.util.HashMap getParameters(java.lang.String section)
           
 java.lang.String getParamFile()
           
 java.lang.String getPassword()
           
 java.lang.String getPolicy()
           
 Conf getRawConf()
           
 java.lang.String getResume()
           
 java.net.URL getServerUrl()
           
 java.util.List getSource()
           
 java.util.List getSplitListeners()
           
 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 getZipOnFly()
           
 void init()
          Initialize transfer.
 void removeCompressListener(CompressListener listener)
           
 void removeFilterListener(FilterListener listener)
           
 void removeSplitListener(SplitListener listener)
           
 void removeTransferListener(TransferListener listener)
           
 void setChunkSize(long size)
           
 void setEncoding(java.lang.String enc)
           
 void setExt(java.lang.Object ext)
           
 void setFilter(TransferFilter filter)
           
 void setFilterImpl(java.lang.String filterimpl)
           
 void setHidden(java.lang.String hidden)
           
 void setMaxDepth(long amount)
           
 void setMaxFiles(long amount)
           
 void setMaxSize(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 setRawConf(Conf rawconf)
           
 void setResume(java.lang.String resume)
           
 void setServerUrl(java.net.URL url)
           
 void setSource(java.util.List src)
           
 void setTarget(java.util.List tar)
           
 void setTemplate(java.lang.String template)
           
 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 setZipOnFly(java.lang.String zip)
           
 

Method Detail

setServerUrl

public void setServerUrl(java.net.URL url)

getServerUrl

public java.net.URL getServerUrl()

setSource

public void setSource(java.util.List src)

getSource

public java.util.List getSource()

setTarget

public void setTarget(java.util.List tar)

getTarget

public java.util.List getTarget()

setExt

public void setExt(java.lang.Object ext)

getExt

public java.lang.Object getExt()

getUsername

public java.lang.String getUsername()

setUsername

public void setUsername(java.lang.String login)

getPassword

public java.lang.String getPassword()

setPassword

public void setPassword(java.lang.String password)

setWhiteList

public void setWhiteList(java.lang.String lst)

getWhiteList

public java.lang.String getWhiteList()

setMaxSize

public void setMaxSize(long size)

getMaxSize

public long getMaxSize()

setMaxFiles

public void setMaxFiles(long amount)

getMaxFiles

public long getMaxFiles()

setPolicy

public void setPolicy(java.lang.String policy)

getPolicy

public java.lang.String getPolicy()

setTemplate

public void setTemplate(java.lang.String template)

getTemplate

public java.lang.String getTemplate()

setOverwrite

public void setOverwrite(java.lang.String overwrite)

getOverwrite

public java.lang.String getOverwrite()

setResume

public void setResume(java.lang.String resume)

getResume

public java.lang.String getResume()

setHidden

public void setHidden(java.lang.String hidden)

getHidden

public java.lang.String getHidden()

setZipOnFly

public void setZipOnFly(java.lang.String zip)

getZipOnFly

public java.lang.String getZipOnFly()

setMaxDepth

public void setMaxDepth(long amount)

getMaxDepth

public long getMaxDepth()

setChunkSize

public void setChunkSize(long size)

getChunkSize

public long getChunkSize()

setEncoding

public void setEncoding(java.lang.String enc)

getEncoding

public java.lang.String getEncoding()

setParamFile

public void setParamFile(java.lang.String param)

getParamFile

public java.lang.String getParamFile()

setTmpDir

public void setTmpDir(java.lang.String folder)

getTmpDir

public java.lang.String getTmpDir()

setTimeOut

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

Parameters:
timeout -

getTimeOut

public long getTimeOut()
Returns underlying socket timeout.

Returns:
timeout in milliseconds.

setParameters

public void setParameters(java.util.HashMap params)

getParameters

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

getFilterImpl

public java.lang.String getFilterImpl()

setFilterImpl

public void setFilterImpl(java.lang.String filterimpl)

getFilter

public TransferFilter getFilter()

setFilter

public void setFilter(TransferFilter filter)

getRawConf

public Conf getRawConf()

setRawConf

public void setRawConf(Conf rawconf)

init

public void init()
          throws ClientException
Initialize transfer.

Throws:
ClientException

execute

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

Throws:
ClientException

begin

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


cancel

public void cancel()
Cancel transfer.


addTransferListener

public void addTransferListener(TransferListener listener)

removeTransferListener

public void removeTransferListener(TransferListener listener)

getTransferListeners

public java.util.List getTransferListeners()

addSplitListener

public void addSplitListener(SplitListener listener)

removeSplitListener

public void removeSplitListener(SplitListener listener)

getSplitListeners

public java.util.List getSplitListeners()

addCompressListener

public void addCompressListener(CompressListener listener)

removeCompressListener

public void removeCompressListener(CompressListener listener)

getCompressListeners

public java.util.List getCompressListeners()

addFilterListener

public void addFilterListener(FilterListener listener)

removeFilterListener

public void removeFilterListener(FilterListener listener)

getFilterListeners

public java.util.List getFilterListeners()


Copyright © 1999-2005 JavaZOOM.