public abstract class AbstractTransferController extends java.lang.Object implements TransferController
| Modifier and Type | Class and Description |
|---|---|
class |
AbstractTransferController.HeadInfo |
| Modifier and Type | Field and Description |
|---|---|
static int |
BUFFERSIZE |
static java.lang.String |
GZIPEXTENSION |
static java.lang.String |
ZIPEXTENSION |
COMPLETED_STATUS, MAX_AUTH_ATTEMPTS, PREPROCESSING_FILTER, RUNNING_STATUS, WAITING_STATUS| Constructor and Description |
|---|
AbstractTransferController()
Top TransferController.
|
| Modifier and Type | Method and Description |
|---|---|
void |
addChecksumListener(ChecksumListener listener) |
void |
addCompressListener(CompressListener listener) |
void |
addFilterListener(FilterListener listener) |
void |
addProtocolListener(ProtocolListener listener) |
void |
addSplitListener(SplitListener listener) |
void |
addTransferListener(TransferListener listener) |
java.net.PasswordAuthentication |
authenticate(AuthenticationModel model,
int attempt)
Optional prompt for authentication.
|
abstract void |
begin()
Start (fire and forget) asynchronous transfer.
|
abstract void |
cancel()
Cancel transfer.
|
protected void |
checksumCompletedNotification(java.lang.String checksum)
Notify listeners about checksum completed.
|
protected void |
checksumFailedNotification(ClientException e)
Notify listeners about checksum failed.
|
protected void |
checksummingNotification(int size)
Notify listeners about current checksum.
|
protected void |
checksumStartedNotification(java.lang.String type,
java.lang.Object source,
long size)
Notify listeners about checksum starting.
|
boolean |
checkZipMaxSize(java.io.File zipfile)
Check if file size match to zipmaxsize parameter.
|
protected void |
cleanFilter()
Calls clean() method on default pre-processing filter.
|
protected void |
cleanFilter(java.lang.String id)
Calls clean() method on filter.
|
protected java.io.File |
compress(java.io.File file)
Zip input file.
|
protected java.io.File |
compress(java.io.File file,
java.lang.String alg)
Compress input file.
|
protected java.io.File |
compressFolder(java.io.File folder,
java.io.File zipfile)
Compress a folder (recursively) to a given file.
|
protected void |
compressingNotification(int size)
Notify listeners about current compression.
|
protected void |
compressionFailedNotification(ClientException e)
Notify listeners about compression failed.
|
protected void |
computeChecksum(java.io.File file,
long offset,
java.lang.Object checksum)
Compute checksum (CRC32 or MessageDigest) for a given filename.
|
abstract java.lang.Object |
execute()
Start synchronous transfer.
|
protected java.lang.Object |
executeFilter(java.lang.Object input)
Calls execute() method on default pre-processing filter.
|
protected java.lang.Object |
executeFilter(java.lang.Object input,
java.lang.String id)
Calls execute() method on filter.
|
protected java.util.ArrayList |
getAllowedSourceFiles()
Returns all files (flat list) allowed to be transfered.
|
java.lang.String |
getAuthentication() |
java.lang.String |
getBlackList() |
java.util.List |
getChecksumListeners() |
protected long |
getChunks(java.io.File file) |
long |
getChunkSize() |
java.util.List |
getCompressListeners() |
long |
getCRC32(java.io.File file,
long offset)
Compute CRC32 for a given filename.
|
java.lang.String |
getEncoding() |
java.lang.Object |
getExt() |
TransferFilter |
getFilter()
Return default TransferFilter.
|
TransferFilter |
getFilter(java.lang.String id)
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 id)
Return filter implementation for a given identifier.
|
java.util.List |
getFilterListeners() |
long |
getFullMaxSize() |
java.lang.String |
getHidden() |
protected long |
getLastChunkSize(java.io.File file) |
long |
getLong(java.lang.String str)
Parse String to long.
|
long |
getMaxDepth() |
long |
getMaxFiles() |
long |
getMaxSize() |
byte[] |
getMD5(java.io.File file,
long offset)
Compute MD5 for a given filename.
|
java.util.HashMap |
getMetaProperties() |
java.lang.String |
getMetaScope()
Return meta properties scope (status, post or forward).
|
long |
getMinSize() |
java.lang.String |
getOverwrite() |
java.lang.String |
getOverwriteWarn() |
java.util.HashMap |
getParameters(java.lang.String section) |
java.lang.String |
getParamFile() |
java.awt.Container |
getParentContainer() |
java.lang.String |
getPassword() |
java.lang.String |
getPolicy() |
boolean |
getPreemptiveAuth() |
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.lang.String |
getRootDir() |
java.net.URL |
getServerUrl() |
java.util.List |
getSource() |
java.util.List |
getSplitListeners() |
int |
getStatus() |
java.util.List |
getTarget() |
java.lang.String |
getTemplate() |
java.lang.String |
getTemplateScope() |
long |
getTimeOut()
Returns underlying socket timeout.
|
java.lang.String |
getTmpDir() |
java.lang.String |
getTmpFolder()
Returns tmpfolder.
|
TransferFileFilter |
getTransferFileFilter()
Return transfer FileFilter instance.
|
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() |
java.lang.String |
hexDump(byte[] in)
Dump byte array to hexadecimal string.
|
void |
init()
Initialize TransferController.
|
boolean |
isAllowed(java.io.File current)
Check if file is allowed for transfer.
|
boolean |
isThreaded() |
protected void |
recurse(java.io.File dir,
java.util.ArrayList target,
long level,
long depth)
Recurse directory to find all files given a depth.
|
protected void |
recursiveCompress(java.util.zip.ZipOutputStream zos,
java.io.File folder,
java.io.File rootFolder,
byte[] buffer,
long level,
long depth)
Compress folder recursively.
|
void |
removeChecksumListener(ChecksumListener listener) |
void |
removeCompressListener(CompressListener listener) |
void |
removeFilterListener(FilterListener listener) |
void |
removeProtocolListener(ProtocolListener listener) |
void |
removeSplitListener(SplitListener listener) |
void |
removeTransferListener(TransferListener listener) |
java.lang.String |
rename(java.lang.String filename,
java.lang.String tmpl,
int attempt)
Apply rename policy.
|
void |
setAuthentication(java.lang.String authmode) |
void |
setBlackList(java.lang.String string) |
void |
setChunkSize(long l) |
void |
setEncoding(java.lang.String string) |
void |
setExt(java.lang.Object ext) |
void |
setFilter(TransferFilter filter)
Set default TransferFilter.
|
void |
setFilter(TransferFilter filter,
java.lang.String id)
Set TransferFilter for a given identifier.
|
void |
setFilterChain(java.lang.String chain) |
void |
setFilterIDs(java.util.List ids)
Set all filter identifiers.
|
void |
setFilterImpl(java.lang.String filterimpl)
Set the default filter implementation
|
void |
setFilterImpl(java.lang.String filterimpl,
java.lang.String id)
Set Filter implementation for a given identifier
|
void |
setFullMaxSize(long size) |
void |
setHidden(java.lang.String hidden) |
void |
setMaxDepth(long depth) |
void |
setMaxFiles(long amount) |
void |
setMaxSize(long size) |
void |
setMetaProperties(java.util.HashMap props) |
void |
setMetaScope(java.lang.String scope) |
void |
setMinSize(long size) |
void |
setOverwrite(java.lang.String string) |
void |
setOverwriteWarn(java.lang.String str) |
void |
setParameters(java.util.HashMap map) |
void |
setParamFile(java.lang.String string) |
void |
setParentContainer(java.awt.Container frame) |
void |
setPassword(java.lang.String password) |
void |
setPolicy(java.lang.String pol) |
void |
setPreemptiveAuth(boolean b)
Set preemptive authentication.
|
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 string) |
protected void |
setResumeOffset(long offset) |
void |
setRetry(int c) |
void |
setRetryDelay(int delay) |
void |
setRootDir(java.lang.String rootdir) |
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 string) |
void |
setTemplateScope(java.lang.String string) |
void |
setThreaded(boolean threaded) |
void |
setTimeOut(long timeout)
Set socket timeout in milliseconds.
|
void |
setTmpDir(java.lang.String string) |
void |
setUsername(java.lang.String username) |
void |
setWhiteList(java.lang.String string) |
void |
setZipFolder(java.lang.String string) |
void |
setZipIgnoreList(java.lang.String string) |
void |
setZipMaxSize(long size) |
void |
setZipOnFly(java.lang.String zip) |
int |
warnOverwrite(AbstractTransferController.HeadInfo desc,
boolean resuming) |
public static int BUFFERSIZE
public static java.lang.String ZIPEXTENSION
public static java.lang.String GZIPEXTENSION
public AbstractTransferController()
public void init()
throws ClientException
init in interface TransferControllerClientExceptionpublic abstract java.lang.Object execute()
throws ClientException
TransferControllerexecute in interface TransferControllerClientExceptionpublic abstract void begin()
TransferControllerbegin in interface TransferControllerpublic abstract void cancel()
TransferControllercancel in interface TransferControllerprotected java.util.ArrayList getAllowedSourceFiles()
throws ClientException
ClientExceptionpublic boolean isAllowed(java.io.File current)
throws ClientException
current - ClientExceptionpublic boolean checkZipMaxSize(java.io.File zipfile)
throws ClientException
zipfile - ClientExceptionprotected void recurse(java.io.File dir,
java.util.ArrayList target,
long level,
long depth)
dir - target - level - current depthdepth - max depth allowedprotected long getChunks(java.io.File file)
protected long getLastChunkSize(java.io.File file)
protected java.lang.Object executeFilter(java.lang.Object input)
throws ClientException
input - ClientExceptionprotected java.lang.Object executeFilter(java.lang.Object input,
java.lang.String id)
throws ClientException
input - id - ClientExceptionprotected void cleanFilter(java.lang.String id)
id - protected void cleanFilter()
protected java.io.File compress(java.io.File file)
file - protected java.io.File compress(java.io.File file,
java.lang.String alg)
file - alg - zip or gzipprotected java.io.File compressFolder(java.io.File folder,
java.io.File zipfile)
folder - Filezipfile - Fileprotected void recursiveCompress(java.util.zip.ZipOutputStream zos,
java.io.File folder,
java.io.File rootFolder,
byte[] buffer,
long level,
long depth)
throws java.io.IOException
zos - ZipOutputStreamfolder - FilerootFolder - Filebuffer - byte[]level - depth - java.io.IOExceptionprotected void compressingNotification(int size)
size - protected void compressionFailedNotification(ClientException e)
e - protected void checksumStartedNotification(java.lang.String type,
java.lang.Object source,
long size)
size - protected void checksumCompletedNotification(java.lang.String checksum)
size - protected void checksummingNotification(int size)
size - protected void checksumFailedNotification(ClientException e)
e - public java.lang.String rename(java.lang.String filename,
java.lang.String tmpl,
int attempt)
filename - tmpl - optional templateattempt - public long getCRC32(java.io.File file,
long offset)
file - offset - data range [0-offset] to compute CRC32, -1 for all data.public byte[] getMD5(java.io.File file,
long offset)
file - offset - data range [0-offset] to compute MD5, -1 for all data.public java.lang.String hexDump(byte[] in)
in - protected void computeChecksum(java.io.File file,
long offset,
java.lang.Object checksum)
throws java.lang.Exception
file - offset - offset data range [0-offset] to compute checksum, -1 for all data.checksum - CRC32 or MessageDigest instancejava.lang.Exceptionpublic java.lang.String getTmpFolder()
public java.net.PasswordAuthentication authenticate(AuthenticationModel model, int attempt)
model - attempt - public int warnOverwrite(AbstractTransferController.HeadInfo desc, boolean resuming)
public void addTransferListener(TransferListener listener)
addTransferListener in interface TransferControllerpublic void removeTransferListener(TransferListener listener)
removeTransferListener in interface TransferControllerpublic java.util.List getTransferListeners()
getTransferListeners in interface TransferControllerpublic void addSplitListener(SplitListener listener)
addSplitListener in interface TransferControllerpublic void removeSplitListener(SplitListener listener)
removeSplitListener in interface TransferControllerpublic java.util.List getSplitListeners()
getSplitListeners in interface TransferControllerpublic void addCompressListener(CompressListener listener)
addCompressListener in interface TransferControllerpublic void removeCompressListener(CompressListener listener)
removeCompressListener in interface TransferControllerpublic java.util.List getCompressListeners()
getCompressListeners in interface TransferControllerpublic void addFilterListener(FilterListener listener)
addFilterListener in interface TransferControllerpublic void removeFilterListener(FilterListener listener)
removeFilterListener in interface TransferControllerpublic java.util.List getFilterListeners()
getFilterListeners in interface TransferControllerpublic void addProtocolListener(ProtocolListener listener)
addProtocolListener in interface TransferControllerpublic void removeProtocolListener(ProtocolListener listener)
removeProtocolListener in interface TransferControllerpublic java.util.List getProtocolListeners()
getProtocolListeners in interface TransferControllerpublic void addChecksumListener(ChecksumListener listener)
addChecksumListener in interface TransferControllerpublic void removeChecksumListener(ChecksumListener listener)
removeChecksumListener in interface TransferControllerpublic java.util.List getChecksumListeners()
getChecksumListeners in interface TransferControllerpublic java.util.List getSource()
getSource in interface TransferControllerpublic java.lang.String getTmpDir()
getTmpDir in interface TransferControllerpublic java.util.List getTarget()
getTarget in interface TransferControllerpublic void setSource(java.util.List src)
setSource in interface TransferControllerpublic void setMaxSize(long size)
setMaxSize in interface TransferControllerpublic long getMaxSize()
getMaxSize in interface TransferControllerpublic void setFullMaxSize(long size)
setFullMaxSize in interface TransferControllerpublic long getFullMaxSize()
getFullMaxSize in interface TransferControllerpublic void setMinSize(long size)
setMinSize in interface TransferControllerpublic long getMinSize()
getMinSize in interface TransferControllerpublic void setMaxFiles(long amount)
setMaxFiles in interface TransferControllerpublic long getMaxFiles()
getMaxFiles in interface TransferControllerpublic void setZipMaxSize(long size)
setZipMaxSize in interface TransferControllerpublic long getZipMaxSize()
getZipMaxSize in interface TransferControllerpublic void setPolicy(java.lang.String pol)
setPolicy in interface TransferControllerpublic java.lang.String getPolicy()
getPolicy in interface TransferControllerpublic void setHidden(java.lang.String hidden)
setHidden in interface TransferControllerpublic java.lang.String getHidden()
getHidden in interface TransferControllerpublic void setZipOnFly(java.lang.String zip)
setZipOnFly in interface TransferControllerpublic java.lang.String getZipOnFly()
getZipOnFly in interface TransferControllerpublic void setMaxDepth(long depth)
setMaxDepth in interface TransferControllerpublic long getMaxDepth()
getMaxDepth in interface TransferControllerpublic void setTimeOut(long timeout)
TransferControllersetTimeOut in interface TransferControllerpublic long getTimeOut()
TransferControllergetTimeOut in interface TransferControllerpublic int getRetry()
getRetry in interface TransferControllerpublic void setRetry(int c)
setRetry in interface TransferControllerpublic int getRetryDelay()
getRetryDelay in interface TransferControllerpublic void setRetryDelay(int delay)
setRetryDelay in interface TransferControllerpublic void setWhiteList(java.lang.String string)
setWhiteList in interface TransferControllerpublic java.lang.String getWhiteList()
getWhiteList in interface TransferControllerpublic void setBlackList(java.lang.String string)
setBlackList in interface TransferControllerpublic java.lang.String getBlackList()
getBlackList in interface TransferControllerpublic void setZipIgnoreList(java.lang.String string)
setZipIgnoreList in interface TransferControllerpublic java.lang.String getZipIgnoreList()
getZipIgnoreList in interface TransferControllerpublic void setZipFolder(java.lang.String string)
setZipFolder in interface TransferControllerpublic java.lang.String getZipFolder()
getZipFolder in interface TransferControllerpublic void setTemplate(java.lang.String string)
setTemplate in interface TransferControllerpublic java.lang.String getTemplate()
getTemplate in interface TransferControllerpublic void setTemplateScope(java.lang.String string)
setTemplateScope in interface TransferControllerpublic java.lang.String getTemplateScope()
getTemplateScope in interface TransferControllerpublic void setOverwrite(java.lang.String string)
setOverwrite in interface TransferControllerpublic java.lang.String getOverwrite()
getOverwrite in interface TransferControllerpublic void setResume(java.lang.String string)
setResume in interface TransferControllerpublic java.lang.String getResume()
getResume in interface TransferControllerpublic long getResumeOffset()
getResumeOffset in interface TransferControllerprotected void setResumeOffset(long offset)
public void setOverwriteWarn(java.lang.String str)
setOverwriteWarn in interface TransferControllerpublic java.lang.String getOverwriteWarn()
getOverwriteWarn in interface TransferControllerpublic void setAuthentication(java.lang.String authmode)
setAuthentication in interface TransferControllerpublic java.lang.String getAuthentication()
getAuthentication in interface TransferControllerpublic void setTmpDir(java.lang.String string)
setTmpDir in interface TransferControllerpublic void setTarget(java.util.List tar)
setTarget in interface TransferControllerpublic java.util.HashMap getParameters(java.lang.String section)
getParameters in interface TransferControllerpublic void setParameters(java.util.HashMap map)
setParameters in interface TransferControllerpublic void setMetaProperties(java.util.HashMap props)
setMetaProperties in interface TransferControllerpublic java.util.HashMap getMetaProperties()
getMetaProperties in interface TransferControllerpublic java.lang.String getMetaScope()
TransferControllergetMetaScope in interface TransferControllerpublic void setMetaScope(java.lang.String scope)
setMetaScope in interface TransferControllerpublic java.lang.String getEncoding()
getEncoding in interface TransferControllerpublic java.lang.String getParamFile()
getParamFile in interface TransferControllerpublic void setEncoding(java.lang.String string)
setEncoding in interface TransferControllerpublic void setParamFile(java.lang.String string)
setParamFile in interface TransferControllerpublic long getChunkSize()
getChunkSize in interface TransferControllerpublic void setChunkSize(long l)
setChunkSize in interface TransferControllerpublic java.lang.String getRootDir()
public void setRootDir(java.lang.String rootdir)
rootdir - The rootdir to set.public java.lang.String getPassword()
getPassword in interface TransferControllerpublic void setPassword(java.lang.String password)
setPassword in interface TransferControllerpassword - The password to set.public java.lang.String getUsername()
getUsername in interface TransferControllerpublic void setUsername(java.lang.String username)
setUsername in interface TransferControllerusername - The username to set.public boolean getPreemptiveAuth()
getPreemptiveAuth in interface TransferControllerpublic void setPreemptiveAuth(boolean b)
setPreemptiveAuth in interface TransferControllerpublic java.net.URL getServerUrl()
getServerUrl in interface TransferControllerpublic void setServerUrl(java.net.URL url)
setServerUrl in interface TransferControllerurl - The server url to set.public java.lang.String getPreProcessingFilterImpl()
TransferControllergetPreProcessingFilterImpl in interface TransferControllerpublic void setPreProcessingFilterImpl(java.lang.String filterimpl)
TransferControllersetPreProcessingFilterImpl in interface TransferControllerpublic TransferFilter getPreProcessingFilter()
TransferControllergetPreProcessingFilter in interface TransferControllerpublic void setPreProcessingFilter(TransferFilter filter)
TransferControllersetPreProcessingFilter in interface TransferControllerpublic TransferFilter getFilter()
TransferControllergetFilter in interface TransferControllerpublic TransferFilter getFilter(java.lang.String id)
TransferControllergetFilter in interface TransferControllerpublic void setFilter(TransferFilter filter)
TransferControllersetFilter in interface TransferControllerpublic void setFilter(TransferFilter filter, java.lang.String id)
TransferControllersetFilter in interface TransferControllerpublic java.lang.String getFilterImpl()
TransferControllergetFilterImpl in interface TransferControllerpublic java.lang.String getFilterImpl(java.lang.String id)
TransferControllergetFilterImpl in interface TransferControllerpublic void setFilterImpl(java.lang.String filterimpl)
TransferControllersetFilterImpl in interface TransferControllerpublic void setFilterImpl(java.lang.String filterimpl,
java.lang.String id)
TransferControllersetFilterImpl in interface TransferControllerpublic java.util.List getFilterIDs()
TransferControllergetFilterIDs in interface TransferControllerpublic void setFilterIDs(java.util.List ids)
TransferControllersetFilterIDs in interface TransferControllerpublic java.lang.String getFilterChain()
getFilterChain in interface TransferControllerpublic void setFilterChain(java.lang.String chain)
setFilterChain in interface TransferControllerpublic Conf getRawConf()
getRawConf in interface TransferControllerpublic void setRawConf(Conf rawconf)
setRawConf in interface TransferControllerrawconf - The rawconf to set.public TransferFileFilter getTransferFileFilter()
public java.lang.Object getExt()
getExt in interface TransferControllerpublic void setExt(java.lang.Object ext)
setExt in interface TransferControllerext - The ext to set.public void setParentContainer(java.awt.Container frame)
setParentContainer in interface TransferControllerpublic java.awt.Container getParentContainer()
getParentContainer in interface TransferControllerpublic boolean isThreaded()
isThreaded in interface TransferControllerpublic void setThreaded(boolean threaded)
setThreaded in interface TransferControllerpublic int getStatus()
getStatus in interface TransferControllerpublic void setStatus(int status)
setStatus in interface TransferControllerpublic long getLong(java.lang.String str)
str -