MultiTransferHandler (FileCatalyst Client API)

java.lang.Object
- java.util.Observable
- - unlimited.fc.client.api.TransferHook
  - - unlimited.fc.client.transferhandler.MultiTransferHandler<T>

All Implemented Interfaces:

java.lang.AutoCloseable, java.lang.Runnable, PostURLTransfer.TransferHolder, TransferState, FilesMatchHandler

Direct Known Subclasses:

FileCatalystReceiveHandler, FileCatalystTransmitHandler, ServerToServerHandler
```
public abstract class MultiTransferHandler<T>
extends TransferHook
implements java.lang.Runnable, FilesMatchHandler, PostURLTransfer.TransferHolder, java.lang.AutoCloseable
```
Title: Digital Fountain Encoder/Decoder

Description:

Copyright: Copyright (c) 2004

Company: Unlimi-Tech Software Inc.

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`countTransferred`
`protected FileCatalystFileFilter`	`filter`
`protected boolean`	`isParentPooled`
`protected long`	`lastBytesSoFar`
`protected java.lang.String`	`statusMessage`
`static long`	`waitForDiscWriteProgressive`
`protected boolean`	`willTransfer`

Fields inherited from class unlimited.fc.client.api.TransferHook
BIDIRECTIONAL, CANCELLED, CHECKING, COMPRESSING, CREATINGDMG, currentFileToIDs, DECOMPRESSING, DELTA, DOINGCHMOD, DOINGMDTM, DONEFILE, DOWNLOAD, ERROR, errorMessageStack, FINISHED, IDLE, INITIALIZING, MONITORING, MOVINGFILES, NOTATTEMPTED, PROCESSING, REBUILD, RECONNECTING, SIGNATURE, SUCCESS, TRANSFERRING, UPLOAD, VERIFYING

Constructor Summary

Constructors
Constructor and Description

MultiTransferHandler(FCClientEngine fcClient)

Constructors
Constructor and Description
`MultiTransferHandler(FCClientEngine fcClient)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addObserver(java.util.Observer o)` Java has Deprecated Observable due to it being an anti-pattern.
`void`	`addTransferredLocalFile(java.lang.String filename)`
`void`	`addTransferredRemoteFile(java.lang.String filename)`
`protected int`	`calculateAverageKbpsRate(long bytesTotal, long msTotal)` Calculate a transfer rate in kilo bits per second Kilo here means a 1000, because this is a rate.
`int`	`calculateEffectiveRateOfZipTransfer(long sizeOfAllFilesZipped, long timeForEffectiveRate)`
`boolean`	`checkForServerTimeout()`
`boolean`	`checkRegex(java.lang.String filename)`
`void`	`close()`
`protected void`	`deleteLocalFiles(java.util.LinkedList<java.nio.file.Path> tmpFileList)` Attempts to delete all files marked in temp file list locally.
`protected void`	`deleteRemoteFileNames(java.util.LinkedList<java.lang.String> tmpFileList)` Attempts to delete all remote files marked in temp file list.
`protected abstract boolean`	`doesDirectoryContainContents(T t)`
`protected void`	`downgradeFileTransferMode()`
`protected void`	`enableVerifySizeIfNeeded()`
`protected boolean`	`fileRegionMatch(java.nio.file.Path file, java.lang.String rFile, long offset, long length)`
`protected MD5Result`	`filesMatch(java.nio.file.Path file, java.lang.String rFile)`
`protected MD5Result`	`filesMatch(java.nio.file.Path file, java.lang.String rFile, boolean invalidateRemoteMD5CacheEntry)`
`static MD5Result`	`filesMatch(java.nio.file.Path file, java.lang.String rFile, boolean invalidateRemoteMD5CacheEntry, FilesMatchHandler filesMatchHandler)`
`protected void`	`filesMatchBackground(java.nio.file.Path file, java.lang.String rFile)`
`protected MD5Result`	`filesMatchPartial(java.nio.file.Path file, java.lang.String rFile, long checkInterval, long checkLength)`
`static MD5Result`	`filesMatchPartial(java.nio.file.Path file, java.lang.String rFile, long checkInterval, long checkLength, boolean invalidateRemoteMD5CacheEntry, FilesMatchHandler filesMatchHandler)`
`protected void`	`filterEmptyDirectoriesIfNeeded()`
`int`	`getActiveIndex()`
`java.util.Map<java.lang.String,java.lang.Long>`	`getAllFileAndSize()`
`java.util.List<java.lang.String>`	`getAllFilePaths()` Returns a list of all file paths contained within this TransferHook
`long`	`getAverageSetupTeardown()`
`long`	`getAvgMD5TimePerKB()`
`long`	`getBytesSoFarAllFiles()` Returns the number of bytes transferred so far for all files.
`long`	`getBytesSoFarAllFilesFull()` Return the full size of the files which were transferred.
`long`	`getBytesSoFarCurrentFile()` Returns the number of bytes transferred so far for the current file.
`FileCatalystClientCallbackHandler`	`getCallbackHandler()`
`CancelHandler`	`getCancelHandler()`
`FCClientEngine`	`getClient()`
`FCClient`	`getClientAPI()`
`java.lang.String`	`getCompFileFilter()`
`int`	`getCompressionLevel()`
`int`	`getCompressionMethod()`
`int`	`getCompressionStrategy()`
`int`	`getCountTransferred()` Returns the number of files that were actually transferred.
`int`	`getCurrentEffectiveRate()` Returns the rate for the current file in Kbps.
`java.lang.String`	`getCurrentFilename()` Returns the name of the file currently being transferred.
`long`	`getCurrentFileTime()`
`long`	`getCurrentFileTransferTime()` Returns the transfer time for the current file in milliseconds
`int`	`getCurrentPercent()` Returns the percent complete for the current file
`int`	`getCurrentRate()` Returns the rate in the last second for the current file in Kbps.
`static java.lang.String`	`getDeltaFilename(java.lang.String originalFilename, java.lang.String uniqueID)` Returns the delta filename used when caculating deltas during a transfer.
`int`	`getDirection()` Returns either UPLOAD or DOWNLOAD constant depending on the direction of this transfer
`int`	`getEffectiveRateAverage()` Returns the effective rate for the current file in Kbps as an average over last 30 seconds.
`int`	`getEffectiveRateAverageInKBperSecond()`
`int`	`getFilesSoFar()` Returns the number of files transferred so far.
`java.util.List<java.lang.String>`	`getFilesTransferredLocal()` Returns a List containing the full local paths (Strings) of all files that were transferred.
`java.util.List<java.lang.String>`	`getFilesTransferredRemote()` Returns a List containing the full remote paths (Strings) of all files that were transferred.
`FileCatalystFileFilter`	`getFilter()`
`java.lang.String`	`getFormattedCurrentFileTransferTime()` Returns a human readable file transfer time
`java.lang.String`	`getFormattedOverallTransferTime()` Returns the time taken to transfer all files formatted to a String i.e 5 mins 21 secs
`java.lang.String`	`getFormattedTransferTime()` Returns the time taken to transfer the current file formatted to a String i.e 5 mins 21 secs
`int`	`getIncTransferOption()`
`long`	`getLastTry()`
`java.lang.String`	`getLocalFilename()` Returns the full path of the local file currently being transferred
`protected CachedFileIndexInterface`	`getLocalFileTransferIndex()`
`java.nio.file.Path`	`getLocalWorkingDirectory()`
`unlimited.core.util.common.logs.LogUtils`	`getLogFiles()`
`static long`	`getMaximumDeltaSize(long sourceFileSize, long destFileSize)`
`int`	`getMaxTries()`
`static java.lang.String`	`getMD5Key(java.nio.file.Path file)`
`int`	`getMd5RateLimit()`
`int`	`getMeanEffectiveRate()` Returns the rate for the current file in Kbps.
`static long`	`getMinimumDeltaSize(long sourceFileSize, long destFileSize)`
`int`	`getOverallRate()` Returns the average rate (in Kbps) spanned over all files averaged over the entire transfer.
`double`	`getOverallRateInKBperSecond()` Returns the average rate (in KB/s) spanned over all files averageed over the entire transfer.
`java.lang.String`	`getOverallTimeRemaining()` Return the time remaining for the all files formatted to a String i.e 5 mins 21 secs
`long`	`getOverallTimeRemainingMillis()` Returns the time remaining in milliseconds for all files
`long`	`getOverallTransferTime()` Returns the time taken to transfer all files so far in milliseconds
`double`	`getPacketLossPercent()` Returns the packet loss percent for the current transfer.
`int`	`getPercent()` Returns the percentage complete of all files to be transferred
`java.lang.String`	`getPostURL()`
`static java.lang.String`	`getPreservePathStructureFileName(java.lang.String lFile)`
`int`	`getProgressiveTimeout()`
`java.lang.String`	`getProgressiveTimeoutFilter()`
`int`	`getRateAverage()` Returns the network rate for the current file in Kbps as an average over last 30 seconds.
`double`	`getRateAverageInKBperSecond()` Returns the rate for the current file in KB/s as an average over last 30 seconds
`double`	`getRateInKBperSecond()` Returns the rate for the current file in KB/s
`java.lang.String`	`getRegex()`
`java.lang.String`	`getRemoteFilename()` Returns the full path of the remote file currently being transferred
`java.lang.String`	`getRemoteWorkingDirectory()`
`long`	`getRetransferHeaderSize()`
`int`	`getRoundTripTime()` Returns the current round trip time
`static java.lang.String`	`getSignatureFilename(java.lang.String originalFilename, java.lang.String uniqueID)` Returns the delta filename used when caculating signatures during a transfer.
`long`	`getSizeAllFiles()` Returns the total size in bytes of all files that will be transferred
`long`	`getSizeCurrentFile()` Returns the size in bytes of the file currently being transferred.
`long`	`getSizeTransferredAlreadyAllFiles()` Size of files which are already found on the destination, if incremental is on and file was skipped or if file transfer was resumed where 2 GB of data was there and you are continuing last 2GB of data.
`long`	`getSizeTransferredAlreadyCurrentFile()` Returns the number of bytes that were already transferred for this file (usually due to a resume)
`java.lang.Integer`	`getStatus(int index)`
`int`	`getStatusCode()` Returns the current status code, indicates what is currently happening with the transfer
`java.lang.String`	`getStatusMessage()` Returns a String representation of the current status of this transfer handler.
`java.lang.String`	`getTimeRemaining()` Return the time remaining for the current file formatted to a String i.e 5 mins 21 secs
`long`	`getTimeRemainingMillis()` Returns the time remaining in milliseconds for the current file
`int`	`getTmpMode()`
`int`	`getTotalFiles()` Returns the total number of files to be transferred.
`UDPTransferMetricsContainer`	`getTransferMetrics()` Returns transfer metric container specific to UDP transfers.
`int`	`getTransferMode()` Returns the current transfer mode
`long`	`getTransferStartTime()` Returns the transfer start time for the total transfer in milliseconds
`java.util.List<java.lang.Integer>`	`getTransferStatus()` Returns a list of all the status codes for current transfers within this TransferHook
`long`	`getTransferTime()` Returns the transfer time for the total transfer in milliseconds
`java.lang.String`	`getTransferWarningMessage()` Returns the transfer warning message if a transfer warning has occurred.
`java.lang.String`	`getUniqueID()`
`int`	`getVerifyMode()`
`long`	`getWaitRetry()`
`long`	`getZipFileSizeLimit()`
`void`	`handleError(java.lang.String postURL, java.lang.Exception e)`
`void`	`handleProgressiveDelayBeforeAppend()`
`protected void`	`incrementSofarAllFiles(boolean isADeltaTransfer, long dataSize)`
`protected void`	`incrementTotalFiles()`
`protected void`	`initializeProgressiveDelay()`
`protected void`	`initializeTransferHeadersEachAppend()`
`boolean`	`isAddSkippedFilesToTransferVector()`
`boolean`	`isAutoResume()`
`boolean`	`isAutoUnzip()`
`boolean`	`isAutoZip()`
`boolean`	`isCancelled()`
`boolean`	`isCancelledDueToError()`
`boolean`	`isDeleteAfterTransfer()`
`boolean`	`isDeletePartial()`
`boolean`	`isDowngradeModeOnReConnect()`
`boolean`	`isFatal()` Return true if a fatal error occurred
`boolean`	`isIncremental()`
`boolean`	`isIncrementalSizeCheckOnly()`
`boolean`	`isOptimizeBlocksize()`
`boolean`	`isPreservePathStructure()`
`boolean`	`isProgressiveTransfers()`
`boolean`	`isRenameExtensions()`
`boolean`	`isSecure()` Returns true if transfer is secure
`boolean`	`isStorTmp()`
`boolean`	`isTransferCancelled()` Returns true if the transfer was cancelled.
`boolean`	`isTransferComplete()` Returns true if all files are successfully transferred
`boolean`	`isTransferEmptyDirectories()`
`boolean`	`isTransferError()` Returns true if an error occured
`protected boolean`	`isTransferUsingDeltas()`
`boolean`	`isTransferWarning()` Returns true a recoverable transfer warning has occured.
`boolean`	`isUseCompression()`
`boolean`	`isValidFileCache()`
`void`	`killAll()`
`void`	`logFinalTransferStats(java.nio.file.Path file)`
`void`	`logMessage(java.util.logging.Level info, java.lang.String string)`
`static void`	`main(java.lang.String[] args)`
`void`	`notifyObservers()`
`void`	`notifyObservers(java.lang.Object arg)`
`protected boolean`	`passesProgressiveTimeoutFilter(java.lang.String sourceFile)`
`protected boolean`	`permissionsAllowForDeltasTransfer()` Check to see if the permissions on teh server are OK for doing Deltas
`void`	`removeIndex(int index)`
`protected void`	`renameExtension(java.nio.file.Path file, java.lang.String rFile)` OTIS feature, rename the extensions on the local and remote files from RDY to PKD
`void`	`run()`
`abstract void`	`runHandler()`
`void`	`setAddSkippedFilesToTransferVector(boolean addSkippedFilesToTransferVector)`
`void`	`setAppletTransferCache(java.util.HashMap<java.lang.String,java.lang.Long> transferCache)`
`void`	`setAutoResume(boolean autoResume)`
`void`	`setAutoUnzip(boolean b)`
`void`	`setAutoZip(boolean b)`
`void`	`setAvgMD5TimePerKB(long avgMD5TimePerKB)`
`void`	`setAvgRTT(long avgRTT)`
`void`	`setBandwidth(int bandwidth)`
`void`	`setCallbackHandler(FileCatalystClientCallbackHandler callbackHandler)`
`void`	`setCancelled()` Calling this method will cancel the current transfer.
`protected void`	`setCancelled(boolean isCancelled)`
`void`	`setClientAPI(FCClient clientAPI)`
`void`	`setCompFileFilter(java.lang.String compFileFilter)`
`void`	`setCompressionLevel(int compLevel)`
`void`	`setCompressionMethod(int compMethod)`
`void`	`setCompressionStrategy(int cs)`
`void`	`setDeleteAfterTransfer(boolean deleteAfterTransfer)`
`void`	`setDeletePartial(boolean deletePartial)`
`void`	`setDowngradeModeOnReConnect(boolean downgradeModeOnReConnect)`
`void`	`setFatal(boolean fatal)` Marks transfer as having failed in a fatal way, no retry at this point
`void`	`setFilesSoFar(int num)`
`void`	`setFilter(FileCatalystFileFilter filter)`
`void`	`setIncremental(boolean incremental)`
`void`	`setIncrementalSizeCheckOnly(boolean incrementalSizeCheckOnly)`
`void`	`setIncTransferOption(int incTransferOption)`
`void`	`setIsError(boolean isError)`
`protected void`	`setLastTry()`
`protected void`	`setLocalFileTransferIndex(CachedFileIndexInterface localFileTransferIndex)`
`void`	`setLocalMD5(java.lang.String localMD5)`
`void`	`setLocalWorkingDirectory(java.nio.file.Path localWorkingDirectory)`
`void`	`setLocalWorkingDirectory(java.lang.String localWorkingDirectory)` Deprecated.
`void`	`setLogFiles(unlimited.core.util.common.logs.LogUtils logFiles)`
`void`	`setMaxTries(int maxTries)`
`void`	`setMd5RateLimit(int md5RateLimit)`
`void`	`setOptimizeBlocksize(boolean optimizeBlocksize)`
`void`	`setParentPooled(boolean pooled)`
`void`	`setPostURL(java.lang.String postURL)`
`void`	`setPreservePathStructure(boolean preservePathStructure)`
`void`	`setProgressiveTimeout(int i)`
`void`	`setProgressiveTimeoutFilter(java.lang.String i)`
`void`	`setProgressiveTransfers(boolean progressiveTransfers)`
`void`	`setRegex(java.lang.String regex)`
`void`	`setRemoteMD5(java.lang.String remoteMD5)`
`void`	`setRemoteWorkingDirectory(java.lang.String remoteWorkingDirectory)`
`void`	`setRenameExtensions(boolean renameExtensions)`
`void`	`setRetransferHeaderSize(long retransferHeaderSize)`
`void`	`setSizeCurrentFile(long sizeCurrentFile)`
`protected void`	`setStatusCode(int code)`
`void`	`setStorTmp(boolean storTmp)`
`void`	`setTmpMode(int tmpMode)`
`void`	`setTransferEmptyDirectories(boolean transferEmptyDirectories)`
`void`	`setTransferMode(int transferMode)`
`void`	`setUniqueID(java.lang.String uniqueID)`
`void`	`setUseCompression(boolean useCompression)`
`void`	`setVerifyMode(int verifyMode)`
`void`	`setWaitRetry(long waitRetry)`
`void`	`setZipFileSizeLimit(long zipFileSizeLimit)`
`boolean`	`shouldCompressFile(java.nio.file.Path f)`
`static boolean`	`shouldPerformIncremental(long sourceFileSize, long destFileSize)`
`void`	`updateObservers()`
`protected void`	`updateSofarAllFiles()`
`protected void`	`updateStatusTransferring()`
`int`	`validateVerifyMode(int verifyMode)`
`boolean`	`verifierRunning()`
`protected void`	`verifyFileContents(java.nio.file.Path file, java.lang.String rfile, boolean invalidateRemoteCache)`
`protected void`	`verifySize(java.nio.file.Path file, java.lang.String rFile)`
`static void`	`waitForDiscWriteProgressives(MultiTransferHandler<?> handler)`
`boolean`	`willTransfer()`

Methods inherited from class unlimited.fc.client.api.TransferHook
addErrorMessage, getActualRate, getAllErrorMessages, getCurrentFileToIDs, getErrorCodes, getErrorMessage, getErrorSet, getRate, getSnapShot, getStatusAsParsableString, setFormatter

Methods inherited from class java.util.Observable
clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, setChanged

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface unlimited.fc.client.transferhandler.FilesMatchHandler
addErrorMessage

- Field Detail
  - willTransfer
```
protected boolean willTransfer
```
  - waitForDiscWriteProgressive
```
public static long waitForDiscWriteProgressive
```
  - statusMessage
```
protected java.lang.String statusMessage
```
  - countTransferred
```
protected int countTransferred
```
  - filter
```
protected FileCatalystFileFilter filter
```
  - lastBytesSoFar
```
protected long lastBytesSoFar
```
  - isParentPooled
```
protected boolean isParentPooled
```
- Constructor Detail
  - MultiTransferHandler
```
public MultiTransferHandler(FCClientEngine fcClient)
```
- Method Detail
  - willTransfer
```
public boolean willTransfer()
```
  - runHandler
```
public abstract void runHandler()
```
  - setCancelled
```
protected void setCancelled(boolean isCancelled)
```
  - setIsError
```
public void setIsError(boolean isError)
```
    Specified by:
    
    setIsError in interface FilesMatchHandler
  - setStatusCode
```
protected void setStatusCode(int code)
```
  - getLastTry
```
public long getLastTry()
```
  - setLastTry
```
protected void setLastTry()
```
  - isFatal
```
public boolean isFatal()
```
    Return true if a fatal error occurred
    
    Overrides:
    
    isFatal in class TransferHook
    
    Returns:
    
    true if fatal error occurred
  - setFatal
```
public void setFatal(boolean fatal)
```
    Marks transfer as having failed in a fatal way, no retry at this point
    
    Parameters:
    
    fatal -
  - addObserver
```
public void addObserver(java.util.Observer o)
```
    Description copied from class: TransferHook
    
    Java has Deprecated Observable due to it being an anti-pattern.
    
    Overrides:
    
    addObserver in class TransferHook
  - notifyObservers
```
public void notifyObservers()
```
    Overrides:
    
    notifyObservers in class java.util.Observable
  - notifyObservers
```
public void notifyObservers(java.lang.Object arg)
```
    Overrides:
    
    notifyObservers in class java.util.Observable
  - run
```
public void run()
```
    Specified by:
    
    run in interface java.lang.Runnable
  - close
```
public void close()
           throws java.lang.Exception
```
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Throws:
    
    java.lang.Exception
  - isValidFileCache
```
public boolean isValidFileCache()
```
  - getLocalFileTransferIndex
```
protected CachedFileIndexInterface getLocalFileTransferIndex()
```
  - setLocalFileTransferIndex
```
protected void setLocalFileTransferIndex(CachedFileIndexInterface localFileTransferIndex)
```
  - shouldCompressFile
```
public boolean shouldCompressFile(java.nio.file.Path f)
```
  - getAverageSetupTeardown
```
public long getAverageSetupTeardown()
```
  - isDeleteAfterTransfer
```
public boolean isDeleteAfterTransfer()
```
  - setDeleteAfterTransfer
```
public void setDeleteAfterTransfer(boolean deleteAfterTransfer)
```
  - getFilesTransferredRemote
```
public java.util.List<java.lang.String> getFilesTransferredRemote()
```
    Description copied from interface: TransferState
    
    Returns a List containing the full remote paths (Strings) of all files that were transferred. Calling this method through JavaScript to the applet will return a String delimited by the default delimiter, or whatever delimiter was specified via the applet "delimiter" param
    
    Specified by:
    
    getFilesTransferredRemote in interface TransferState
    
    Overrides:
    
    getFilesTransferredRemote in class TransferHook
    
    Returns:
    
    List containing the full remote paths (Strings) of all files that were transferred.
  - getFilesTransferredLocal
```
public java.util.List<java.lang.String> getFilesTransferredLocal()
```
    Description copied from interface: TransferState
    
    Returns a List containing the full local paths (Strings) of all files that were transferred. Calling this method through JavaScript to the applet will return a String delimited by the default delimiter, or whatever delimiter was specified via the applet "delimiter" param
    
    Specified by:
    
    getFilesTransferredLocal in interface TransferState
    
    Overrides:
    
    getFilesTransferredLocal in class TransferHook
    
    Returns:
    
    List containing the full local paths (Strings) of all files that were transferred.
  - getTransferStatus
```
public java.util.List<java.lang.Integer> getTransferStatus()
```
    Description copied from interface: TransferState
    
    Returns a list of all the status codes for current transfers within this TransferHook
    
    Specified by:
    
    getTransferStatus in interface TransferState
    
    Overrides:
    
    getTransferStatus in class TransferHook
    
    Returns:
  - getStatus
```
public java.lang.Integer getStatus(int index)
```
  - getAllFilePaths
```
public java.util.List<java.lang.String> getAllFilePaths()
```
    Description copied from interface: TransferState
    
    Returns a list of all file paths contained within this TransferHook
    
    Specified by:
    
    getAllFilePaths in interface TransferState
    
    Overrides:
    
    getAllFilePaths in class TransferHook
    
    Returns:
  - getAllFileAndSize
```
public java.util.Map<java.lang.String,java.lang.Long> getAllFileAndSize()
```
  - setCancelled
```
public void setCancelled()
```
    Description copied from interface: TransferState
    
    Calling this method will cancel the current transfer. This method will block until the transfer is actually cancelled.
    
    Specified by:
    
    setCancelled in interface TransferState
    
    Overrides:
    
    setCancelled in class TransferHook
  - getTotalFiles
```
public final int getTotalFiles()
```
    Description copied from interface: TransferState
    
    Returns the total number of files to be transferred.
    
    Specified by:
    
    getTotalFiles in interface TransferState
    
    Overrides:
    
    getTotalFiles in class TransferHook
    
    Returns:
    
    the total number of files to be transferred.
  - incrementTotalFiles
```
protected final void incrementTotalFiles()
```
  - getFilesSoFar
```
public int getFilesSoFar()
```
    Description copied from interface: TransferState
    
    Returns the number of files transferred so far. This includes files that were skipped because incremental is enabled and the file has not been changed.
    
    Specified by:
    
    getFilesSoFar in interface TransferState
    
    Overrides:
    
    getFilesSoFar in class TransferHook
    
    Returns:
    
    the number of files transferred so far.
  - setFilesSoFar
```
public void setFilesSoFar(int num)
```
  - updateSofarAllFiles
```
protected final void updateSofarAllFiles()
```
  - getStatusMessage
```
public java.lang.String getStatusMessage()
```
    Description copied from interface: TransferState
    
    Returns a String representation of the current status of this transfer handler.
    
    Specified by:
    
    getStatusMessage in interface TransferState
    
    Overrides:
    
    getStatusMessage in class TransferHook
    
    Returns:
    
    A String representation of the current status of this transfer handler.
  - getBytesSoFarCurrentFile
```
public long getBytesSoFarCurrentFile()
```
    Description copied from interface: TransferState
    
    Returns the number of bytes transferred so far for the current file.
    
    Specified by:
    
    getBytesSoFarCurrentFile in interface TransferState
    
    Overrides:
    
    getBytesSoFarCurrentFile in class TransferHook
    
    Returns:
    
    the number of bytes transferred so far for the current file (excluding data skipped due to resume).
  - getSizeCurrentFile
```
public long getSizeCurrentFile()
```
    Description copied from interface: TransferState
    
    Returns the size in bytes of the file currently being transferred.
    
    Specified by:
    
    getSizeCurrentFile in interface TransferState
    
    Overrides:
    
    getSizeCurrentFile in class TransferHook
    
    Returns:
    
    the size in bytes of the file currently being transferred.
  - getSizeAllFiles
```
public long getSizeAllFiles()
```
    Description copied from interface: TransferState
    
    Returns the total size in bytes of all files that will be transferred
    
    Specified by:
    
    getSizeAllFiles in interface TransferState
    
    Overrides:
    
    getSizeAllFiles in class TransferHook
    
    Returns:
    
    the total size in bytes of all files that will be transferred
  - getBytesSoFarAllFilesFull
```
public long getBytesSoFarAllFilesFull()
```
    Return the full size of the files which were transferred. Do not include delta/signature/compression size. Include partial transfer size if cancel/pause/error has stopped the transfer. BugZilla #442
    
    Returns:
  - getBytesSoFarAllFiles
```
public long getBytesSoFarAllFiles()
```
    Description copied from interface: TransferState
    
    Returns the number of bytes transferred so far for all files.
    
    Specified by:
    
    getBytesSoFarAllFiles in interface TransferState
    
    Overrides:
    
    getBytesSoFarAllFiles in class TransferHook
    
    Returns:
    
    the number of bytes transferred so far for all files (excluding data skipped due to resume).
  - getPercent
```
public int getPercent()
```
    Description copied from interface: TransferState
    
    Returns the percentage complete of all files to be transferred
    
    Specified by:
    
    getPercent in interface TransferState
    
    Overrides:
    
    getPercent in class TransferHook
    
    Returns:
    
    the percentage complete of all files to be transferred
  - getCurrentPercent
```
public int getCurrentPercent()
```
    Description copied from interface: TransferState
    
    Returns the percent complete for the current file
    
    Specified by:
    
    getCurrentPercent in interface TransferState
    
    Overrides:
    
    getCurrentPercent in class TransferHook
    
    Returns:
    
    the percent complete for the current file
  - getOverallRate
```
public int getOverallRate()
```
    Description copied from interface: TransferState
    
    Returns the average rate (in Kbps) spanned over all files averaged over the entire transfer.
    
    Specified by:
    
    getOverallRate in interface TransferState
    
    Overrides:
    
    getOverallRate in class TransferHook
    
    Returns:
    
    rate in Kbps
  - getCurrentEffectiveRate
```
public int getCurrentEffectiveRate()
```
    Description copied from interface: TransferState
    
    Returns the rate for the current file in Kbps. This is the current rate for the current file.
    
    Specified by:
    
    getCurrentEffectiveRate in interface TransferState
    
    Overrides:
    
    getCurrentEffectiveRate in class TransferHook
    
    Returns:
    
    the rate for the current file in Kbps
  - getMeanEffectiveRate
```
public int getMeanEffectiveRate()
```
    Description copied from interface: TransferState
    
    Returns the rate for the current file in Kbps. This is the average rate for the current file.
    
    Specified by:
    
    getMeanEffectiveRate in interface TransferState
    
    Overrides:
    
    getMeanEffectiveRate in class TransferHook
    
    Returns:
    
    the rate for the current file in Kbps
  - getRateInKBperSecond
```
public double getRateInKBperSecond()
```
    Description copied from interface: TransferState
    
    Returns the rate for the current file in KB/s
    
    Specified by:
    
    getRateInKBperSecond in interface TransferState
    
    Overrides:
    
    getRateInKBperSecond in class TransferHook
    
    Returns:
    
    the rate for the current file in KB/s
  - getRateAverage
```
public int getRateAverage()
```
    Description copied from interface: TransferState
    
    Returns the network rate for the current file in Kbps as an average over last 30 seconds.
    
    Specified by:
    
    getRateAverage in interface TransferState
    
    Overrides:
    
    getRateAverage in class TransferHook
    
    Returns:
    
    the rate for the current file in Kbps
  - getEffectiveRateAverage
```
public int getEffectiveRateAverage()
```
    Description copied from interface: TransferState
    
    Returns the effective rate for the current file in Kbps as an average over last 30 seconds.
    
    Specified by:
    
    getEffectiveRateAverage in interface TransferState
    
    Overrides:
    
    getEffectiveRateAverage in class TransferHook
    
    Returns:
    
    the effective rate for the current file in Kbps
  - getCurrentRate
```
public int getCurrentRate()
```
    Description copied from interface: TransferState
    
    Returns the rate in the last second for the current file in Kbps.
    
    Specified by:
    
    getCurrentRate in interface TransferState
    
    Overrides:
    
    getCurrentRate in class TransferHook
    
    Returns:
    
    the rate for the current file in Kbps over the past second.
  - getRateAverageInKBperSecond
```
public double getRateAverageInKBperSecond()
```
    Description copied from interface: TransferState
    
    Returns the rate for the current file in KB/s as an average over last 30 seconds
    
    Specified by:
    
    getRateAverageInKBperSecond in interface TransferState
    
    Overrides:
    
    getRateAverageInKBperSecond in class TransferHook
    
    Returns:
    
    the rate for the current file in KB/s
  - getEffectiveRateAverageInKBperSecond
```
public int getEffectiveRateAverageInKBperSecond()
```
  - getOverallRateInKBperSecond
```
public double getOverallRateInKBperSecond()
```
    Description copied from interface: TransferState
    
    Returns the average rate (in KB/s) spanned over all files averageed over the entire transfer.
    
    Specified by:
    
    getOverallRateInKBperSecond in interface TransferState
    
    Overrides:
    
    getOverallRateInKBperSecond in class TransferHook
    
    Returns:
    
    rate in KB/s
  - getTimeRemainingMillis
```
public long getTimeRemainingMillis()
```
    Description copied from interface: TransferState
    
    Returns the time remaining in milliseconds for the current file
    
    Specified by:
    
    getTimeRemainingMillis in interface TransferState
    
    Overrides:
    
    getTimeRemainingMillis in class TransferHook
    
    Returns:
    
    the time remaining in milliseconds for the current file
  - getOverallTimeRemainingMillis
```
public long getOverallTimeRemainingMillis()
```
    Description copied from interface: TransferState
    
    Returns the time remaining in milliseconds for all files
    
    Specified by:
    
    getOverallTimeRemainingMillis in interface TransferState
    
    Overrides:
    
    getOverallTimeRemainingMillis in class TransferHook
    
    Returns:
    
    the time remaining in milliseconds for all files
  - getTimeRemaining
```
public java.lang.String getTimeRemaining()
```
    Description copied from interface: TransferState
    
    Return the time remaining for the current file formatted to a String i.e 5 mins 21 secs
    
    Specified by:
    
    getTimeRemaining in interface TransferState
    
    Overrides:
    
    getTimeRemaining in class TransferHook
    
    Returns:
    
    the time remaining for the current file formatted to a String
  - getOverallTimeRemaining
```
public java.lang.String getOverallTimeRemaining()
```
    Description copied from interface: TransferState
    
    Return the time remaining for the all files formatted to a String i.e 5 mins 21 secs
    
    Specified by:
    
    getOverallTimeRemaining in interface TransferState
    
    Overrides:
    
    getOverallTimeRemaining in class TransferHook
    
    Returns:
    
    the time remaining for the all files formatted to a String
  - getTransferMetrics
```
public UDPTransferMetricsContainer getTransferMetrics()
```
    Returns transfer metric container specific to UDP transfers. Statistics gathered by UDPTransmitter and UDPReceiver, and passed down the food chain by the ClientEngine -> TransferHook (Receive/Transmit Handler) -> Upload/Download Transfer classes If nothing is transferring, an empty container is passed through with stats values set to zero.
    
    Overrides:
    
    getTransferMetrics in class TransferHook
    
    Returns:
    
    UDPTransferMetricsContainer
  - updateObservers
```
public void updateObservers()
```
  - getOverallTransferTime
```
public long getOverallTransferTime()
```
    Description copied from interface: TransferState
    
    Returns the time taken to transfer all files so far in milliseconds
    
    Specified by:
    
    getOverallTransferTime in interface TransferState
    
    Overrides:
    
    getOverallTransferTime in class TransferHook
    
    Returns:
    
    the time taken to transfer all files so far in milliseconds
  - getFormattedOverallTransferTime
```
public java.lang.String getFormattedOverallTransferTime()
```
    Description copied from interface: TransferState
    
    Returns the time taken to transfer all files formatted to a String i.e 5 mins 21 secs
    
    Specified by:
    
    getFormattedOverallTransferTime in interface TransferState
    
    Overrides:
    
    getFormattedOverallTransferTime in class TransferHook
    
    Returns:
    
    the time taken to transfer all files formatted to a String i.e 5 mins 21 secs
  - getFormattedCurrentFileTransferTime
```
public java.lang.String getFormattedCurrentFileTransferTime()
```
    Description copied from interface: TransferState
    
    Returns a human readable file transfer time
    
    Specified by:
    
    getFormattedCurrentFileTransferTime in interface TransferState
    
    Overrides:
    
    getFormattedCurrentFileTransferTime in class TransferHook
    
    Returns:
    
    Human readable transfer time
  - getFormattedTransferTime
```
public java.lang.String getFormattedTransferTime()
```
    Description copied from interface: TransferState
    
    Returns the time taken to transfer the current file formatted to a String i.e 5 mins 21 secs
    
    Specified by:
    
    getFormattedTransferTime in interface TransferState
    
    Overrides:
    
    getFormattedTransferTime in class TransferHook
    
    Returns:
    
    the time taken to transfer the current file formatted to a String i.e 5 mins 21 secs
  - isTransferComplete
```
public boolean isTransferComplete()
```
    Description copied from interface: TransferState
    
    Returns true if all files are successfully transferred
    
    Specified by:
    
    isTransferComplete in interface TransferState
    
    Specified by:
    
    isTransferComplete in class TransferHook
    
    Returns:
    
    true if all files are successfully transferred
  - isTransferCancelled
```
public boolean isTransferCancelled()
```
    Description copied from interface: TransferState
    
    Returns true if the transfer was cancelled.
    
    Specified by:
    
    isTransferCancelled in interface TransferState
    
    Specified by:
    
    isTransferCancelled in class TransferHook
    
    Returns:
    
    true if the transfer was cancelled.
  - isCancelled
```
public boolean isCancelled()
```
  - isCancelledDueToError
```
public boolean isCancelledDueToError()
```
  - isTransferError
```
public final boolean isTransferError()
```
    Description copied from interface: TransferState
    
    Returns true if an error occured
    
    Specified by:
    
    isTransferError in interface TransferState
    
    Specified by:
    
    isTransferError in interface FilesMatchHandler
    
    Specified by:
    
    isTransferError in class TransferHook
    
    Returns:
    
    true if an error occured
  - isTransferWarning
```
public boolean isTransferWarning()
```
    Description copied from interface: TransferState
    
    Returns true a recoverable transfer warning has occured.
    
    Specified by:
    
    isTransferWarning in interface TransferState
    
    Overrides:
    
    isTransferWarning in class TransferHook
    
    Returns:
    
    boolean true if a recoverable transfer warning has occured.
  - getTransferWarningMessage
```
public java.lang.String getTransferWarningMessage()
```
    Description copied from interface: TransferState
    
    Returns the transfer warning message if a transfer warning has occurred.
    
    Specified by:
    
    getTransferWarningMessage in interface TransferState
    
    Overrides:
    
    getTransferWarningMessage in class TransferHook
    
    Returns:
    
    String the warning message
  - getStatusCode
```
public int getStatusCode()
```
    Description copied from interface: TransferState
    
    Returns the current status code, indicates what is currently happening with the transfer
    
    Specified by:
    
    getStatusCode in interface TransferState
    
    Overrides:
    
    getStatusCode in class TransferHook
    
    Returns:
    
    the current status code
  - getCurrentFilename
```
public java.lang.String getCurrentFilename()
```
    Description copied from interface: TransferState
    
    Returns the name of the file currently being transferred.
    
    Specified by:
    
    getCurrentFilename in interface TransferState
    
    Overrides:
    
    getCurrentFilename in class TransferHook
    
    Returns:
    
    the name of the file currently being transferred.
  - getTransferTime
```
public long getTransferTime()
```
    Description copied from interface: TransferState
    
    Returns the transfer time for the total transfer in milliseconds
    
    Specified by:
    
    getTransferTime in interface TransferState
    
    Overrides:
    
    getTransferTime in class TransferHook
    
    Returns:
    
    the transfer time for the total transfer in milliseconds
  - getTransferStartTime
```
public long getTransferStartTime()
```
    Description copied from interface: TransferState
    
    Returns the transfer start time for the total transfer in milliseconds
    
    Specified by:
    
    getTransferStartTime in interface TransferState
    
    Overrides:
    
    getTransferStartTime in class TransferHook
    
    Returns:
    
    the transfer start time for the total transfer in milliseconds
  - getLogFiles
```
public unlimited.core.util.common.logs.LogUtils getLogFiles()
```
  - setLogFiles
```
public void setLogFiles(unlimited.core.util.common.logs.LogUtils logFiles)
```
  - setAutoZip
```
public void setAutoZip(boolean b)
```
  - isAutoZip
```
public boolean isAutoZip()
```
  - isOptimizeBlocksize
```
public boolean isOptimizeBlocksize()
```
  - setOptimizeBlocksize
```
public void setOptimizeBlocksize(boolean optimizeBlocksize)
```
  - downgradeFileTransferMode
```
protected void downgradeFileTransferMode()
```
  - renameExtension
```
protected void renameExtension(java.nio.file.Path file,
                               java.lang.String rFile)
                        throws FCException,
                               java.io.IOException
```
    OTIS feature, rename the extensions on the local and remote files from RDY to PKD
    
    Parameters:
    
    file -
    
    rFile -
    
    Throws:
    
    FCException
    
    java.io.IOException
  - filesMatchBackground
```
protected void filesMatchBackground(java.nio.file.Path file,
                                    java.lang.String rFile)
                             throws FCException,
                                    java.io.IOException
```
    Throws:
    
    FCException
    
    java.io.IOException
  - filesMatch
```
protected MD5Result filesMatch(java.nio.file.Path file,
                               java.lang.String rFile)
                        throws FCException,
                               java.io.IOException
```
    Throws:
    
    FCException
    
    java.io.IOException
  - filesMatch
```
public static MD5Result filesMatch(java.nio.file.Path file,
                                   java.lang.String rFile,
                                   boolean invalidateRemoteMD5CacheEntry,
                                   FilesMatchHandler filesMatchHandler)
                            throws java.io.IOException,
                                   FCException
```
    Throws:
    
    java.io.IOException
    
    FCException
  - filesMatchPartial
```
public static MD5Result filesMatchPartial(java.nio.file.Path file,
                                          java.lang.String rFile,
                                          long checkInterval,
                                          long checkLength,
                                          boolean invalidateRemoteMD5CacheEntry,
                                          FilesMatchHandler filesMatchHandler)
                                   throws java.io.IOException,
                                          FCException
```
    Throws:
    
    java.io.IOException
    
    FCException
  - filesMatch
```
protected MD5Result filesMatch(java.nio.file.Path file,
                               java.lang.String rFile,
                               boolean invalidateRemoteMD5CacheEntry)
                        throws FCException,
                               java.io.IOException
```
    Throws:
    
    FCException
    
    java.io.IOException
  - filesMatchPartial
```
protected MD5Result filesMatchPartial(java.nio.file.Path file,
                                      java.lang.String rFile,
                                      long checkInterval,
                                      long checkLength)
                               throws FCException,
                                      java.io.IOException
```
    Throws:
    
    FCException
    
    java.io.IOException
  - permissionsAllowForDeltasTransfer
```
protected boolean permissionsAllowForDeltasTransfer()
```
    Check to see if the permissions on teh server are OK for doing Deltas
    
    Returns:
  - fileRegionMatch
```
protected boolean fileRegionMatch(java.nio.file.Path file,
                                  java.lang.String rFile,
                                  long offset,
                                  long length)
```
  - initializeProgressiveDelay
```
protected void initializeProgressiveDelay()
```
  - initializeTransferHeadersEachAppend
```
protected void initializeTransferHeadersEachAppend()
```
  - checkForServerTimeout
```
public boolean checkForServerTimeout()
```
    Specified by:
    
    checkForServerTimeout in interface FilesMatchHandler
  - setBandwidth
```
public void setBandwidth(int bandwidth)
```
  - isIncremental
```
public boolean isIncremental()
```
  - setIncremental
```
public void setIncremental(boolean incremental)
```
  - isIncrementalSizeCheckOnly
```
public boolean isIncrementalSizeCheckOnly()
```
  - setIncrementalSizeCheckOnly
```
public void setIncrementalSizeCheckOnly(boolean incrementalSizeCheckOnly)
```
  - getIncTransferOption
```
public int getIncTransferOption()
```
  - isTransferUsingDeltas
```
protected boolean isTransferUsingDeltas()
```
  - setCompressionMethod
```
public void setCompressionMethod(int compMethod)
```
  - getCompressionMethod
```
public int getCompressionMethod()
```
  - setCompressionLevel
```
public void setCompressionLevel(int compLevel)
```
  - getCompressionLevel
```
public int getCompressionLevel()
```
  - setCompressionStrategy
```
public void setCompressionStrategy(int cs)
```
  - getCompressionStrategy
```
public int getCompressionStrategy()
```
  - setIncTransferOption
```
public void setIncTransferOption(int incTransferOption)
```
  - isAutoResume
```
public boolean isAutoResume()
```
  - setAutoResume
```
public void setAutoResume(boolean autoResume)
```
  - getTransferMode
```
public int getTransferMode()
```
    Description copied from interface: TransferState
    
    Returns the current transfer mode
    
    Specified by:
    
    getTransferMode in interface TransferState
    
    Overrides:
    
    getTransferMode in class TransferHook
    
    Returns:
    
    current transfer mode
  - setTransferMode
```
public void setTransferMode(int transferMode)
```
  - isSecure
```
public boolean isSecure()
```
    Description copied from interface: TransferState
    
    Returns true if transfer is secure
    
    Specified by:
    
    isSecure in interface TransferState
    
    Overrides:
    
    isSecure in class TransferHook
    
    Returns:
    
    true if transfer is secure
  - getCountTransferred
```
public int getCountTransferred()
```
    Description copied from interface: TransferState
    
    Returns the number of files that were actually transferred. This differs from getFilesSofar() in that it only includes files that actually got transferred. Some may be skipped because incremental is set to true and had not changed on the server.
    
    Specified by:
    
    getCountTransferred in interface TransferState
    
    Overrides:
    
    getCountTransferred in class TransferHook
    
    Returns:
    
    number of files actually transferred
  - isProgressiveTransfers
```
public boolean isProgressiveTransfers()
```
  - setProgressiveTransfers
```
public void setProgressiveTransfers(boolean progressiveTransfers)
```
  - setProgressiveTimeout
```
public void setProgressiveTimeout(int i)
```
  - getProgressiveTimeout
```
public int getProgressiveTimeout()
```
  - setProgressiveTimeoutFilter
```
public void setProgressiveTimeoutFilter(java.lang.String i)
```
  - getProgressiveTimeoutFilter
```
public java.lang.String getProgressiveTimeoutFilter()
```
  - isStorTmp
```
public boolean isStorTmp()
```
  - setStorTmp
```
public void setStorTmp(boolean storTmp)
```
  - isPreservePathStructure
```
public boolean isPreservePathStructure()
```
  - isUseCompression
```
public boolean isUseCompression()
```
  - getTmpMode
```
public int getTmpMode()
```
  - getCompFileFilter
```
public java.lang.String getCompFileFilter()
```
  - getUniqueID
```
public java.lang.String getUniqueID()
```
  - getActiveIndex
```
public int getActiveIndex()
```
  - removeIndex
```
public void removeIndex(int index)
```
  - getMinimumDeltaSize
```
public static long getMinimumDeltaSize(long sourceFileSize,
                                       long destFileSize)
```
  - getMaximumDeltaSize
```
public static long getMaximumDeltaSize(long sourceFileSize,
                                       long destFileSize)
```
  - shouldPerformIncremental
```
public static boolean shouldPerformIncremental(long sourceFileSize,
                                               long destFileSize)
```
  - main
```
public static void main(java.lang.String[] args)
```
  - getSizeTransferredAlreadyCurrentFile
```
public long getSizeTransferredAlreadyCurrentFile()
```
    Description copied from interface: TransferState
    
    Returns the number of bytes that were already transferred for this file (usually due to a resume)
    
    Specified by:
    
    getSizeTransferredAlreadyCurrentFile in interface TransferState
    
    Overrides:
    
    getSizeTransferredAlreadyCurrentFile in class TransferHook
    
    Returns:
    
    long the number of bytes that were already transferred for this file (usually due to a resume)
  - getSizeTransferredAlreadyAllFiles
```
public long getSizeTransferredAlreadyAllFiles()
```
    Size of files which are already found on the destination, if incremental is on and file was skipped or if file transfer was resumed where 2 GB of data was there and you are continuing last 2GB of data.
    
    Specified by:
    
    getSizeTransferredAlreadyAllFiles in interface TransferState
    
    Overrides:
    
    getSizeTransferredAlreadyAllFiles in class TransferHook
    
    Returns:
  - getLocalWorkingDirectory
```
public java.nio.file.Path getLocalWorkingDirectory()
```
  - setPreservePathStructure
```
public void setPreservePathStructure(boolean preservePathStructure)
```
  - setUseCompression
```
public void setUseCompression(boolean useCompression)
```
  - setTmpMode
```
public void setTmpMode(int tmpMode)
```
  - setCompFileFilter
```
public void setCompFileFilter(java.lang.String compFileFilter)
```
  - setUniqueID
```
public void setUniqueID(java.lang.String uniqueID)
```
  - setAvgRTT
```
public void setAvgRTT(long avgRTT)
```
  - setLocalWorkingDirectory
```
@Deprecated
public void setLocalWorkingDirectory(java.lang.String localWorkingDirectory)
```
    Deprecated.
  - setLocalWorkingDirectory
```
public void setLocalWorkingDirectory(java.nio.file.Path localWorkingDirectory)
```
  - deleteLocalFiles
```
protected void deleteLocalFiles(java.util.LinkedList<java.nio.file.Path> tmpFileList)
```
    Attempts to delete all files marked in temp file list locally. This allows the TransmitHandlers and RecieveHandlers to build up a list of files during deltas and have them deleted automatically in a try-finally block after the procedure exits.
    
    Parameters:
    
    tmpFileList - LinkedList LinkedList of Files that must be deleted.
  - deleteRemoteFileNames
```
protected void deleteRemoteFileNames(java.util.LinkedList<java.lang.String> tmpFileList)
```
    Attempts to delete all remote files marked in temp file list. This allows the TransmitHandlers and RecieveHandlers to build up a list of files during deltas and have them deleted automatically in a try-finally block after the procedure exits.
    
    Parameters:
    
    tmpFileList - LinkedList LinkedList of filenames that must be deleted.
  - getSignatureFilename
```
public static java.lang.String getSignatureFilename(java.lang.String originalFilename,
                                                    java.lang.String uniqueID)
```
    Returns the delta filename used when caculating signatures during a transfer. Unique name allows multiple signatures to be generated by multiple clients on the same file concurrently.
    
    Parameters:
    
    originalFilename - String
    
    uniqueID - String
    
    Returns:
    
    String
  - getDeltaFilename
```
public static java.lang.String getDeltaFilename(java.lang.String originalFilename,
                                                java.lang.String uniqueID)
```
    Returns the delta filename used when caculating deltas during a transfer. Unique name allows multiple deltas to be generated by multiple clients on the same file concurrently.
    
    Parameters:
    
    originalFilename - String
    
    uniqueID - String
    
    Returns:
    
    String
  - getMD5Key
```
public static java.lang.String getMD5Key(java.nio.file.Path file)
```
  - isAddSkippedFilesToTransferVector
```
public boolean isAddSkippedFilesToTransferVector()
```
  - getRemoteWorkingDirectory
```
public java.lang.String getRemoteWorkingDirectory()
```
  - getMaxTries
```
public int getMaxTries()
```
  - getWaitRetry
```
public long getWaitRetry()
```
  - isTransferEmptyDirectories
```
public boolean isTransferEmptyDirectories()
```
  - getCallbackHandler
```
public FileCatalystClientCallbackHandler getCallbackHandler()
```
  - getRegex
```
public java.lang.String getRegex()
```
  - getPostURL
```
public java.lang.String getPostURL()
```
  - isDeletePartial
```
public boolean isDeletePartial()
```
  - setAddSkippedFilesToTransferVector
```
public void setAddSkippedFilesToTransferVector(boolean addSkippedFilesToTransferVector)
```
  - setSizeCurrentFile
```
public void setSizeCurrentFile(long sizeCurrentFile)
```
  - setRemoteWorkingDirectory
```
public void setRemoteWorkingDirectory(java.lang.String remoteWorkingDirectory)
```
  - setMaxTries
```
public void setMaxTries(int maxTries)
```
  - setWaitRetry
```
public void setWaitRetry(long waitRetry)
```
  - setTransferEmptyDirectories
```
public void setTransferEmptyDirectories(boolean transferEmptyDirectories)
```
  - setCallbackHandler
```
public void setCallbackHandler(FileCatalystClientCallbackHandler callbackHandler)
```
  - setRegex
```
public void setRegex(java.lang.String regex)
```
  - checkRegex
```
public boolean checkRegex(java.lang.String filename)
```
  - setPostURL
```
public void setPostURL(java.lang.String postURL)
```
  - setDeletePartial
```
public void setDeletePartial(boolean deletePartial)
```
  - handleError
```
public void handleError(java.lang.String postURL,
                        java.lang.Exception e)
```
    Specified by:
    
    handleError in interface PostURLTransfer.TransferHolder
  - setAppletTransferCache
```
public void setAppletTransferCache(java.util.HashMap<java.lang.String,java.lang.Long> transferCache)
```
  - getPacketLossPercent
```
public double getPacketLossPercent()
```
    Description copied from interface: TransferState
    
    Returns the packet loss percent for the current transfer. Always returns 0 for non-UDP transfers.
    
    Specified by:
    
    getPacketLossPercent in interface TransferState
    
    Overrides:
    
    getPacketLossPercent in class TransferHook
    
    Returns:
    
    packet loss percentage for current transfer
  - getRoundTripTime
```
public int getRoundTripTime()
```
    Description copied from interface: TransferState
    
    Returns the current round trip time
    
    Specified by:
    
    getRoundTripTime in interface TransferState
    
    Overrides:
    
    getRoundTripTime in class TransferHook
    
    Returns:
    
    the current round trip time
  - getVerifyMode
```
public int getVerifyMode()
```
    Returns:
    
    the verifyMode
  - setVerifyMode
```
public void setVerifyMode(int verifyMode)
```
    Parameters:
    
    verifyMode - the verifyMode to set
  - validateVerifyMode
```
public int validateVerifyMode(int verifyMode)
```
  - enableVerifySizeIfNeeded
```
protected void enableVerifySizeIfNeeded()
```
  - verifierRunning
```
public boolean verifierRunning()
```
  - getMd5RateLimit
```
public int getMd5RateLimit()
```
    Specified by:
    
    getMd5RateLimit in interface FilesMatchHandler
    
    Returns:
    
    the md5RateLimit
  - setMd5RateLimit
```
public void setMd5RateLimit(int md5RateLimit)
```
    Parameters:
    
    md5RateLimit - the md5RateLimit to set
  - isRenameExtensions
```
public boolean isRenameExtensions()
```
    Returns:
    
    the renameExtensions
  - setRenameExtensions
```
public void setRenameExtensions(boolean renameExtensions)
```
    Parameters:
    
    renameExtensions - the renameExtensions to set
  - getZipFileSizeLimit
```
public long getZipFileSizeLimit()
```
    Returns:
    
    the zipFileSizeLimit
  - setZipFileSizeLimit
```
public void setZipFileSizeLimit(long zipFileSizeLimit)
```
    Parameters:
    
    zipFileSizeLimit - the zipFileSizeLimit to set
  - isDowngradeModeOnReConnect
```
public boolean isDowngradeModeOnReConnect()
```
    Returns:
    
    the downgradeModeOnReConnect
  - setDowngradeModeOnReConnect
```
public void setDowngradeModeOnReConnect(boolean downgradeModeOnReConnect)
```
    Parameters:
    
    downgradeModeOnReConnect - the downgradeModeOnReConnect to set
  - getCurrentFileTime
```
public long getCurrentFileTime()
```
    Returns:
    
    the currentFileTime
  - calculateAverageKbpsRate
```
protected int calculateAverageKbpsRate(long bytesTotal,
                                       long msTotal)
```
    Calculate a transfer rate in kilo bits per second Kilo here means a 1000, because this is a rate. We're not counting power of 2 sized blocks stored on disk
    
    Parameters:
    
    bytesTotal - - total bytes
    
    msTotal - - total time span in milliseconds
    
    Returns:
    
    rate in kilo bits per second
  - getCurrentFileTransferTime
```
public long getCurrentFileTransferTime()
```
    Description copied from interface: TransferState
    
    Returns the transfer time for the current file in milliseconds
    
    Specified by:
    
    getCurrentFileTransferTime in interface TransferState
    
    Overrides:
    
    getCurrentFileTransferTime in class TransferHook
    
    Returns:
    
    the transfer time for the current file in milliseconds
  - getDirection
```
public int getDirection()
```
    Description copied from interface: TransferState
    
    Returns either UPLOAD or DOWNLOAD constant depending on the direction of this transfer
    
    Specified by:
    
    getDirection in interface TransferState
    
    Overrides:
    
    getDirection in class TransferHook
    
    Returns:
    
    the direction
  - getRemoteFilename
```
public java.lang.String getRemoteFilename()
```
    Description copied from interface: TransferState
    
    Returns the full path of the remote file currently being transferred
    
    Specified by:
    
    getRemoteFilename in interface TransferState
    
    Overrides:
    
    getRemoteFilename in class TransferHook
    
    Returns:
    
    the remoteFilename
  - getLocalFilename
```
public java.lang.String getLocalFilename()
```
    Description copied from interface: TransferState
    
    Returns the full path of the local file currently being transferred
    
    Specified by:
    
    getLocalFilename in interface TransferState
    
    Overrides:
    
    getLocalFilename in class TransferHook
    
    Returns:
    
    the localFilename
  - logFinalTransferStats
```
public void logFinalTransferStats(java.nio.file.Path file)
```
    Parameters:
    
    file -
  - getFilter
```
public FileCatalystFileFilter getFilter()
```
    Returns:
    
    the filter
  - setFilter
```
public void setFilter(FileCatalystFileFilter filter)
```
    Parameters:
    
    filter - the filter to set
  - passesProgressiveTimeoutFilter
```
protected boolean passesProgressiveTimeoutFilter(java.lang.String sourceFile)
```
  - calculateEffectiveRateOfZipTransfer
```
public int calculateEffectiveRateOfZipTransfer(long sizeOfAllFilesZipped,
                                               long timeForEffectiveRate)
```
  - verifySize
```
protected void verifySize(java.nio.file.Path file,
                          java.lang.String rFile)
```
  - verifyFileContents
```
protected void verifyFileContents(java.nio.file.Path file,
                                  java.lang.String rfile,
                                  boolean invalidateRemoteCache)
                           throws FCException,
                                  java.io.IOException
```
    Throws:
    
    FCException
    
    java.io.IOException
  - incrementSofarAllFiles
```
protected void incrementSofarAllFiles(boolean isADeltaTransfer,
                                      long dataSize)
```
  - doesDirectoryContainContents
```
protected abstract boolean doesDirectoryContainContents(T t)
```
  - filterEmptyDirectoriesIfNeeded
```
protected void filterEmptyDirectoriesIfNeeded()
```
  - setParentPooled
```
public void setParentPooled(boolean pooled)
```
  - getClient
```
public FCClientEngine getClient()
```
    Specified by:
    
    getClient in interface FilesMatchHandler
  - logMessage
```
public void logMessage(java.util.logging.Level info,
                       java.lang.String string)
```
    Specified by:
    
    logMessage in interface PostURLTransfer.TransferHolder
    
    Specified by:
    
    logMessage in interface FilesMatchHandler
  - getAvgMD5TimePerKB
```
public long getAvgMD5TimePerKB()
```
    Specified by:
    
    getAvgMD5TimePerKB in interface FilesMatchHandler
  - setAvgMD5TimePerKB
```
public void setAvgMD5TimePerKB(long avgMD5TimePerKB)
```
    Specified by:
    
    setAvgMD5TimePerKB in interface FilesMatchHandler
  - getCancelHandler
```
public CancelHandler getCancelHandler()
```
    Specified by:
    
    getCancelHandler in interface FilesMatchHandler
  - getPreservePathStructureFileName
```
public static java.lang.String getPreservePathStructureFileName(java.lang.String lFile)
```
  - setAutoUnzip
```
public void setAutoUnzip(boolean b)
```
  - isAutoUnzip
```
public boolean isAutoUnzip()
```
  - addTransferredRemoteFile
```
public void addTransferredRemoteFile(java.lang.String filename)
```
  - addTransferredLocalFile
```
public void addTransferredLocalFile(java.lang.String filename)
```
  - waitForDiscWriteProgressives
```
public static void waitForDiscWriteProgressives(MultiTransferHandler<?> handler)
```
  - handleProgressiveDelayBeforeAppend
```
public void handleProgressiveDelayBeforeAppend()
```
  - updateStatusTransferring
```
protected final void updateStatusTransferring()
```
  - getRetransferHeaderSize
```
public long getRetransferHeaderSize()
```
    Returns:
    
    the retransferHeaderSize
  - setRetransferHeaderSize
```
public void setRetransferHeaderSize(long retransferHeaderSize)
```
    Parameters:
    
    retransferHeaderSize - the retransferHeaderSize to set
  - getClientAPI
```
public FCClient getClientAPI()
```
    Returns:
    
    the clientAPI
  - setClientAPI
```
public void setClientAPI(FCClient clientAPI)
```
    Parameters:
    
    clientAPI - the clientAPI to set
  - killAll
```
public void killAll()
```
    Overrides:
    
    killAll in class TransferHook
  - setLocalMD5
```
public void setLocalMD5(java.lang.String localMD5)
```
    Specified by:
    
    setLocalMD5 in interface FilesMatchHandler
  - setRemoteMD5
```
public void setRemoteMD5(java.lang.String remoteMD5)
```
    Specified by:
    
    setRemoteMD5 in interface FilesMatchHandler

Class MultiTransferHandler<T>

Field Summary

Fields inherited from class unlimited.fc.client.api.TransferHook

Constructor Summary

Method Summary

Methods inherited from class unlimited.fc.client.api.TransferHook

Methods inherited from class java.util.Observable

Methods inherited from class java.lang.Object

Methods inherited from interface unlimited.fc.client.transferhandler.FilesMatchHandler

Field Detail

willTransfer

waitForDiscWriteProgressive

statusMessage

countTransferred

filter

lastBytesSoFar

isParentPooled

Constructor Detail

MultiTransferHandler

Method Detail

willTransfer

runHandler

setCancelled

setIsError

setStatusCode

getLastTry

setLastTry

isFatal

setFatal

addObserver

notifyObservers

notifyObservers

run

close

isValidFileCache

getLocalFileTransferIndex

setLocalFileTransferIndex

shouldCompressFile

getAverageSetupTeardown

isDeleteAfterTransfer

setDeleteAfterTransfer

getFilesTransferredRemote

getFilesTransferredLocal

getTransferStatus

getStatus

getAllFilePaths

getAllFileAndSize

setCancelled

getTotalFiles

incrementTotalFiles

getFilesSoFar

setFilesSoFar

updateSofarAllFiles

getStatusMessage

getBytesSoFarCurrentFile

getSizeCurrentFile

getSizeAllFiles

getBytesSoFarAllFilesFull

getBytesSoFarAllFiles

getPercent

getCurrentPercent

getOverallRate

getCurrentEffectiveRate

getMeanEffectiveRate

getRateInKBperSecond

getRateAverage

getEffectiveRateAverage

getCurrentRate

getRateAverageInKBperSecond

getEffectiveRateAverageInKBperSecond

getOverallRateInKBperSecond

getTimeRemainingMillis

getOverallTimeRemainingMillis

getTimeRemaining

getOverallTimeRemaining

getTransferMetrics

updateObservers

getOverallTransferTime

getFormattedOverallTransferTime

getFormattedCurrentFileTransferTime