TransferMechanismData (FileCatalyst Client API)

java.lang.Object
- java.util.Dictionary<K,V>
- - java.util.Hashtable<java.lang.Object,java.lang.Object>
  - - java.util.Properties
    - - unlimited.core.util.common.ConfigTool
      - unlimited.fc.client.api.TransferMechanismData

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.Object,java.lang.Object>, unlimited.fc.client.api.filelist.FileListDataItemSource, FileTransferData
```
public class TransferMechanismData
extends unlimited.core.util.common.ConfigTool
implements FileTransferData, java.lang.Cloneable
```
A data container class that holds all information that TransferMechanisms use to perform their integral logic

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class TransferMechanismData.ServletLocationData
Data object that contains the current Servlet information.

Nested Classes
Modifier and Type	Class and Description
`class`	`TransferMechanismData.ServletLocationData` Data object that contains the current Servlet information.

Field Summary

Fields
Modifier and Type Field and Description

protected CompressionData compressionData
- Fields inherited from class java.util.Properties
  defaults

Fields
Modifier and Type	Field and Description
`protected CompressionData`	`compressionData`

Constructor Summary

Constructors
Constructor and Description
`TransferMechanismData()` Default constructor for the TranfserMechanismData class
`TransferMechanismData(java.util.Properties incProperties)` Constructor that loads a TransferMechanismData object from a supplied properties object

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`cd(java.lang.String path)` Sets the current remote working directory to the specified path.
`TransferMechanismData`	`clone()` Clone method that generates an independent copy of this object
`void`	`delete(java.lang.String file)` Do not use this method, it only throws an exception, was put in during the effort to unify listings between single and multi client
`static void`	`exportFile(java.nio.file.Path aFile, FileTransferData source)` Exports the supplied FileTransferData data as properties and writes the information to the specified file path
`static java.util.Properties`	`exportProperties(FileTransferData source)` Exports the supplied FileTransferData data into a standard properties object
`void`	`get(java.lang.String localPath, java.lang.String remoteFile, int inRate, long offset, long size, int numDFEncoders, int blockSize, int unitSize, int mode)` Do not use this method, it only throws an exception, was put in during the effort to unify listings between single and multi client
`int`	`getBlastRate()` Returns the implementation's current blast rate
`int`	`getBlockSize()` Return the current block size.
`FileCatalystClientCallbackHandler`	`getCallbackHandler()` Returns the currently set callback handler that will be used to confirm resume, overwrite and to do post processing
`java.lang.String`	`getClientAgentID()` Returns the client's agent ID.
`java.lang.String`	`getClientConnectKey()` Returns the client connect key, used to connect to non-FileCatalyst servers
`java.util.function.Supplier<ClientCredentials>`	`getClientCredentials()` Returns the credentials supplier that is set for this client.
`int`	`getClientIdentifier()` Returns the identifier for this transfer mechanism.
`java.lang.String`	`getClientName()` Used for HotFolder Reporting, And CSV Reports
`java.lang.String`	`getClientString()` Returns the client string for this transfer mechanism.
`int`	`getClientSubIdentifier()` Returns the current sub identifier that identifies this client as a sub component of a broader group of client apps.
`java.lang.String`	`getCompFileFilter()` Sets the compression FileFilter that is to be used by the implementation.
`int`	`getCompLevel()` Returns the current compression level (0 - 9).
`int`	`getCompMethod()` Returns the current compression method to be used during transfers.
`CompressionData`	`getCompressionData()` Returns a data object containing the compression data for the TransferMechanism
`int`	`getCompStrategy()` Returns the current compression deflater strategy that will be used in the current compression method to minimize the data and compress into smaller byte values.
`int`	`getCongCtrlStrategy()` Returns the current congestion control strategy.
`int`	`getCongestionControlAggression()` Returns an aggression factor between 1 (passive) and 10 (aggressive) used by the congestion control mechanism to determine how passive or aggressive it should be in the face of network congestion.
`int`	`getConnectTimeout()` Return the connect timeout value (in milliseconds)
`int`	`getExtendedReadTimeout()` This is the length of time in milliseconds the client will wait for a reply after sending a long running command (such as MD5, MKDLT, MKSIG, ZIP, UNZIP) to the FileCatalyst server.
`FileCatalystFileFilter`	`getFileFilter()` Returns the current file filter that is used to filter out information for a transfer.
`int`	`getFileTransferPriority()` Returns the task file transfer priority
`java.lang.String`	`getForceFileOwnershipGroup()` Returns the groupname / groupID to be used when attempting to force group level ownership for files downloaded by the client.
`java.lang.String`	`getForceFileOwnershipUser()` Returns the username to be used when attempting to force file ownership for files downloaded by the client
`int`	`getIncomingDataPort()` Returns the port used for incoming UDP packets on downloads Only the first port will be returned in the case of v3.0 where multi-receive sockets have been enabled.
`int[]`	`getIncomingDataPorts()` Returns the list of ports used for incoming UDP packets on downloads
`int`	`getIncrementalMode()` Returns the current incremental mode.
`java.nio.file.Path`	`getLocalWorkingDirectoryPath()`
`unlimited.core.util.common.logs.LogUtils`	`getLogger()` Returns the logger that is used
`java.lang.String`	`getLogLocation()` Returns the current location for the log files.
`int`	`getMaxRetries()` Returns the number of times to retry a broken or interrupted transfer.
`int`	`getMd5RateLimit()` Returns the current MD5 that is set.
`int`	`getMode()` The current transfer mode of this client.
`int`	`getNumBlockReaders()` Returns the number of block reader threads.
`int`	`getNumBlockWriters()` Returns the number of block writer threads.
`int`	`getNumFTPStreams()` Returns the number of concurrent streams that will be used for FTP transfers
`int`	`getNumPacketProcessors()` Return the current number of packet processor threads.
`int`	`getNumReceiveSockets()` Returns the current number of receive sockets.
`int`	`getNumSenderSockets()` Return the number of Sender sockets to use
`int`	`getNumSenderThreads()` Returns the number of threads that will be used at most for each FC transmission.
`int`	`getNumThreads()` Returns the number of threads that will be used at most for each FC transmission.
`int`	`getNumUDPSockets()` Return the number of Sender sockets to use
`java.util.Observer`	`getObserver()` Returns the Observer that is currently set.
`int`	`getPacketQueueDepth()` Return the current packet queue depth.
`int`	`getPacketSize()` Returns the current packet size in bytes.
`PostTaskSentData`	`getPostTaskSentData()` Returns the current post task sent data
`java.lang.String`	`getPostURL()` Returns the current post URL to use
`int`	`getProgressiveTimeout()` Returns the current progressive timeout value.
`java.lang.String`	`getProgressiveTimeoutFilter()` Returns the current progressive timeout filter.
`int`	`getReadBufferSizeKB()` Return the current read buffer size, in KB Value zero (0) indicates read buffer is dictated by the network block size.
`int`	`getReadTimeout()` This is the length of time in milliseconds the client will wait for a reply after sending a command to the FileCatalyst server.
`int`	`getRemotePort()` Gets the remote port to which this client will be connected.
`java.lang.String`	`getRemoteServer()` This method returns the remote server / hostname to which this client is connected.
`boolean`	`getRenameExtension()` Returns whether or not the rename extension will be used.
`java.lang.String`	`getServerAgentID()` Returns the server's current agent ID.
`int`	`getServerOverrideBandwidth()` Returns the override bandwidth value that has been specified by server.
`java.lang.String`	`getServletLocation()` FileCatalyst has the ability to upload using the HTTP/S protocol as long as the FileCatalyst Servlet application is installed and properly configured.
`TransferMechanismData.ServletLocationData`	`getServletLocationData()` Generates and returns a data object containing all of the information relating to the Servlet
`int`	`getServletMultiplier()` When uploading in HTTP mode using FileCatalyst Servlet, this option allows the upload buffer size to be tuned.
`int`	`getSessionCount()` Returns the current number of active sessions that the implementation has
`java.lang.String`	`getSessionID()` Returns the current session ID of the implementation
`unlimited.core.transfers.net.ssl.FCSSLSocketProducerImpl`	`getSSLSocketProducer()` Retrieves the implementation that will be used to generate SSL sockets
`int`	`getStartRate()` Returns the current start rate for FC transfers.
`void`	`getSynchedFrom(FileTransferData master)` Syncs the supplied FileTransferData instance to this data object.
`int`	`getTargetRate()` Returns the current target rate for this client.
`java.lang.String`	`getTaskID()` Returns the current task ID
`int`	`getTempMode()` Returns the temporary mode for the implementation
`java.lang.String`	`getTransactionID()` Returns the current transaction ID that is set.
`boolean`	`getTransferEmptyDirectories()` Returns whether not the implementation is set to transfer empty directories.
`int`	`getTransferRate()` Returns the implementation's current transfer rate
`int`	`getUnitSize()` Use getPacketSize
`int`	`getUserRelativePriority()` This priority hint is to help the server distribute bandwidth within its own set parameters.
`int`	`getVerifyMode()` Returns the current integrity verification mode.
`long`	`getWaitRetry()` Returns the amount of milliseconds to wait between retries for failed transfers.
`int`	`getWriteBufferSizeKB()` Return the current write buffer size.
`java.lang.String`	`getWriteFileMode()` Gets the file write mode set Client application will use these values for downloads only.
`long`	`getZipFileSizeLimit()` Returns the zip file size limit in bytes.
`static void`	`importFile(java.nio.file.Path aFile, FileTransferData destination)` Imports the properties defined within a file, and synchs them with to the supplied FileTransferData object
`static void`	`importProperties(java.util.Properties props, FileTransferData destination)` Imports the properties information and synchs them with to the supplied FileTransferData object
`void`	`initializeWorkingDirectory(java.lang.String pwd)` Initializes the current working directory to the value specified.
`boolean`	`isAutoResume()` Returns true if auto-resume is enabled.
`boolean`	`isAutoUnzip()` Returns true if auto unzip is enabled, false otherwise.
`boolean`	`isAutoZip()` Returns true if auto zip is enabled, false otherwise.
`boolean`	`isCompressionEnabled()` Returns true if compression is enabled, false otherwise.
`boolean`	`isCongestionControlEnabled()` Returns true if congestion control is currently enabled.
`boolean`	`isCurrentStateConnected()` Returns whether or not the current transfer mechanism is connected
`boolean`	`isDebug()` Returns true if debug is set to true.
`boolean`	`isDeleteAfterTransfer()` Returns true if the delete after transfer option is enabled, false otherwise.
`boolean`	`isDowngradeModeOnReConnect()` Returns true if the downgrade on reconnect option is enabled, false otherwise.
`boolean`	`isFileCatalystServer()` Do not use this method, it only throws an exception, was put in during the effort to unify listings between single and multi client
`boolean`	`isForceFileOwnershipEnabled()` Returns true if the force file ownership feature is currently enabled.
`boolean`	`isForceTCPmodeACKs()` Returns true if TCP mode ACKs are enabled.
`boolean`	`isIncrementalSizeCheckOnly()` Returns whether or not incremental has been set to use the size only option
`boolean`	`isMaintainLastModified()` Returns true if Maintain last modified is enabled.
`boolean`	`isMaintainPermissions()` Returns true if maintain permissions is enabled.
`boolean`	`isOptimizeBlockSize()` Returns true if optimize block size feature is enabled.
`boolean`	`isProgressiveTransfers()` Return true if the progressive option is enabled, false otherwise.
`boolean`	`isServerOverridebandwidth()` Returns whether or not the server has specified that the bandwidth should be overridden.
`boolean`	`isShowConsoleLog()` Returns true if console log is enabled.
`boolean`	`isTransferEmptyDirectories()` Returns whether or not the implementation should be transferring empty directories
`boolean`	`isTransferWithTempName()` Returns true if transferring with temporary names is enabled
`boolean`	`isUseCompression()` Returns true if compression is enabled, false otherwise.
`boolean`	`isUseCongestionControl()` Returns true if congestion control is currently enabled.
`boolean`	`isUseIncremental()` Returns true if incremental feature is enabled
`boolean`	`isUseSSL()` Returns true if SSL mode is enabled, false otherwise.
`boolean`	`isVerifyIntegrity()` Returns true if integrity check is enabled.
`boolean`	`isWorkingDirectoryInitialized()` Returns whether or not the working directory is currently initialized.
`int`	`lastServerRestrictedRate()` Returns the last rate (kbps) that the Server had replied with.
`FileListData`	`list()` Do not use this method, it only throws an exception, was put in during the effort to unify listings between single and multi client
`protected void`	`loadFromChannel(java.nio.channels.SeekableByteChannel channel)`
`void`	`loadFromFile(java.nio.file.Path propFile)`
`void`	`loadFromProperties()`
`java.lang.String[]`	`prms(java.lang.String filename)` Do not use this method, it only throws an exception, was put in during the effort to unify listings between single and multi client
`java.lang.String`	`pwd()` Returns the current remote working directory.
`void`	`saveToFile(java.nio.file.Path propFile)`
`void`	`saveToProperties()`
`void`	`setAutoResume(boolean autoResume)` Enables/disables auto resume feature.
`void`	`setAutoUnzip(boolean autoUnzip)` Enables/disables auto unzip feature.
`void`	`setAutoZip(boolean autoZip)` Enables/disables auto zip feature.
`void`	`setBlockSize(int blockSize)` Set the block size.
`void`	`setCallbackHandler(FileCatalystClientCallbackHandler callbackHandler)` Sets a callback handler that will be used to confirm resume, overwrite and to do post processing
`void`	`setClientAgentID(java.lang.String clientAgentID)` Sets the current client agent ID to the new specified value.
`void`	`setClientConnectKey(java.lang.String clientConnectKey)` This key must be set in order to connect to non-FileCatalyst servers.
`void`	`setClientCredentials(java.util.function.Supplier<ClientCredentials> creds)` Sets the credentials supplier for this connection.
`void`	`setClientIdentifier(int clientIdentifier)` An ID value that identifies this client to the FileCatalyst Server.
`void`	`setClientName(java.lang.String clientName)` Sets the current client name to the value that is specified
`void`	`setClientString(java.lang.String clientString)` Set a text string that will be displayed on the server UI to identify this client.
`void`	`setClientSubIdentifier(int id)` Sets an ID that further identifies this client
`void`	`setClientWorkingPath(java.nio.file.Path clientWorkingPath)` Sets the client's current working path to the value specified
`void`	`setCompFileFilter(java.lang.String compFileFilter)` Sets the compression FileFilter that is to be used by the implementation
`void`	`setCompLevel(int compLevel)` Sets the compression level (0 - 9 with default of 4).
`void`	`setCompMethod(int compMethod)` Sets the current compression method to be used during transfers.
`void`	`setCompressionData(CompressionData compressionData)`
`void`	`setCompressionDataFromClient(FileTransferMechanism client)`
`void`	`setCompressionEnabled(boolean compressionEnabled)` Enables/disables on the fly compression.
`void`	`setCompStrategy(int compStrategy)` Sets the compression deflater strategy that will be used within the compression method to minimize the data and compress into smaller byte values.
`void`	`setCongCtrlStrategy(int congCtrlStrategy)` Sets the congestion control strategy.
`void`	`setCongestionControlAggression(int congestionControlAggression)` Specifies an aggression factor between 1 (passive) and 10 (aggressive) used by the congestion control mechanism to determine how passive or aggressive it should be in the face of network congestion.
`void`	`setCongestionControlEnabled(boolean congestionControlEnabled)` Enables/disables congestion control for this client.
`void`	`setConnectTimeout(int connectTimeout)` Sets the connect timeout value (in milliseconds).
`void`	`setCurrentStateConnected(boolean currentStateConnected)`
`void`	`setDebug(boolean debug)` Turns on debug mode.
`void`	`setDeleteAfterTransfer(boolean deleteAfterTransfer)` With this option enabled, source files will be deleted after the transfer is complete.
`void`	`setDowngradeModeOnReConnect(boolean downgradeModeOnReConnect)` If set to true, if a disconnect occurs during a UDP transfer, upon reconnect and resume, the transfer mode is downgraded to multi-stream TCP, then single stream TCP, and finally HTTP (if available).
`void`	`setExtendedReadTimeout(int extendedReadTimeout)` This is the length of time the client will wait for a reply after sending a long running command (such as MD5, MKDLT, MKSIG, ZIP, UNZIP) to the FileCatalyst server.
`void`	`setFileFilter(FileCatalystFileFilter fileFilter)` Sets the FileFilter that is to be used by the implementation.
`void`	`setFileTransferPriority(int fileTransferPriority)` Sets the FileTransferPrioriry to new new value.
`void`	`setForceFileOwnershipEnabled(boolean isForceFileOwnershipEnabled)` Sets whether or not the force file ownership feature is enabled.
`void`	`setForceFileOwnershipGroup(java.lang.String forceFileOwnershipGroup)` Sets the groupname / groupID to be used when attempting to force group level ownership for files downloaded by the client.
`void`	`setForceFileOwnershipUser(java.lang.String forceFileOwnershipUser)` Sets the username to be used when attempting to force file ownership for files downloaded by the client
`void`	`setForceTCPmodeACKs(boolean forceTCPmodeACKs)` By default, FileCatalyst uses UDP to acknowledge data received.
`void`	`setIncomingDataPort(int incomingDataPort)` Sets the port used for incoming UDP packets on downloads.
`void`	`setIncomingDataPorts(int[] incomingDataPorts)` Sets the port used for incoming UDP packets on downloads.
`void`	`setIncrementalMode(int incrementalMode)` When incremental is enabled, this method allows you to choose the incremental mode.
`void`	`setIncrementalSizeCheckOnly(boolean incrementalSizeCheckOnly)` Setting this value will cause the MD5 checks to be skipped and the files compared using size only.
`void`	`setIsAuto(boolean isAutoMode)`
`void`	`setIsServerOverrideBandwidth(boolean isOverride)`
`void`	`setLastServerRestrictedRate(int actual)`
`void`	`setLocalWorkingDirectory(java.nio.file.Path localWorkingDirecctory)` Sets the Local Working directory.
`void`	`setLogger(unlimited.core.util.common.logs.LogUtils logger)` overriding the logUtils object.
`void`	`setLogLocation(java.lang.String logLocation)` Specifies a directory on the local system where the log file should be stored.
`void`	`setMaintainLastModified(boolean maintainLastModified)` Sets the maintain last modified feature to the value specified.
`void`	`setMaintainPermissions(boolean maintainPermissions)` If set to true, upon each successful transfer, the destination file permissions will be set to match those of the source file.
`void`	`setMaxRetries(int maxRetries)` Specify the number of times to retry a broken or interrupted transfer.
`void`	`setMd5RateLimit(int md5RateLimit)` Sets the rate limit to use when calculating MD5s of files
`void`	`setMode(int mode)` Set the transfer mode of this client.
`void`	`setNumBlockReaders(int numBlockReaders)` Sets the number of block reader threads.
`void`	`setNumBlockWriters(int numBlockWriters)` Sets the number of block writer threads to use when receiving a file.
`void`	`setNumFTPStreams(int numFTPStreams)` When transferring in FTP mode, it is possible to send with several concurrent streams.
`void`	`setNumPacketProcessors(int numPacketProcessors)` Sets the number of threads used to process incoming UDP packets when downloading.
`void`	`setNumReceiveSockets(int numReceiveSockets)` Set the number of UDP sockets to use to receive packets during a UDP download.
`void`	`setNumSenderSockets(int numSenderSockets)` Sets the number of UDP sockets to use when uploading a file in UDP mode.
`void`	`setNumSenderThreads(int numSenderThreads)` This value determines how many blocks will be sent into the pipe before redundant data will be sent.
`void`	`setNumThreads(int numThreads)` This value determines how many blocks will be sent into the pipe before redundant data will be sent.
`void`	`setNumUDPSockets(int numUDPSockets)` Sets the number of UDP sockets to use when uploading a file in UDP mode.
`void`	`setObserver(java.util.Observer obs)` FCClient is not directly observable, however TransferHook is.
`void`	`setOptimizeBlockSize(boolean optimizeBlockSize)` If set to true, FileCatalyst will attempt to optimize the current block size to be an exact multiple of the data size that is being transmitted.
`void`	`setPacketQueueDepth(int packetQueueDepth)` Sets the depth of the application level packet queue.
`void`	`setPacketSize(int packetSize)` Set the unit size.
`void`	`setPostTaskSentData(PostTaskSentData data)` Sets the current post task sent data to the specified value
`void`	`setPostURL(java.lang.String postURL)` Sets the current post URL to the value that is defined
`void`	`setProgressiveTimeout(int progressiveTimeout)` Sets the current progressive timeout to the value supplied
`void`	`setProgressiveTimeoutFilter(java.lang.String progressiveTimeoutFilter)` Sets the current progressive timeout filter to the value that is set to
`void`	`setProgressiveTransfers(boolean progressiveTransfers)` With this option enabled, upon completion of an upload or download, FileCatalyst will compare the size of the source file to the size when it began the transfer.
`void`	`setReadBufferSizeKB(int readBufferSizeKB)` Sets the read buffer size used when reading data from disk.
`void`	`setReadTimeout(int readTimeout)` This is the length of time the client will wait for a reply after sending a command to the FileCatalyst server.
`void`	`setRemotePort(int remotePort)` Sets the remote port to which this client will be connected.
`void`	`setRemoteServer(java.lang.String remoteServer)` Set the remote server to which this client should connect.
`void`	`setRenameExtension(boolean renameExtension)` Sets whether or not the rename extension should be used
`void`	`setServerAgentID(java.lang.String serverAgentID)` Sets the server agent ID to the new value
`void`	`setServerOverrideBandwidth(int totalOverridebandwidth)`
`void`	`setServletLocation(java.lang.String servletLocation)` FileCatalyst has the ability to upload using the HTTP/S protocol as long as the FileCatalyst Servlet application is installed and properly configured.
`void`	`setServletLocation(java.lang.String servletLocation, java.lang.String servletSessionID, java.lang.String welcomeMessage)` FileCatalyst has the ability to upload using the HTTP/S protocol as long as the FileCatalyst Servlet application is installed and properly configured.
`void`	`setServletMultiplier(int servletMultiplier)` When uploading in HTTP mode using FileCatalyst Servlet, this option allows the upload buffer size to be tuned.
`void`	`setSessionCount(int sessionCount)`
`void`	`setSessionID(java.lang.String sessionID)` Sets the session ID to the specified value.
`void`	`setShowConsoleLog(boolean showConsoleLog)` If set to true, all logging information is also sent to standard out.
`void`	`setSSLSocketProducer(unlimited.core.transfers.net.ssl.FCSSLSocketProducerImpl socketProducer)` Sets the implementation that will be used to generate SSL sockets
`void`	`setStartRate(int startRate)` Sets the start rate for FC transfers in Kilobits per second.
`void`	`setTargetRate(int targetRate)` Sets the target rate (kbps) for this client.
`void`	`setTaskID(java.lang.String taskID)` Sets the current task ID to the new value supplied
`void`	`setTransactionID(java.lang.String uniqueID)` Sets a unique transaction number for the transfer (instance variable).
`void`	`setTransferEmptyDirectories(boolean transferEmptyDirectories)` Sets whether or not the implementation should transfer empty directories
`void`	`setTransferRate(int transferRate)`
`void`	`setTransferToServerOverride(int serverOverrideBW)` Sets bandwidth value that the Server is attempting to override this client to.
`void`	`setTransferWithTempName(boolean transferWithTempName)` With this option enabled, files will be uploaded with a temporary filename and renamed back to their original name when the transfer is complete.
`void`	`setTransferWithTempName(boolean transferWithTempName, int tempMode)` With this option enabled, files will be uploaded with a temporary filename and renamed back to their original name when the transfer is complete.
`void`	`setUnitSize(int unitSize)` Use setPacketSize()
`void`	`setUseCompression(boolean useCompression)` Enables/disables on the fly compression.
`void`	`setUseCongestionControl(boolean useCongestionControl)` Enables/disables congestion control for this client.
`void`	`setUseIncremental(boolean useIncremental)` If set to true, before each source file is transferred, it will be compared with the destination file if it exists to ensure the file has changed.
`void`	`setUserRelativePriority(int priority)` This priority hint is to help the server distribute bandwidth within its own set parameters.
`void`	`setUseSSL(boolean useSSL)` If set to true, control connection will be made using an implicit SSL connection.
`void`	`setVerifyIntegrity(boolean verifyIntegrity)` If set to true, after each file is transferred an MD5 sum will be performed on the destination file and the result will be compared to that of the source file to ensure the files are identical.
`void`	`setVerifyMode(int verifyMode)` Sets the integrity verification mode
`void`	`setWaitRetry(long waitRetry)` Sets the amount of time in milliseconds to wait before the client attempts to retry a failed transfer
`void`	`setWriteBufferSizeKB(int writeBufferSizeKB)` Sets the write buffer size used when saving data to disk.
`void`	`setWriteFileMode(java.lang.String writeFileMode)` Set JAVA file write mode when saving data to disk.
`void`	`setZipFileSizeLimit(long zipFileSizeLimit)` Sets the zip file size limit to the value specified.
`long`	`size(java.lang.String remoteFile)` Do not use this method, it only throws an exception, was put in during the effort to unify listings between single and multi client
`java.util.stream.Stream<FileListDataItem>`	`streamWithInlineParse()` Do not use this method, it only throws an exception, was put in during the effort to unify listings between single and multi client
`java.util.stream.Stream<FileListDataItem>`	`streamWithInlineParse(java.util.function.BooleanSupplier isCancelled)` Returns streaming meta data for files in the current remote directory.
`static void`	`synch(FileTransferData client, FileTransferData master)`
`static void`	`synchAndConnect(FileTransferMechanism client, FileTransferData master)`
`static void`	`synchConnectAndCD(FileTransferMechanism client, FileTransferData master)`
`static void`	`synchIgnoreTargetRate(FileTransferData client, FileTransferData master)`
`void`	`synchThisTo(FileTransferData slave)` Syncs this Servlet information to the specified FileTransferData instance

Methods inherited from class unlimited.core.util.common.ConfigTool
buildHandlerMap, getVal, registerMapping, setVal

Methods inherited from class java.util.Properties
getProperty, getProperty, list, list, load, load, loadFromXML, propertyNames, save, setProperty, store, store, storeToXML, storeToXML, stringPropertyNames

Methods inherited from class java.util.Hashtable
clear, compute, computeIfAbsent, computeIfPresent, contains, containsKey, containsValue, elements, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keys, keySet, merge, put, putAll, putIfAbsent, rehash, remove, remove, replace, replace, replaceAll, size, toString, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface unlimited.fc.client.api.FileTransferData
getAutoConnectClientFactory, getLocalWorkingDirectory, isMoveToSent, setLocalWorkingDirectory

Methods inherited from interface unlimited.fc.client.api.filelist.FileListDataItemSource
listAsList

- Field Detail
  - compressionData
```
protected CompressionData compressionData
```
- Constructor Detail
  - TransferMechanismData
```
public TransferMechanismData(java.util.Properties incProperties)
```
    Constructor that loads a TransferMechanismData object from a supplied properties object
    
    Parameters:
    
    incProperties - Properties object containing the transfer mechanism data
  - TransferMechanismData
```
public TransferMechanismData()
```
    Default constructor for the TranfserMechanismData class
- Method Detail
  - clone
```
public TransferMechanismData clone()
```
    Clone method that generates an independent copy of this object
    
    Overrides:
    
    clone in class java.util.Hashtable<java.lang.Object,java.lang.Object>
    
    Returns:
    
    Copy of this object
  - getBlastRate
```
public int getBlastRate()
```
    Description copied from interface: FileTransferData
    
    Returns the implementation's current blast rate
    
    Specified by:
    
    getBlastRate in interface FileTransferData
    
    Returns:
    
    Current transfer rate
  - getBlockSize
```
public int getBlockSize()
```
    Description copied from interface: FileTransferData
    
    Return the current block size. The block size determines how much data each thread will encode and send through the pipe. In higher RTT environments, it might be advantageous to increase this value as it will ensure the pipe is full of data. This however will cause the client side to consume more memory (number of threads * the block size)
    
    Specified by:
    
    getBlockSize in interface FileTransferData
    
    Returns:
    
    the current block size.
  - getCallbackHandler
```
public FileCatalystClientCallbackHandler getCallbackHandler()
```
    Description copied from interface: FileTransferData
    
    Returns the currently set callback handler that will be used to confirm resume, overwrite and to do post processing
    
    Specified by:
    
    getCallbackHandler in interface FileTransferData
    
    Returns:
    
    the callbackHandler
  - getClientAgentID
```
public java.lang.String getClientAgentID()
```
    Returns the client's agent ID. Used when generating reports for file transfers
    
    Returns:
    
    The ID
  - getClientConnectKey
```
public java.lang.String getClientConnectKey()
```
    Description copied from interface: FileTransferData
    
    Returns the client connect key, used to connect to non-FileCatalyst servers
    
    Specified by:
    
    getClientConnectKey in interface FileTransferData
    
    Returns:
    
    String Client Connect Key
  - getClientIdentifier
```
public int getClientIdentifier()
```
    Returns the identifier for this transfer mechanism. List of valid identifiers can be found at FileCatalystClientIdentifiers
    
    Specified by:
    
    getClientIdentifier in interface FileTransferData
    
    Returns:
    
    Number value representing the type of client this TransferMechanismData comes from.
  - getClientString
```
public java.lang.String getClientString()
```
    Returns the client string for this transfer mechanism. Value is displayed on the server UI to identify this client. Value is useful when developing 3rd party applications that are not identified properly by FileCatalyst internal IDs.
    
    Returns:
  - getClientSubIdentifier
```
public int getClientSubIdentifier()
```
    Returns the current sub identifier that identifies this client as a sub component of a broader group of client apps. For example, client id 9 means FC Web, but doesn't indicate which applet is connecting. Or CLI identifier doesn't let you know if its Java or C++ CLI.
    
    Returns:
    
    Integer representing the sub identifier
  - getCompFileFilter
```
public java.lang.String getCompFileFilter()
```
    Description copied from interface: FileTransferData
    
    Sets the compression FileFilter that is to be used by the implementation. If a file is queued for compression and sucessfully passes this filter, it will be compressed prior to transferring. If the file is doesn't pass the filter, then it is not compressed, but is still transferred
    
    Specified by:
    
    getCompFileFilter in interface FileTransferData
    
    Returns:
    
    Current compression file filter
  - getCompLevel
```
public int getCompLevel()
```
    Description copied from interface: FileTransferData
    
    Returns the current compression level (0 - 9). This compression level is used determine the amount of compression to be used when attempting to compress the data in a given transfer. In some networks (such as high bandwidth connections), it may be helpful to lower the amount of compression to a smaller number. In other networks (low bandwidth, satellite networks), it may be helpful t maximize the compression (comp level = 9).
    
    Specified by:
    
    getCompLevel in interface FileTransferData
    
    Returns:
    
    int The current compression level
  - getCompMethod
```
public int getCompMethod()
```
    Description copied from interface: FileTransferData
    Returns the current compression method to be used during transfers. The method dictates what type of algorithm to use when compressing the data into smaller amounts.
    The available compression strategies that can be used are as follows:
    - 0: Default Zip deflator (Lower CPU and memory usage with less efficient compression)
    - 1: LMZA (Higher CPU and memory usage with more efficient data compression)
    Specified by:
    
    getCompMethod in interface FileTransferData
    
    Returns:
    
    int The current compression Method.
  - getCompressionData
```
public CompressionData getCompressionData()
```
    Returns a data object containing the compression data for the TransferMechanism
    
    Returns:
    
    Data object containing the compression data
  - getCompStrategy
```
public int getCompStrategy()
```
    Description copied from interface: FileTransferData
    Returns the current compression deflater strategy that will be used in the current compression method to minimize the data and compress into smaller byte values.
    Valid return values are:
    - java.util.zip.Deflater.DEFAULT_STRATEGY
    - java.util.zip.Deflater.FILTERED (Strategy that is most beneficial when compressing filtered, sorted data)
    - java.util.zip.Deflater.HUFFMAN_ONLY (Strategy that compresses and decompresses data by encoding and decoding data into different information)
    Specified by:
    
    getCompStrategy in interface FileTransferData
    
    Returns:
    
    int The current compression strategy
  - getCongCtrlStrategy
```
public int getCongCtrlStrategy()
```
    Description copied from interface: FileTransferData
    Returns the current congestion control strategy.
    The possible options are:
    - RTT based (CongestionControlType.RTT)
    - LOSS based (CongestionControlType.LOSS)
    - Rate based (CongestionControlType.BSS)
    The default congestion control strategy is Packet Loss.
    Specified by:
    
    getCongCtrlStrategy in interface FileTransferData
    
    Returns:
    
    the congCtrlStrategy
  - getCongestionControlAggression
```
public int getCongestionControlAggression()
```
    Description copied from interface: FileTransferData
    
    Returns an aggression factor between 1 (passive) and 10 (aggressive) used by the congestion control mechanism to determine how passive or aggressive it should be in the face of network congestion. Default value is 5.
    
    Specified by:
    
    getCongestionControlAggression in interface FileTransferData
    
    Returns:
    
    int Aggression factor between 1 (passive) and 10 (aggressive)
  - getConnectTimeout
```
public int getConnectTimeout()
```
    Description copied from interface: FileTransferData
    
    Return the connect timeout value (in milliseconds)
    
    Specified by:
    
    getConnectTimeout in interface FileTransferData
    
    Returns:
    
    The connect timeout value (in milliseconds)
  - getExtendedReadTimeout
```
public int getExtendedReadTimeout()
```
    Description copied from interface: FileTransferData
    
    This is the length of time in milliseconds the client will wait for a reply after sending a long running command (such as MD5, MKDLT, MKSIG, ZIP, UNZIP) to the FileCatalyst server.
    
    Specified by:
    
    getExtendedReadTimeout in interface FileTransferData
    
    Returns:
    
    int The current extended read timeout value, in millisecods.
  - getFileFilter
```
public FileCatalystFileFilter getFileFilter()
```
    Description copied from interface: FileTransferData
    
    Returns the current file filter that is used to filter out information for a transfer. If a file is queued for transfer and passes the filter's current settings, then it will transferred. Otherwise it will be ignored.
    
    Specified by:
    
    getFileFilter in interface FileTransferData
    
    Returns:
    
    Current file filter
  - getClientName
```
public java.lang.String getClientName()
```
    Description copied from interface: FileTransferData
    
    Used for HotFolder Reporting, And CSV Reports
    
    Specified by:
    
    getClientName in interface FileTransferData
  - getIncomingDataPort
```
public int getIncomingDataPort()
```
    Description copied from interface: FileTransferData
    
    Returns the port used for incoming UDP packets on downloads Only the first port will be returned in the case of v3.0 where multi-receive sockets have been enabled.
    
    Specified by:
    
    getIncomingDataPort in interface FileTransferData
    
    Returns:
    
    int The port used for incoming UDP packets on downloads (Only the first port will be returned in the case of v3.0 where multi-receive sockets have been enabled.)
  - getIncomingDataPorts
```
public int[] getIncomingDataPorts()
```
    Description copied from interface: FileTransferData
    
    Returns the list of ports used for incoming UDP packets on downloads
    
    Specified by:
    
    getIncomingDataPorts in interface FileTransferData
    
    Returns:
    
    int The list of port used for incoming UDP packets on downloads
  - getIncrementalMode
```
public int getIncrementalMode()
```
    Description copied from interface: FileTransferData
    
    Returns the current incremental mode.
    
    Specified by:
    
    getIncrementalMode in interface FileTransferData
    
    Returns:
    
    int The current incremental mode.
  - getLocalWorkingDirectoryPath
```
public java.nio.file.Path getLocalWorkingDirectoryPath()
```
    Specified by:
    
    getLocalWorkingDirectoryPath in interface FileTransferData
  - getLogger
```
public unlimited.core.util.common.logs.LogUtils getLogger()
```
    Description copied from interface: FileTransferData
    
    Returns the logger that is used
    
    Specified by:
    
    getLogger in interface FileTransferData
    
    Returns:
    
    the logger
  - getLogLocation
```
public java.lang.String getLogLocation()
```
    Description copied from interface: FileTransferData
    
    Returns the current location for the log files.
    
    Specified by:
    
    getLogLocation in interface FileTransferData
    
    Returns:
    
    The current location for the log files.
  - getMaxRetries
```
public int getMaxRetries()
```
    Description copied from interface: FileTransferData
    
    Returns the number of times to retry a broken or interrupted transfer. Transfers will be reattempted upto the max number of retries before ultimately failing the transfer
    Default value for max retries is 10
    
    Specified by:
    
    getMaxRetries in interface FileTransferData
    
    Returns:
    
    the maxRetries
  - getMd5RateLimit
```
public int getMd5RateLimit()
```
    Description copied from interface: FileTransferData
    
    Returns the current MD5 that is set. Limit is used to limit the amount of CPU usage and speed that for MD5s
    
    Specified by:
    
    getMd5RateLimit in interface FileTransferData
    
    Returns:
    
    Current MD5 rate that is set
  - getMode
```
public int getMode()
```
    Description copied from interface: unlimited.fc.client.api.filelist.FileListDataItemSource
    The current transfer mode of this client.
    The possible returns values can be found at the following locations:
    - UDP: TransferMode.UDP
    - FTP: TransferMode.FTP
    - HTTP: TransferMode.HTTP
    - AUTO: TransferMode.AUTO
    Specified by:
    
    getMode in interface unlimited.fc.client.api.filelist.FileListDataItemSource
    
    Returns:
    
    current transfer mode (UDP, FTP, AUTO) of this client
  - getNumBlockReaders
```
public int getNumBlockReaders()
```
    Description copied from interface: FileTransferData
    
    Returns the number of block reader threads. Client application will use these values for uploads only. Server has these values defined remotely for downloads.
    
    Specified by:
    
    getNumBlockReaders in interface FileTransferData
    
    Returns:
    
    the numBlockReaders
  - getNumBlockWriters
```
public int getNumBlockWriters()
```
    Description copied from interface: FileTransferData
    
    Returns the number of block writer threads. Client application will use these values for downloads only. Server has these values defined remotely for uploads.
    
    Specified by:
    
    getNumBlockWriters in interface FileTransferData
    
    Returns:
    
    the numBlockWriters
  - getNumFTPStreams
```
public int getNumFTPStreams()
```
    Description copied from interface: FileTransferData
    
    Returns the number of concurrent streams that will be used for FTP transfers
    
    Specified by:
    
    getNumFTPStreams in interface FileTransferData
    
    Returns:
    
    Number of concurrent streams that will be used for FTP transfers
  - getNumPacketProcessors
```
public int getNumPacketProcessors()
```
    Description copied from interface: FileTransferData
    
    Return the current number of packet processor threads. Client application will use these values for downloads only. Server has these values defined remotely for uploads.
    
    Specified by:
    
    getNumPacketProcessors in interface FileTransferData
    
    Returns:
    
    the numPacketProcessors
  - getNumReceiveSockets
```
public int getNumReceiveSockets()
```
    Description copied from interface: FileTransferData
    
    Returns the current number of receive sockets. Required for > 2gbps transfers. Default for this value is 1.
    
    Specified by:
    
    getNumReceiveSockets in interface FileTransferData
    
    Returns:
    
    the numReceiveSockets
  - getNumSenderSockets
```
public int getNumSenderSockets()
```
    Description copied from interface: FileTransferData
    
    Return the number of Sender sockets to use
    
    Specified by:
    
    getNumSenderSockets in interface FileTransferData
    
    Returns:
    
    the Number of UDP Sockets currently set
  - getNumSenderThreads
```
public int getNumSenderThreads()
```
    Description copied from interface: FileTransferData
    
    Returns the number of threads that will be used at most for each FC transmission.
    
    Specified by:
    
    getNumSenderThreads in interface FileTransferData
    
    Returns:
    
    the number of threads that will be used at most for each FC transmission.
  - getNumThreads
```
public int getNumThreads()
```
    Description copied from interface: FileTransferData
    
    Returns the number of threads that will be used at most for each FC transmission.
    
    Specified by:
    
    getNumThreads in interface FileTransferData
    
    Returns:
    
    the number of threads that will be used at most for each FC transmission.
  - getNumUDPSockets
```
public int getNumUDPSockets()
```
    Description copied from interface: FileTransferData
    
    Return the number of Sender sockets to use
    
    Specified by:
    
    getNumUDPSockets in interface FileTransferData
    
    Returns:
    
    the Number of UDP Sockets currently set
  - getObserver
```
public java.util.Observer getObserver()
```
    Description copied from interface: FileTransferData
    
    Returns the Observer that is currently set.
    
    Specified by:
    
    getObserver in interface FileTransferData
    
    Returns:
    
    the observer
  - getPacketQueueDepth
```
public int getPacketQueueDepth()
```
    Description copied from interface: FileTransferData
    
    Return the current packet queue depth. Client application will use these values for downloads only. Server has these values defined remotely for uploads.
    
    Specified by:
    
    getPacketQueueDepth in interface FileTransferData
    
    Returns:
    
    the packetQueueDepth
  - getPacketSize
```
public int getPacketSize()
```
    Description copied from interface: FileTransferData
    
    Returns the current packet size in bytes. This is the encoded unit size, and determines the eventual UDP packet size. If the unit size is greater than the MTU of the network with will create fragmented UDP packets. This can lead to higher performance in low loss environments, but may decrease performance in environments with very low MTU (ATM) or high packet loss environments.
    
    Specified by:
    
    getPacketSize in interface FileTransferData
    
    Returns:
    
    The current packet size. In Bytes.
  - getPostTaskSentData
```
public PostTaskSentData getPostTaskSentData()
```
    Description copied from interface: FileTransferData
    
    Returns the current post task sent data
    
    Specified by:
    
    getPostTaskSentData in interface FileTransferData
  - getPostURL
```
public java.lang.String getPostURL()
```
    Description copied from interface: FileTransferData
    
    Returns the current post URL to use
    
    Specified by:
    
    getPostURL in interface FileTransferData
    
    Returns:
  - getProgressiveTimeout
```
public int getProgressiveTimeout()
```
    Description copied from interface: FileTransferData
    
    Returns the current progressive timeout value. The value determines how many seconds we will wait for files to stop growing
    
    Specified by:
    
    getProgressiveTimeout in interface FileTransferData
    
    Returns:
  - getProgressiveTimeoutFilter
```
public java.lang.String getProgressiveTimeoutFilter()
```
    Description copied from interface: FileTransferData
    
    Returns the current progressive timeout filter. Value determines the file that will be included in progressive file growth checks
    
    Specified by:
    
    getProgressiveTimeoutFilter in interface FileTransferData
    
    Returns:
  - getReadBufferSizeKB
```
public int getReadBufferSizeKB()
```
    Description copied from interface: FileTransferData
    
    Return the current read buffer size, in KB Value zero (0) indicates read buffer is dictated by the network block size. Client application will use these values for uploads only. Server has these values defined remotely for downloads.
    
    Specified by:
    
    getReadBufferSizeKB in interface FileTransferData
    
    Returns:
    
    readBufferSize
  - getReadTimeout
```
public int getReadTimeout()
```
    Description copied from interface: FileTransferData
    
    This is the length of time in milliseconds the client will wait for a reply after sending a command to the FileCatalyst server.
    
    Specified by:
    
    getReadTimeout in interface FileTransferData
    
    Returns:
    
    int The current read timeout value, in millisecods..
  - getRemotePort
```
public int getRemotePort()
```
    Description copied from interface: FileTransferData
    
    Gets the remote port to which this client will be connected.
    
    Specified by:
    
    getRemotePort in interface FileTransferData
    
    Returns:
    
    the remote port to which this client will be connected.
  - getRemoteServer
```
public java.lang.String getRemoteServer()
```
    Description copied from interface: FileTransferData
    
    This method returns the remote server / hostname to which this client is connected.
    
    Specified by:
    
    getRemoteServer in interface FileTransferData
    
    Returns:
    
    the remote server to which this client is connected.
  - getRenameExtension
```
public boolean getRenameExtension()
```
    Description copied from interface: FileTransferData
    
    Returns whether or not the rename extension will be used. If true, transfers of files with the extension .RDY will rename both the source and destination files to have the extension .PKD
    
    Specified by:
    
    getRenameExtension in interface FileTransferData
    
    Returns:
    
    Boolean dictating the use of the rename extension
  - getServerAgentID
```
public java.lang.String getServerAgentID()
```
    Description copied from interface: FileTransferData
    
    Returns the server's current agent ID. Used with Central monitoring and management
    
    Specified by:
    
    getServerAgentID in interface FileTransferData
    
    Returns:
    
    Server agent ID
  - getServletLocation
```
public java.lang.String getServletLocation()
```
    Description copied from interface: FileTransferData
    
    FileCatalyst has the ability to upload using the HTTP/S protocol as long as the FileCatalyst Servlet application is installed and properly configured. This method allows you to retrieve the current URL of the FileCatalyst Servlet if it has been set.
    
    Specified by:
    
    getServletLocation in interface FileTransferData
    
    Returns:
    
    String the URL of FileCatalyst Servlet, or null if it has not been set.
  - getServletLocationData
```
public TransferMechanismData.ServletLocationData getServletLocationData()
```
    Generates and returns a data object containing all of the information relating to the Servlet
    
    Returns:
    
    Data object with Servlet information
  - getServletMultiplier
```
public int getServletMultiplier()
```
    Description copied from interface: FileTransferData
    
    When uploading in HTTP mode using FileCatalyst Servlet, this option allows the upload buffer size to be tuned. This method returns the current value.
    
    Specified by:
    
    getServletMultiplier in interface FileTransferData
    
    Returns:
    
    int multiplier value used to tune upload buffer
  - getSessionCount
```
public int getSessionCount()
```
    Description copied from interface: FileTransferData
    
    Returns the current number of active sessions that the implementation has
    
    Specified by:
    
    getSessionCount in interface FileTransferData
    
    Returns:
    
    Current number of sessions
  - getSessionID
```
public java.lang.String getSessionID()
```
    Description copied from interface: FileTransferData
    
    Returns the current session ID of the implementation
    
    Specified by:
    
    getSessionID in interface FileTransferData
    
    Returns:
    
    The session ID
  - getStartRate
```
public int getStartRate()
```
    Description copied from interface: unlimited.fc.client.api.filelist.FileListDataItemSource
    
    Returns the current start rate for FC transfers. All FC transfer will begin at this rate and ramp up to the specified target rate if no congestion is encounters.
    Note: Congestion control must be enabled for this value to have an effect.
    
    Specified by:
    
    getStartRate in interface unlimited.fc.client.api.filelist.FileListDataItemSource
    
    Returns:
    
    The current start rate for FC transfers in Kilobits per second
  - getSSLSocketProducer
```
public unlimited.core.transfers.net.ssl.FCSSLSocketProducerImpl getSSLSocketProducer()
```
    Description copied from interface: FileTransferData
    
    Retrieves the implementation that will be used to generate SSL sockets
    
    Specified by:
    
    getSSLSocketProducer in interface FileTransferData
  - getTargetRate
```
public int getTargetRate()
```
    Description copied from interface: FileTransferData
    
    Returns the current target rate for this client. The client will attempt to transfer files no faster than the specified rate. If a transfer is already in progress, an attempt will be made to adjust it's target rate to the specified value.
    
    Specified by:
    
    getTargetRate in interface FileTransferData
    
    Returns:
    
    the current target rate for this client.
  - getTempMode
```
public int getTempMode()
```
    Description copied from interface: FileTransferData
    
    Returns the temporary mode for the implementation
    
    Specified by:
    
    getTempMode in interface FileTransferData
    
    Returns:
  - getTransactionID
```
public java.lang.String getTransactionID()
```
    Returns the current transaction ID that is set. For more information on transaction ID see: FileTransferData.setTransactionID(String)
    
    Returns:
    
    The currently set transaction ID
  - getTransferEmptyDirectories
```
public boolean getTransferEmptyDirectories()
```
    Description copied from interface: FileTransferData
    
    Returns whether not the implementation is set to transfer empty directories.
    
    Specified by:
    
    getTransferEmptyDirectories in interface FileTransferData
    
    Returns:
    
    True if implementation will transfer empty directories, false if not
  - getTransferRate
```
public int getTransferRate()
```
    Description copied from interface: FileTransferData
    
    Returns the implementation's current transfer rate
    
    Specified by:
    
    getTransferRate in interface FileTransferData
    
    Returns:
    
    The current rate
  - getUnitSize
```
public int getUnitSize()
```
    Description copied from interface: unlimited.fc.client.api.filelist.FileListDataItemSource
    
    Use getPacketSize
    
    Specified by:
    
    getUnitSize in interface unlimited.fc.client.api.filelist.FileListDataItemSource
    
    Returns:
    
    The current unit size. In Bytes.
  - getVerifyMode
```
public int getVerifyMode()
```
    Description copied from interface: FileTransferData
    Returns the current integrity verification mode.
    The modes that can be returned are as follows:
    Specified by:
    
    getVerifyMode in interface FileTransferData
    
    Returns:
    
    int The current verify mode, either TransferMode.VERIFY_AFTER or TransferMode.VERIFY_ON_THE_FLY.
  - getWaitRetry
```
public long getWaitRetry()
```
    Description copied from interface: FileTransferData
    
    Returns the amount of milliseconds to wait between retries for failed transfers.
    
    Specified by:
    
    getWaitRetry in interface FileTransferData
    
    Returns:
    
    the waitRetry
  - getWriteBufferSizeKB
```
public int getWriteBufferSizeKB()
```
    Description copied from interface: FileTransferData
    
    Return the current write buffer size. Value is in KB. Value zero (0) indicates read buffer is dictated by the network block size. Client application will use these values for downloads only. Server has these values defined remotely for uploads.
    
    Specified by:
    
    getWriteBufferSizeKB in interface FileTransferData
    
    Returns:
    
    the writeBufferSize
  - getWriteFileMode
```
public java.lang.String getWriteFileMode()
```
    Description copied from interface: FileTransferData
    
    Gets the file write mode set Client application will use these values for downloads only. Server has these values defined remotely for uploads.
    
    Specified by:
    
    getWriteFileMode in interface FileTransferData
    
    Returns:
    
    returns either rw, rws, rwd, or ""
  - getZipFileSizeLimit
```
public long getZipFileSizeLimit()
```
    Description copied from interface: FileTransferData
    
    Returns the zip file size limit in bytes. This zip file size limit is the maximum size that a zip file can be once it is created. If a zip file exceeds this value it will be split into multiple zips, and transferred in pieces
    
    Specified by:
    
    getZipFileSizeLimit in interface FileTransferData
    
    Returns:
    
    the zipFileSizeLimit in bytes
  - isAutoResume
```
public boolean isAutoResume()
```
    Description copied from interface: FileTransferData
    
    Returns true if auto-resume is enabled. When enabled, if the destination file is smaller than the source file, the client will compare the relevant portions of the files to see if a transfer can be resumed. This is done using an MD5 checksum.
    
    Specified by:
    
    isAutoResume in interface FileTransferData
    
    Returns:
    
    true if auto-resume is enabled. false otherwise.
  - isAutoZip
```
public boolean isAutoZip()
```
    Description copied from interface: FileTransferData
    
    Returns true if auto zip is enabled, false otherwise.
    
    Specified by:
    
    isAutoZip in interface FileTransferData
    
    Returns:
    
    boolean True if auto zip is enabled, false otherwise.
  - isAutoUnzip
```
public boolean isAutoUnzip()
```
    Description copied from interface: FileTransferData
    
    Returns true if auto unzip is enabled, false otherwise.
    
    Specified by:
    
    isAutoUnzip in interface FileTransferData
    
    Returns:
    
    boolean True if auto zip is enabled, false otherwise.
  - isCompressionEnabled
```
public boolean isCompressionEnabled()
```
    Description copied from interface: FileTransferData
    
    Returns true if compression is enabled, false otherwise.
    
    Specified by:
    
    isCompressionEnabled in interface FileTransferData
    
    Returns:
    
    boolean True if compression is enabled, false otherwise.
  - isCongestionControlEnabled
```
public boolean isCongestionControlEnabled()
```
    Description copied from interface: FileTransferData
    
    Returns true if congestion control is currently enabled.
    
    Specified by:
    
    isCongestionControlEnabled in interface FileTransferData
    
    Returns:
    
    true if congestion control is currently enabled.
  - isCurrentStateConnected
```
public boolean isCurrentStateConnected()
```
    Returns whether or not the current transfer mechanism is connected
    
    Returns:
    
    True if connected, false if not
  - isDebug
```
public boolean isDebug()
```
    Description copied from interface: FileTransferData
    
    Returns true if debug is set to true.
    
    Specified by:
    
    isDebug in interface FileTransferData
    
    Returns:
    
    True if debug is set to true
  - isDeleteAfterTransfer
```
public boolean isDeleteAfterTransfer()
```
    Description copied from interface: FileTransferData
    
    Returns true if the delete after transfer option is enabled, false otherwise. With this option enabled, source files will be deleted after the transfer is complete. If the transfer is an upload, the local files will be deleted. If the transfer is a download, the remote files will be deleted.
    
    Specified by:
    
    isDeleteAfterTransfer in interface FileTransferData
    
    Returns:
    
    boolean true if the delete after transfer option is enabled, false otherwise.
  - isDowngradeModeOnReConnect
```
public boolean isDowngradeModeOnReConnect()
```
    Description copied from interface: FileTransferData
    
    Returns true if the downgrade on reconnect option is enabled, false otherwise.
    
    Specified by:
    
    isDowngradeModeOnReConnect in interface FileTransferData
    
    Returns:
    
    boolean true if the downgrade on reconnect option is enabled, false otherwise.
  - isForceTCPmodeACKs
```
public boolean isForceTCPmodeACKs()
```
    Description copied from interface: FileTransferData
    
    Returns true if TCP mode ACKs are enabled. If option is enabled, transfers will instead use TCP acknowledgement messages (ACKs) to confirm that data is received during the transfer. If the option is disabled, then transfer will use the default UDP ACK messages to ensure data is transferred.
    Note: In some cases UDP notifications may be blocked. If this is the case you may force the client to use TCP mode ACKs.
    
    Specified by:
    
    isForceTCPmodeACKs in interface FileTransferData
    
    Returns:
    
    true if TCP mode ACKs are enabled
  - isMaintainLastModified
```
public boolean isMaintainLastModified()
```
    Description copied from interface: FileTransferData
    
    Returns true if Maintain last modified is enabled. If set to true, upon each successful transfer, the destination files modification date will be set to match that of the source file.
    
    Specified by:
    
    isMaintainLastModified in interface FileTransferData
    
    Returns:
    
    true if Maintain last modified is enabled
  - isMaintainPermissions
```
public boolean isMaintainPermissions()
```
    Description copied from interface: FileTransferData
    
    Returns true if maintain permissions is enabled. If value returns true, upon each successful transfer, the destination file permissions will be set to match those of the source file. This features only functions when both the source and destination are running a Linux/Unix based OS.
    
    Specified by:
    
    isMaintainPermissions in interface FileTransferData
    
    Returns:
    
    true if Maintain permissions is enabled
  - isOptimizeBlockSize
```
public boolean isOptimizeBlockSize()
```
    Description copied from interface: FileTransferData
    
    Returns true if optimize block size feature is enabled.
    
    Specified by:
    
    isOptimizeBlockSize in interface FileTransferData
    
    Returns:
    
    true/false if this feature is enabled/disabled
  - isProgressiveTransfers
```
public boolean isProgressiveTransfers()
```
    Description copied from interface: FileTransferData
    
    Return true if the progressive option is enabled, false otherwise.
    
    Specified by:
    
    isProgressiveTransfers in interface FileTransferData
    
    Returns:
    
    boolean true if the progressive option is enabled, false otherwise.
  - isShowConsoleLog
```
public boolean isShowConsoleLog()
```
    Description copied from interface: FileTransferData
    
    Returns true if console log is enabled.
    
    Specified by:
    
    isShowConsoleLog in interface FileTransferData
    
    Returns:
    
    true if console log is enabled.
  - isTransferEmptyDirectories
```
public boolean isTransferEmptyDirectories()
```
    Description copied from interface: FileTransferData
    
    Returns whether or not the implementation should be transferring empty directories
    
    Specified by:
    
    isTransferEmptyDirectories in interface FileTransferData
    
    Returns:
    
    true or false
  - isTransferWithTempName
```
public boolean isTransferWithTempName()
```
    Description copied from interface: FileTransferData
    
    Returns true if transferring with temporary names is enabled
    
    Specified by:
    
    isTransferWithTempName in interface FileTransferData
    
    Returns:
    
    boolean True if transferring with temporary names is enabled
  - isUseCompression
```
public boolean isUseCompression()
```
    Description copied from interface: FileTransferData
    
    Returns true if compression is enabled, false otherwise.
    
    Specified by:
    
    isUseCompression in interface FileTransferData
    
    Returns:
    
    boolean True if compression is enabled, false otherwise.
  - isUseCongestionControl
```
public boolean isUseCongestionControl()
```
    Description copied from interface: FileTransferData
    
    Returns true if congestion control is currently enabled.
    
    Specified by:
    
    isUseCongestionControl in interface FileTransferData
    
    Returns:
    
    true if congestion control is currently enabled.
  - isUseIncremental
```
public boolean isUseIncremental()
```
    Description copied from interface: FileTransferData
    
    Returns true if incremental feature is enabled
    
    Specified by:
    
    isUseIncremental in interface FileTransferData
    
    Returns:
    
    true if incremental feature is enabled
  - isIncrementalSizeCheckOnly
```
public boolean isIncrementalSizeCheckOnly()
```
    Description copied from interface: FileTransferData
    
    Returns whether or not incremental has been set to use the size only option
    
    Specified by:
    
    isIncrementalSizeCheckOnly in interface FileTransferData
    
    Returns:
  - isUseSSL
```
public boolean isUseSSL()
```
    Description copied from interface: FileTransferData
    
    Returns true if SSL mode is enabled, false otherwise.
    
    Specified by:
    
    isUseSSL in interface FileTransferData
    
    Returns:
    
    true if SSL mode is enabled, false otherwise.
  - isVerifyIntegrity
```
public boolean isVerifyIntegrity()
```
    Description copied from interface: FileTransferData
    
    Returns true if integrity check is enabled. If true, after each file is transferred an MD5 sum will be performed on the destination file and the result will be compared to that of the source file to ensure the files are identical.
    
    Specified by:
    
    isVerifyIntegrity in interface FileTransferData
    
    Returns:
    
    true if integrity check is enabled.
  - setAutoResume
```
public void setAutoResume(boolean autoResume)
```
    Description copied from interface: FileTransferData
    
    Enables/disables auto resume feature. When enabled, if the destination file is smaller than the source file, the client will compare the relevant portions of the files to see if a transfer can be resumed. This is done using an MD5 checksum. Auto resume is false by default.
    
    Specified by:
    
    setAutoResume in interface FileTransferData
    
    Parameters:
    
    autoResume - true/false to enabled or disable this feature.
  - setAutoZip
```
public void setAutoZip(boolean autoZip)
```
    Description copied from interface: FileTransferData
    
    Enables/disables auto zip feature. If this feature is enabled, prior to transferring, all files will be compressed into a single archive, transferred as one archive, and decompressed at the destination. Path structure will be maintained, as will file modification times. When using this feature in combination with setProgressive(true), FileCatalyst will beging to transfer the zip file before it is completely generated. This currently only works during uploads.
    
    Specified by:
    
    setAutoZip in interface FileTransferData
    
    Parameters:
    
    autoZip - boolean
  - setAutoUnzip
```
public void setAutoUnzip(boolean autoUnzip)
```
    Description copied from interface: FileTransferData
    
    Enables/disables auto unzip feature. When using this feature in combination with setAutoZip(true), if this feature is enabled, all files will be decompressed at the destination, otherwise if this feature is disable, all files won't be extracted and not deleted either.
    
    Specified by:
    
    setAutoUnzip in interface FileTransferData
    
    Parameters:
    
    autoUnzip - boolean
  - setBlockSize
```
public void setBlockSize(int blockSize)
```
    Description copied from interface: FileTransferData
    
    Set the block size. The block size determines how much data each thread will encode and send through the pipe. In higher RTT environments, it might be advantageous to increase this value as it will ensure the pipe is full of data. This however will cause the client side to consume more memory (number of threads * the block size) Block size is set to 2048000 by default.
    
    Specified by:
    
    setBlockSize in interface FileTransferData
    
    Parameters:
    
    blockSize - An int value used to set the Block Size
  - setCallbackHandler
```
public void setCallbackHandler(FileCatalystClientCallbackHandler callbackHandler)
```
    Description copied from interface: FileTransferData
    
    Sets a callback handler that will be used to confirm resume, overwrite and to do post processing
    
    Specified by:
    
    setCallbackHandler in interface FileTransferData
    
    Parameters:
    
    callbackHandler - the callbackHandler to set
  - setClientAgentID
```
public void setClientAgentID(java.lang.String clientAgentID)
```
    Description copied from interface: FileTransferData
    
    Sets the current client agent ID to the new specified value. Do note that this ID value is used to distinguish this client and it's transfers from other clients in the reports
    
    Specified by:
    
    setClientAgentID in interface FileTransferData
    
    Parameters:
    
    clientAgentID - New ID to set
  - setClientConnectKey
```
public void setClientConnectKey(java.lang.String clientConnectKey)
```
    Description copied from interface: FileTransferData
    
    This key must be set in order to connect to non-FileCatalyst servers. This method must be called prior to called connect() or the key will not have any effect.
    
    Specified by:
    
    setClientConnectKey in interface FileTransferData
    
    Parameters:
    
    clientConnectKey - String Client connect key
  - setClientIdentifier
```
public void setClientIdentifier(int clientIdentifier)
```
    Description copied from interface: FileTransferData
    
    An ID value that identifies this client to the FileCatalyst Server.
    
    Specified by:
    
    setClientIdentifier in interface FileTransferData
    
    Parameters:
    
    clientIdentifier - int
  - setClientString
```
public void setClientString(java.lang.String clientString)
```
    Description copied from interface: FileTransferData
    
    Set a text string that will be displayed on the server UI to identify this client. USeful when developing 3rd party applications that are not identified properly by FileCatalyst internal IDs.
    
    Specified by:
    
    setClientString in interface FileTransferData
    
    Parameters:
    
    clientString - the clientString to set
  - setClientSubIdentifier
```
public void setClientSubIdentifier(int id)
```
    Description copied from interface: FileTransferData
    
    Sets an ID that further identifies this client
    
    Specified by:
    
    setClientSubIdentifier in interface FileTransferData
    
    Parameters:
    
    id - the clientSubIdentifier to set
  - setCompFileFilter
```
public void setCompFileFilter(java.lang.String compFileFilter)
```
    Description copied from interface: FileTransferData
    
    Sets the compression FileFilter that is to be used by the implementation
    
    Specified by:
    
    setCompFileFilter in interface FileTransferData
    
    Parameters:
    
    compFileFilter - Filter to set
  - setCompLevel
```
public void setCompLevel(int compLevel)
```
    Description copied from interface: FileTransferData
    
    Sets the compression level (0 - 9 with default of 4). This compression level is used determine the amount of compression to be used when attempting to compress the data in a given transfer. In some networks (such as high bandwidth connections), it may be helpful to lower the amount of compression to a smaller number. In other networks (low bandwidth, satellite networks), it may be helpful to maximize the compression (comp level = 9).
    
    Specified by:
    
    setCompLevel in interface FileTransferData
    
    Parameters:
    
    compLevel - int The desired compression level
  - setCompMethod
```
public void setCompMethod(int compMethod)
```
    Description copied from interface: FileTransferData
    Sets the current compression method to be used during transfers. The method dictates what type of algorithm to use alongside the deflater when compressing the data into smaller amounts.
    The available compression strategies that can be used are as follows:
    - 0: Default Zip deflator (Lower CPU and memory usage for less efficient compression)
    - 1: LMZA (Higher CPU and Memory usage for more efficient data compression)
    Specified by:
    
    setCompMethod in interface FileTransferData
    
    Parameters:
    
    compMethod - int The desired compression Method
  - setCompressionData
```
public void setCompressionData(CompressionData compressionData)
```
  - setCompressionDataFromClient
```
public void setCompressionDataFromClient(FileTransferMechanism client)
```
  - setCompressionEnabled
```
public void setCompressionEnabled(boolean compressionEnabled)
```
    Description copied from interface: FileTransferData
    
    Enables/disables on the fly compression. When enabled, each block of data will be compressed on the fly before it is sent over the network.
    
    Specified by:
    
    setCompressionEnabled in interface FileTransferData
  - setCompStrategy
```
public void setCompStrategy(int compStrategy)
```
    Description copied from interface: FileTransferData
    Sets the compression deflater strategy that will be used within the compression method to minimize the data and compress into smaller byte values.
    
    Valid values are:
    - java.util.zip.Deflater.DEFAULT_STRATEGY
    - java.util.zip.Deflater.FILTERED (Strategy that is most beneficial when compressing filtered, sorted data)
    - java.util.zip.Deflater.HUFFMAN_ONLY (Strategy that compresses and decompresses data by encoding and decoding data into different information)
    Specified by:
    
    setCompStrategy in interface FileTransferData
    
    Parameters:
    
    compStrategy - int The new compression strategy
  - setCongCtrlStrategy
```
public void setCongCtrlStrategy(int congCtrlStrategy)
```
    Description copied from interface: FileTransferData
    Sets the congestion control strategy.
    The possible options are:
    - RTT based (CongestionControlType.RTT)
    - LOSS based (CongestionControlType.LOSS)
    - Rate based (CongestionControlType.BSS)
    The default congestion control strategy is Packet Loss.
    Specified by:
    
    setCongCtrlStrategy in interface FileTransferData
    
    Parameters:
    
    congCtrlStrategy - the congCtrlStrategy to set
  - setCongestionControlAggression
```
public void setCongestionControlAggression(int congestionControlAggression)
```
    Description copied from interface: FileTransferData
    
    Specifies an aggression factor between 1 (passive) and 10 (aggressive) used by the congestion control mechanism to determine how passive or aggressive it should be in the face of network congestion.
    
    Specified by:
    
    setCongestionControlAggression in interface FileTransferData
    
    Parameters:
    
    congestionControlAggression - int Aggression factor between 1 and 10.
  - setCongestionControlEnabled
```
public void setCongestionControlEnabled(boolean congestionControlEnabled)
```
    Description copied from interface: FileTransferData
    
    Enables/disables congestion control for this client. When enabled, the client will automatically decrease its transmission or reception rate when congestion is detected. Future versions will allow finer grain control over the reaction algorithm. Congestion control is set to true by default.
    
    Specified by:
    
    setCongestionControlEnabled in interface FileTransferData
  - setConnectTimeout
```
public void setConnectTimeout(int connectTimeout)
```
    Description copied from interface: FileTransferData
    
    Sets the connect timeout value (in milliseconds). Default is 20000 milliseconds.
    
    Specified by:
    
    setConnectTimeout in interface FileTransferData
    
    Parameters:
    
    connectTimeout - int value used to set the connect timeout
  - setCurrentStateConnected
```
public void setCurrentStateConnected(boolean currentStateConnected)
```
  - setDebug
```
public void setDebug(boolean debug)
```
    Description copied from interface: FileTransferData
    
    Turns on debug mode.
    
    Specified by:
    
    setDebug in interface FileTransferData
    
    Parameters:
    
    debug - boolean value to turn the debug mode on or of
  - setDeleteAfterTransfer
```
public void setDeleteAfterTransfer(boolean deleteAfterTransfer)
```
    Description copied from interface: FileTransferData
    
    With this option enabled, source files will be deleted after the transfer is complete. If the transfer is an upload, the local files will be deleted. If the transfer is a download, the remote files will be deleted.
    
    Specified by:
    
    setDeleteAfterTransfer in interface FileTransferData
    
    Parameters:
    
    deleteAfterTransfer - boolean Enables/disables the delete after transfer option
  - setDowngradeModeOnReConnect
```
public void setDowngradeModeOnReConnect(boolean downgradeModeOnReConnect)
```
    Description copied from interface: FileTransferData
    
    If set to true, if a disconnect occurs during a UDP transfer, upon reconnect and resume, the transfer mode is downgraded to multi-stream TCP, then single stream TCP, and finally HTTP (if available).
    
    Specified by:
    
    setDowngradeModeOnReConnect in interface FileTransferData
    
    Parameters:
    
    downgradeModeOnReConnect - the downgradeModeOnReConnect to set
  - setExtendedReadTimeout
```
public void setExtendedReadTimeout(int extendedReadTimeout)
```
    Description copied from interface: FileTransferData
    
    This is the length of time the client will wait for a reply after sending a long running command (such as MD5, MKDLT, MKSIG, ZIP, UNZIP) to the FileCatalyst server. Minimum value is 600000 (10 minutes). Any attempt to set a value lower than this will automatically be increased to 600000.
    
    Specified by:
    
    setExtendedReadTimeout in interface FileTransferData
    
    Parameters:
    
    extendedReadTimeout - int New timeout value (in millisecs).
  - setFileFilter
```
public void setFileFilter(FileCatalystFileFilter fileFilter)
```
    Description copied from interface: unlimited.fc.client.api.filelist.FileListDataItemSource
    
    Sets the FileFilter that is to be used by the implementation.
    
    Specified by:
    
    setFileFilter in interface unlimited.fc.client.api.filelist.FileListDataItemSource
    
    Parameters:
    
    fileFilter - Filter to set
  - setForceTCPmodeACKs
```
public void setForceTCPmodeACKs(boolean forceTCPmodeACKs)
```
    Description copied from interface: FileTransferData
    
    By default, FileCatalyst uses UDP to acknowledge data received. If option is enabled, transfers will instead use TCP acknowledgement messages (ACKs) to confirm that data is received during the transfer. If the option is disabled, then transfer will use the default UDP ACK messages to ensure data is transferred.
    Note: In some cases UDP notifications may be blocked. If this is the case you may force the client to use TCP mode ACKs.
    
    Specified by:
    
    setForceTCPmodeACKs in interface FileTransferData
    
    Parameters:
    
    forceTCPmodeACKs - true if TCP mode ACKs should be used
  - setClientName
```
public void setClientName(java.lang.String clientName)
```
    Description copied from interface: FileTransferData
    
    Sets the current client name to the value that is specified
    
    Specified by:
    
    setClientName in interface FileTransferData
    
    Parameters:
    
    clientName - Name to set
  - setClientWorkingPath
```
public void setClientWorkingPath(java.nio.file.Path clientWorkingPath)
```
    Description copied from interface: FileTransferData
    
    Sets the client's current working path to the value specified
    
    Specified by:
    
    setClientWorkingPath in interface FileTransferData
    
    Parameters:
    
    clientWorkingPath - Working path to set
  - setIncomingDataPort
```
public void setIncomingDataPort(int incomingDataPort)
```
    Description copied from interface: FileTransferData
    
    Sets the port used for incoming UDP packets on downloads. If not set the default port is 9000.
    
    Specified by:
    
    setIncomingDataPort in interface FileTransferData
  - setIncomingDataPorts
```
public void setIncomingDataPorts(int[] incomingDataPorts)
```
    Description copied from interface: FileTransferData
    
    Sets the port used for incoming UDP packets on downloads. Allows for multiple data ports to be selected to have more than one receiver socket open for incoming streams.
    
    Specified by:
    
    setIncomingDataPorts in interface FileTransferData
  - setIncrementalMode
```
public void setIncrementalMode(int incrementalMode)
```
    Description copied from interface: FileTransferData
    When incremental is enabled, this method allows you to choose the incremental mode.
    Valid modes are
    - TransferMode.TRANSFER_FILE: Will transfer the entire file when it has been modified.
    - TransferMode.TRANSFER_FILE_DELTAS: Will only transfer sections of the file that have been modified
    - TransferMode.TRANSFER_FILE_UNIQUE_NAME: Will transfer the entire file, but under a unique name
    - TransferMode.TRANSFER_FILE_DELTAS_UNIQUE_NAME: Will only transfer sections of the file that have been modified but store the new file with a unique name
    Specified by:
    
    setIncrementalMode in interface FileTransferData
    
    Parameters:
    
    incrementalMode - int The desired incremental mode.
  - setIncrementalSizeCheckOnly
```
public void setIncrementalSizeCheckOnly(boolean incrementalSizeCheckOnly)
```
    Description copied from interface: FileTransferData
    
    Setting this value will cause the MD5 checks to be skipped and the files compared using size only.
    
    Specified by:
    
    setIncrementalSizeCheckOnly in interface FileTransferData
  - setLocalWorkingDirectory
```
public void setLocalWorkingDirectory(java.nio.file.Path localWorkingDirecctory)
```
    Description copied from interface: FileTransferData
    
    Sets the Local Working directory. This directory is used as a base path during uploads or downloads. For example, if you specify an upload of the folder "/path1/path2" and you have set the working directory to "/path1" then the file will appear on the destination server as "/path2". If you had a local working directory of "/" then the entire path would be created on the destination server. Note: Call will attempt to create the directory if it doesn't currently exist
    
    Specified by:
    
    setLocalWorkingDirectory in interface FileTransferData
  - setLogger
```
public void setLogger(unlimited.core.util.common.logs.LogUtils logger)
```
    Description copied from interface: FileTransferData
    
    overriding the logUtils object.
    
    Specified by:
    
    setLogger in interface FileTransferData
    
    Parameters:
    
    logger - the logger to set
  - setLogLocation
```
public void setLogLocation(java.lang.String logLocation)
```
    Description copied from interface: FileTransferData
    
    Specifies a directory on the local system where the log file should be stored. If this value is not set, the log will be stored in the current working directory. This should be called prior to calling initialize() to have an affect.
    
    Specified by:
    
    setLogLocation in interface FileTransferData
    
    Parameters:
    
    logLocation - String value specifying where to store the logs
  - setMaintainLastModified
```
public void setMaintainLastModified(boolean maintainLastModified)
```
    Description copied from interface: FileTransferData
    
    Sets the maintain last modified feature to the value specified. If set to true, upon each successful transfer, the destination files modification date will be set to match that of the source file. This feature is off by default.
    
    Specified by:
    
    setMaintainLastModified in interface FileTransferData
    
    Parameters:
    
    maintainLastModified - true/false to enabled and disable this feature.
  - setMaintainPermissions
```
public void setMaintainPermissions(boolean maintainPermissions)
```
    Description copied from interface: FileTransferData
    
    If set to true, upon each successful transfer, the destination file permissions will be set to match those of the source file. This features only functions when both the source and destination are running a Linux/Unix based OS. This feature is off by default.
    
    Specified by:
    
    setMaintainPermissions in interface FileTransferData
    
    Parameters:
    
    maintainPermissions - true/false to enabled and disable this feature.
  - setMaxRetries
```
public void setMaxRetries(int maxRetries)
```
    Description copied from interface: FileTransferData
    
    Specify the number of times to retry a broken or interrupted transfer. Transfers will be reattempted upto the max number of retries before ultimately failing the transfer
    Default value for max retries is 10
    
    Specified by:
    
    setMaxRetries in interface FileTransferData
    
    Parameters:
    
    maxRetries - the maxRetries to set
  - setMd5RateLimit
```
public void setMd5RateLimit(int md5RateLimit)
```
    Description copied from interface: FileTransferData
    
    Sets the rate limit to use when calculating MD5s of files
    
    Specified by:
    
    setMd5RateLimit in interface FileTransferData
    
    Parameters:
    
    md5RateLimit - Limit to use
  - setMode
```
public void setMode(int mode)
```
    Description copied from interface: FileTransferData
    Set the transfer mode of this client.
    The possible values can be found at the following locations:
    - UDP: TransferMode.UDP
    - FTP: TransferMode.FTP
    - HTTP: TransferMode.HTTP
    - AUTO: TransferMode.AUTO
    Specified by:
    
    setMode in interface FileTransferData
    
    Parameters:
    
    mode - int value used to specify which transfer mode to use (ie: TransferMode.UDP)
  - setNumBlockReaders
```
public void setNumBlockReaders(int numBlockReaders)
```
    Description copied from interface: FileTransferData
    
    Sets the number of block reader threads. Increasing the number of blocker reader threads may increase read speed performance and help boost performance. Client application will use these values for uploads only. Server has these values defined remotely for downloads.
    
    Specified by:
    
    setNumBlockReaders in interface FileTransferData
    
    Parameters:
    
    numBlockReaders - the numBlockReaders to set
  - setNumBlockWriters
```
public void setNumBlockWriters(int numBlockWriters)
```
    Description copied from interface: FileTransferData
    
    Sets the number of block writer threads to use when receiving a file. Writing to the file with multiple threads may improve performance. Client application will use these values for downloads only. Server has these values defined remotely for uploads.
    
    Specified by:
    
    setNumBlockWriters in interface FileTransferData
    
    Parameters:
    
    numBlockWriters - the numBlockWriters to set
  - setNumFTPStreams
```
public void setNumFTPStreams(int numFTPStreams)
```
    Description copied from interface: FileTransferData
    
    When transferring in FTP mode, it is possible to send with several concurrent streams. This may increase performance on connections with low packet loss, but high latency. Speed gains are linear, that is, if you get 2 Mbps with 1 stream, you should get 4 Mbps with 2 streams.
    
    Specified by:
    
    setNumFTPStreams in interface FileTransferData
    
    Parameters:
    
    numFTPStreams - Number of concurrent streams to use.
  - setNumPacketProcessors
```
public void setNumPacketProcessors(int numPacketProcessors)
```
    Description copied from interface: FileTransferData
    
    Sets the number of threads used to process incoming UDP packets when downloading. When packets arrive they are inserted into a queue for processing. The packet processor threads process the packets and sort them into the proper data blocks. The number of threads used to process the packets becomes very important when AES encryption is enabled as it distributes the decryption between the CPU cores. Client application will use these values for downloads only. Server has these values defined remotely for uploads.
    
    Specified by:
    
    setNumPacketProcessors in interface FileTransferData
    
    Parameters:
    
    numPacketProcessors - the numPacketProcessors to set
  - setNumReceiveSockets
```
public void setNumReceiveSockets(int numReceiveSockets)
```
    Description copied from interface: FileTransferData
    
    Set the number of UDP sockets to use to receive packets during a UDP download. When individual UDP sockets receive packets there is latency between when packets are received and when they are processed. This means processing packets form a single socket may limit reception because only a single CPU core may be used. Increasing the number of sockets will allow multiple threads to receive data, and process data in parallel, hence taking advantage of more CPU cores. Required for > 2gbps transfers. Default for this value is 1.
    
    Specified by:
    
    setNumReceiveSockets in interface FileTransferData
    
    Parameters:
    
    numReceiveSockets - the numReceiveSockets to set
  - setNumSenderSockets
```
public void setNumSenderSockets(int numSenderSockets)
```
    Description copied from interface: FileTransferData
    
    Sets the number of UDP sockets to use when uploading a file in UDP mode. Increasing the number of sockets used may boost performance at high speeds (i.e. greater than 500 Mbps)
    
    Specified by:
    
    setNumSenderSockets in interface FileTransferData
  - setNumSenderThreads
```
public void setNumSenderThreads(int numSenderThreads)
```
    Description copied from interface: FileTransferData
    
    This value determines how many blocks will be sent into the pipe before redundant data will be sent. In high RTT environments, this value multiplied by the block size should be higher than the product of the RTT and the target rate. Depending on the speed and spec of the disk, it may be advantageous to have more threads with a higher block size or vise versa. Number of threads is set to 5 by default.
    
    Specified by:
    
    setNumSenderThreads in interface FileTransferData
    
    Parameters:
    
    numSenderThreads - Number of block sender threads to start for each transmission.
  - setNumThreads
```
public void setNumThreads(int numThreads)
```
    Description copied from interface: FileTransferData
    
    This value determines how many blocks will be sent into the pipe before redundant data will be sent. In high RTT environments, this value multiplied by the block size should be higher than the product of the RTT and the target rate. Depending on the speed and spec of the disk, it may be advantageous to have more threads with a higher block size or vise versa. Number of threads is set to 5 by default.
    
    Specified by:
    
    setNumThreads in interface FileTransferData
    
    Parameters:
    
    numThreads - Number of block sender threads to start for each transmission.
  - setNumUDPSockets
```
public void setNumUDPSockets(int numUDPSockets)
```
    Description copied from interface: FileTransferData
    
    Sets the number of UDP sockets to use when uploading a file in UDP mode. Increasing the number of sockets used may boost performance at high speeds (i.e. greater than 500 Mbps)
    
    Specified by:
    
    setNumUDPSockets in interface FileTransferData
    
    Parameters:
    
    numUDPSockets - the Number of UDP Sockets to set
  - setObserver
```
public void setObserver(java.util.Observer obs)
```
    Description copied from interface: FileTransferData
    
    FCClient is not directly observable, however TransferHook is. Setting an Observer using this method ensures that the given Observer will be set on the TransferHook object returned from upload and download method calls prior to the actual transfer being initiated.
    
    Specified by:
    
    setObserver in interface FileTransferData
    
    Parameters:
    
    obs - the observer to set
  - setOptimizeBlockSize
```
public void setOptimizeBlockSize(boolean optimizeBlockSize)
```
    Description copied from interface: FileTransferData
    
    If set to true, FileCatalyst will attempt to optimize the current block size to be an exact multiple of the data size that is being transmitted. This feature is on by default.
    
    Specified by:
    
    setOptimizeBlockSize in interface FileTransferData
    
    Parameters:
    
    optimizeBlockSize - true/false to enabled and disable this feature.
  - setPacketQueueDepth
```
public void setPacketQueueDepth(int packetQueueDepth)
```
    Description copied from interface: FileTransferData
    
    Sets the depth of the application level packet queue. As packets are received, the are inserted into this queue to await processing. This queue is an extra level of protection against packet loss due to CPU and I/O bottlenecks, and may help performance when using more than 1 packet processor threads, or in virtual environments where CPU and I/O performance is not predictable. Client application will use these values for downloads only. Server has these values defined remotely for uploads.
    
    Specified by:
    
    setPacketQueueDepth in interface FileTransferData
    
    Parameters:
    
    packetQueueDepth - the packetQueueDepth to set
  - setPacketSize
```
public void setPacketSize(int packetSize)
```
    Description copied from interface: FileTransferData
    
    Set the unit size. This is the encoded unit size, and determines the eventual UDP packet size. If the unit size is greater than the MTU of the network with will create fragmented UDP packets. This can lead to higher performance in low loss environments, but may decrease performance in environments with very low MTU (ATM) or high packet loss environments. Unit size is set to 1024 Bytes by default.
    
    Specified by:
    
    setPacketSize in interface FileTransferData
    
    Parameters:
    
    packetSize - int value used to set the Unit Size
  - setPostTaskSentData
```
public void setPostTaskSentData(PostTaskSentData data)
```
    Description copied from interface: FileTransferData
    
    Sets the current post task sent data to the specified value
    
    Specified by:
    
    setPostTaskSentData in interface FileTransferData
  - setPostURL
```
public void setPostURL(java.lang.String postURL)
```
    Description copied from interface: FileTransferData
    
    Sets the current post URL to the value that is defined
    
    Specified by:
    
    setPostURL in interface FileTransferData
    
    Parameters:
    
    postURL - New postURL to use
  - setProgressiveTimeout
```
public void setProgressiveTimeout(int progressiveTimeout)
```
    Description copied from interface: FileTransferData
    
    Sets the current progressive timeout to the value supplied
    
    Specified by:
    
    setProgressiveTimeout in interface FileTransferData
    
    Parameters:
    
    progressiveTimeout - New timeout to set
  - setProgressiveTimeoutFilter
```
public void setProgressiveTimeoutFilter(java.lang.String progressiveTimeoutFilter)
```
    Description copied from interface: FileTransferData
    
    Sets the current progressive timeout filter to the value that is set to
    
    Specified by:
    
    setProgressiveTimeoutFilter in interface FileTransferData
    
    Parameters:
    
    progressiveTimeoutFilter - Filter to set
  - setProgressiveTransfers
```
public void setProgressiveTransfers(boolean progressiveTransfers)
```
    Description copied from interface: FileTransferData
    
    With this option enabled, upon completion of an upload or download, FileCatalyst will compare the size of the source file to the size when it began the transfer. If the file has grown, it will continue to transfer the new data until the file is no longer growing. In this way, it is able to download or upload files that are curently being copied, or are currently being encoded.
    
    Specified by:
    
    setProgressiveTransfers in interface FileTransferData
    
    Parameters:
    
    progressiveTransfers - boolean boolean Enables/disables the progressive transfer option
  - setReadBufferSizeKB
```
public void setReadBufferSizeKB(int readBufferSizeKB)
```
    Description copied from interface: FileTransferData
    
    Sets the read buffer size used when reading data from disk. Default (0) sets value to network buffer size. Client application will use these values for uploads only. Server has these values defined remotely for downloads.
    
    Specified by:
    
    setReadBufferSizeKB in interface FileTransferData
    
    Parameters:
    
    readBufferSizeKB - default value will utilize network block size for reads.
  - setReadTimeout
```
public void setReadTimeout(int readTimeout)
```
    Description copied from interface: FileTransferData
    
    This is the length of time the client will wait for a reply after sending a command to the FileCatalyst server.
    
    Specified by:
    
    setReadTimeout in interface FileTransferData
    
    Parameters:
    
    readTimeout - int New timeout value (in millisecs)
  - setRemotePort
```
public void setRemotePort(int remotePort)
```
    Description copied from interface: FileTransferData
    
    Sets the remote port to which this client will be connected. This should be called prior to calling the connect() method.
    
    Specified by:
    
    setRemotePort in interface FileTransferData
    
    Parameters:
    
    remotePort - int value to specify the remort post to be used
  - setRemoteServer
```
public void setRemoteServer(java.lang.String remoteServer)
```
    Description copied from interface: FileTransferData
    
    Set the remote server to which this client should connect. This should be called prior to calling the connect() method.
    
    Specified by:
    
    setRemoteServer in interface FileTransferData
    
    Parameters:
    
    remoteServer - String value to specify the server to connect to
  - setRenameExtension
```
public void setRenameExtension(boolean renameExtension)
```
    Description copied from interface: FileTransferData
    
    Sets whether or not the rename extension should be used
    
    Specified by:
    
    setRenameExtension in interface FileTransferData
    
    Parameters:
    
    renameExtension - Enabled boolean
  - setServerAgentID
```
public void setServerAgentID(java.lang.String serverAgentID)
```
    Description copied from interface: FileTransferData
    
    Sets the server agent ID to the new value
    
    Specified by:
    
    setServerAgentID in interface FileTransferData
    
    Parameters:
    
    serverAgentID - New value to set
  - setServletLocation
```
public void setServletLocation(java.lang.String servletLocation)
```
    Description copied from interface: FileTransferData
    
    FileCatalyst has the ability to upload using the HTTP/S protocol as long as the FileCatalyst Servlet application is installed and properly configured. This method allows you to set the URL of the FileCatalyst Servlet. Note that you must set the servlet location prior to calling connect(). You must also set the transfer mode to HTTP.
    
    Specified by:
    
    setServletLocation in interface FileTransferData
    
    Parameters:
    
    servletLocation - String The URL of the FileCatalyst Servlet
  - setServletLocation
```
public void setServletLocation(java.lang.String servletLocation,
                               java.lang.String servletSessionID,
                               java.lang.String welcomeMessage)
```
    Description copied from interface: FileTransferData
    
    FileCatalyst has the ability to upload using the HTTP/S protocol as long as the FileCatalyst Servlet application is installed and properly configured. This method allows you to set the URL of the FileCatalyst Servlet. Note that you must set the servlet location prior to calling connect(). You must also set the transfer mode to HTTP.
    
    Specified by:
    
    setServletLocation in interface FileTransferData
    
    Parameters:
    
    servletLocation - String The URL of the FileCatalyst Servlet
    
    servletSessionID - If s session was already established that should be re-used, this session id should be set
    
    welcomeMessage - When connecting with pre-connected Servlet session, you may pass the welcome message to the FCClient as well so it can detect whether this is a FileCatalyst server or not as well as extract the version string.
  - setServletMultiplier
```
public void setServletMultiplier(int servletMultiplier)
```
    Description copied from interface: FileTransferData
    
    When uploading in HTTP mode using FileCatalyst Servlet, this option allows the upload buffer size to be tuned.
    
    Specified by:
    
    setServletMultiplier in interface FileTransferData
    
    Parameters:
    
    servletMultiplier - int multiplier value used to tune upload buffer
  - setSessionCount
```
public void setSessionCount(int sessionCount)
```
  - setSessionID
```
public void setSessionID(java.lang.String sessionID)
```
    Description copied from interface: FileTransferData
    
    Sets the session ID to the specified value.
    
    Specified by:
    
    setSessionID in interface FileTransferData
  - setShowConsoleLog
```
public void setShowConsoleLog(boolean showConsoleLog)
```
    Description copied from interface: FileTransferData
    
    If set to true, all logging information is also sent to standard out. This must be enabled prior to calling the initialize method.
    
    Specified by:
    
    setShowConsoleLog in interface FileTransferData
    
    Parameters:
    
    showConsoleLog - boolean value set to show the console Log or not
  - setStartRate
```
public void setStartRate(int startRate)
```
    Description copied from interface: FileTransferData
    
    Sets the start rate for FC transfers in Kilobits per second. All FC transfer will begin at this rate and ramp up to the specified target rate if no congestion is encounters. Congestion control must be enabled for this value to have an effect. Start rate is set to 1000 Kbps by default.
    
    Specified by:
    
    setStartRate in interface FileTransferData
    
    Parameters:
    
    startRate - int value used to set the rate in which the transfer should start at
  - setTargetRate
```
public void setTargetRate(int targetRate)
```
    Description copied from interface: FileTransferData
    
    Sets the target rate (kbps) for this client. The client will attempt to transfer files no faster than the specified rate. If a transfer is already in progress, an attempt will be made to adjust it's target rate to the specified value.
    
    Specified by:
    
    setTargetRate in interface FileTransferData
    
    Parameters:
    
    targetRate - int value to specify the maximum transfer rate
  - setTransactionID
```
public void setTransactionID(java.lang.String uniqueID)
```
    Description copied from interface: FileTransferData
    
    Sets a unique transaction number for the transfer (instance variable). Transaction number will be used as part of working/temporary filenames when transferring a file.
    Applies to temporary file name, zip file name, signature/delta filename.
    By default, a random unique ID is created per machine by the API. This ensures that on the server, two separate client connections into the same user account should not encounter a filename collision. However, if two concurrent transfers are being launched using the same fileset (ie: upload using auto-zip) from the client API to separate servers, this value must be set for each transfer in order to ensure that temporary & working file name is not reused for two distinct transfers.
    Value may be overridden if you explicitly specify a transaction ID during upload(Vector, String, String) or download(Vector, String, String) calls.
    
    Specified by:
    
    setTransactionID in interface FileTransferData
    
    Parameters:
    
    uniqueID - String value, should be alpha-numeric (Long.toString(System.currentTimeMillis()))
  - setTransferEmptyDirectories
```
public void setTransferEmptyDirectories(boolean transferEmptyDirectories)
```
    Description copied from interface: FileTransferData
    
    Sets whether or not the implementation should transfer empty directories
    
    Specified by:
    
    setTransferEmptyDirectories in interface FileTransferData
    
    Parameters:
    
    transferEmptyDirectories - Boolean value to set
  - setTransferRate
```
public void setTransferRate(int transferRate)
```
  - setTransferWithTempName
```
public void setTransferWithTempName(boolean transferWithTempName)
```
    Description copied from interface: FileTransferData
    
    With this option enabled, files will be uploaded with a temporary filename and renamed back to their original name when the transfer is complete. This allows other applications to identify files that are not complete.
    
    Specified by:
    
    setTransferWithTempName in interface FileTransferData
    
    Parameters:
    
    transferWithTempName - boolean true/false to enable or disable this feature
  - setTransferWithTempName
```
public void setTransferWithTempName(boolean transferWithTempName,
                                    int tempMode)
```
    Description copied from interface: FileTransferData
    
    With this option enabled, files will be uploaded with a temporary filename and renamed back to their original name when the transfer is complete. This allows other applications to identify files that are not complete.
    
    Specified by:
    
    setTransferWithTempName in interface FileTransferData
    
    Parameters:
    
    transferWithTempName - boolean true/false to enable or disable this feature
    
    tempMode - int Sets the desired mode, TransferMode.PREFIX or TransferMode.SUFFIX.
    
    See Also:
    
    TransferMode
  - setUnitSize
```
public void setUnitSize(int unitSize)
```
    Description copied from interface: FileTransferData
    
    Use setPacketSize()
    
    Specified by:
    
    setUnitSize in interface FileTransferData
    
    Parameters:
    
    unitSize - int value used to set the Unit Size. In Bytes.
  - setUseCompression
```
public void setUseCompression(boolean useCompression)
```
    Description copied from interface: FileTransferData
    
    Enables/disables on the fly compression. When enabled, each block of data will be compressed on the fly before it is sent over the network.
    
    Specified by:
    
    setUseCompression in interface FileTransferData
    
    Parameters:
    
    useCompression - boolean true/false to enable/disable compression.
  - setUseCongestionControl
```
public void setUseCongestionControl(boolean useCongestionControl)
```
    Description copied from interface: FileTransferData
    
    Enables/disables congestion control for this client. When enabled, the client will automatically decrease its transmission or reception rate when congestion is detected. Future versions will allow finer grain control over the reaction algorithm. Congestion control is set to true by default.
    
    Specified by:
    
    setUseCongestionControl in interface FileTransferData
    
    Parameters:
    
    useCongestionControl - boolean value used to turn congestion control on/off
  - setUseIncremental
```
public void setUseIncremental(boolean useIncremental)
```
    Description copied from interface: FileTransferData
    
    If set to true, before each source file is transferred, it will be compared with the destination file if it exists to ensure the file has changed. If the file has not changed, the file will not be transmitted. This feature is off by default.
    
    Specified by:
    
    setUseIncremental in interface FileTransferData
    
    Parameters:
    
    useIncremental - boolean value to turn incremental on/off
  - setUseSSL
```
public void setUseSSL(boolean useSSL)
```
    Description copied from interface: FileTransferData
    
    If set to true, control connection will be made using an implicit SSL connection. This must be set prior to calling the connect method.
    
    Specified by:
    
    setUseSSL in interface FileTransferData
    
    Parameters:
    
    useSSL - Boolean value to turn SSL on/off
  - setSSLSocketProducer
```
public void setSSLSocketProducer(unlimited.core.transfers.net.ssl.FCSSLSocketProducerImpl socketProducer)
```
    Description copied from interface: FileTransferData
    
    Sets the implementation that will be used to generate SSL sockets
    
    Specified by:
    
    setSSLSocketProducer in interface FileTransferData
    
    Parameters:
    
    socketProducer - Concrete instance that provides logic for generating SSL sockets
  - setVerifyIntegrity
```
public void setVerifyIntegrity(boolean verifyIntegrity)
```
    Description copied from interface: FileTransferData
    
    If set to true, after each file is transferred an MD5 sum will be performed on the destination file and the result will be compared to that of the source file to ensure the files are identical. Verify integrity is false by default.
    
    Specified by:
    
    setVerifyIntegrity in interface FileTransferData
    
    Parameters:
    
    verifyIntegrity - true/false to enable or disable this feature.
  - setVerifyMode
```
public void setVerifyMode(int verifyMode)
```
    Description copied from interface: FileTransferData
    
    Sets the integrity verification mode
    
    Specified by:
    
    setVerifyMode in interface FileTransferData
    
    Parameters:
    
    verifyMode - int Sets the desired mode, TransferMode.VERIFY_AFTER or TransferMode.VERIFY_ON_THE_FLY.
    
    See Also:
    
    TransferMode
  - setWaitRetry
```
public void setWaitRetry(long waitRetry)
```
    Description copied from interface: FileTransferData
    
    Sets the amount of time in milliseconds to wait before the client attempts to retry a failed transfer
    
    Specified by:
    
    setWaitRetry in interface FileTransferData
    
    Parameters:
    
    waitRetry - the waitRetry to set
  - setWriteBufferSizeKB
```
public void setWriteBufferSizeKB(int writeBufferSizeKB)
```
    Description copied from interface: FileTransferData
    
    Sets the write buffer size used when saving data to disk. Default (0) sets value to network buffer size. Client application will use these values for downloads only. Server has these values defined remotely for uploads.
    
    Specified by:
    
    setWriteBufferSizeKB in interface FileTransferData
    
    Parameters:
    
    writeBufferSizeKB - default value will utilize network block size for writes. Value in KB.
  - setWriteFileMode
```
public void setWriteFileMode(java.lang.String writeFileMode)
```
    Description copied from interface: FileTransferData
    
    Set JAVA file write mode when saving data to disk. Client application will use these values for downloads only. Server has these values defined remotely for uploads.
    
    Specified by:
    
    setWriteFileMode in interface FileTransferData
    
    Parameters:
    
    writeFileMode - Default "" uses "rws" for Windows/Linux, and "rw" for Solaris/MacOSX. Possible values are "", rw, rws, rwd
  - setZipFileSizeLimit
```
public void setZipFileSizeLimit(long zipFileSizeLimit)
```
    Description copied from interface: FileTransferData
    
    Sets the zip file size limit to the value specified. This zip file size limit is the maximum size that a zip file can be once it is created. If a zip file exceeds this value it will be split into multiple zips, and transferred in pieces
    
    Specified by:
    
    setZipFileSizeLimit in interface FileTransferData
    
    Parameters:
    
    zipFileSizeLimit - the zipFileSizeLimit (in bytes) to set
  - setUserRelativePriority
```
public void setUserRelativePriority(int priority)
```
    Description copied from interface: FileTransferData
    
    This priority hint is to help the server distribute bandwidth within its own set parameters. The scope of the hint is for all sessions with this client's agent ID connecting to this client's user.
    
    Specified by:
    
    setUserRelativePriority in interface FileTransferData
    
    Parameters:
    
    priority - hint for server to distribute bandwidth when it would normally split it evenly.
  - getUserRelativePriority
```
public int getUserRelativePriority()
```
    Description copied from interface: FileTransferData
    
    This priority hint is to help the server distribute bandwidth within its own set parameters. The scope of the hint is for all sessions with this client's agent ID connecting to this client's user.
    
    Specified by:
    
    getUserRelativePriority in interface FileTransferData
    
    Returns:
    
    priority hint for server to distribute bandwidth when it would normally split it evenly.
  - pwd
```
public java.lang.String pwd()
                     throws unlimited.core.util.common.exception.FCException,
                            java.io.IOException
```
    Description copied from interface: FileTransferData
    
    Returns the current remote working directory.
    
    Specified by:
    
    pwd in interface FileTransferData
    
    Returns:
    
    the current remote working directory.
    
    Throws:
    
    unlimited.core.util.common.exception.FCException - If an error in the FC protocol occurs
    
    java.io.IOException - If a timeout, or other IO error occurs
  - cd
```
public void cd(java.lang.String path)
        throws unlimited.core.util.common.exception.FCException,
               java.io.IOException
```
    Description copied from interface: FileTransferData
    
    Sets the current remote working directory to the specified path. This can be relative or absolute.
    
    Specified by:
    
    cd in interface FileTransferData
    
    Parameters:
    
    path - The desired remote path to change to.
    
    Throws:
    
    unlimited.core.util.common.exception.FCException - If an error in the FC protocol occurs, permission denied, etc...
    
    java.io.IOException - If a timeout, or other IO error occurs
  - isForceFileOwnershipEnabled
```
public boolean isForceFileOwnershipEnabled()
```
    Description copied from interface: unlimited.fc.client.api.filelist.FileListDataItemSource
    
    Returns true if the force file ownership feature is currently enabled. If it is, then all files downloaded this client will have their ownership changed to current values for the ForceFileOwnershipUsername, and ForceFileOwnershipGroupname
    
    Specified by:
    
    isForceFileOwnershipEnabled in interface unlimited.fc.client.api.filelist.FileListDataItemSource
    
    Returns:
    
    the isForceFileOwnershipEnabled
  - setForceFileOwnershipEnabled
```
public void setForceFileOwnershipEnabled(boolean isForceFileOwnershipEnabled)
```
    Description copied from interface: unlimited.fc.client.api.filelist.FileListDataItemSource
    
    Sets whether or not the force file ownership feature is enabled. If it is, then all files downloaded this client will have their ownership changed to current values for the ForceFileOwnershipUsername, and ForceFileOwnershipGroupname
    
    Specified by:
    
    setForceFileOwnershipEnabled in interface unlimited.fc.client.api.filelist.FileListDataItemSource
    
    Parameters:
    
    isForceFileOwnershipEnabled - the isForceFileOwnershipEnabled to set
  - getForceFileOwnershipUser
```
public java.lang.String getForceFileOwnershipUser()
```
    Description copied from interface: FileTransferData
    
    Returns the username to be used when attempting to force file ownership for files downloaded by the client
    
    Specified by:
    
    getForceFileOwnershipUser in interface FileTransferData
    
    Returns:
    
    the forceFileOwnershipUser
  - setForceFileOwnershipUser
```
public void setForceFileOwnershipUser(java.lang.String forceFileOwnershipUser)
```
    Description copied from interface: FileTransferData
    
    Sets the username to be used when attempting to force file ownership for files downloaded by the client
    
    Specified by:
    
    setForceFileOwnershipUser in interface FileTransferData
    
    Parameters:
    
    forceFileOwnershipUser - the forceFileOwnershipUser to set
  - getForceFileOwnershipGroup
```
public java.lang.String getForceFileOwnershipGroup()
```
    Description copied from interface: FileTransferData
    
    Returns the groupname / groupID to be used when attempting to force group level ownership for files downloaded by the client.
    Note: Value is ignored if on a Windows platform
    
    Specified by:
    
    getForceFileOwnershipGroup in interface FileTransferData
    
    Returns:
    
    the forceFileOwnershipGroup
  - setForceFileOwnershipGroup
```
public void setForceFileOwnershipGroup(java.lang.String forceFileOwnershipGroup)
```
    Description copied from interface: FileTransferData
    
    Sets the groupname / groupID to be used when attempting to force group level ownership for files downloaded by the client.
    Note: Value is ignored if on a Windows platform
    
    Specified by:
    
    setForceFileOwnershipGroup in interface FileTransferData
  - getSynchedFrom
```
public void getSynchedFrom(FileTransferData master)
```
    Syncs the supplied FileTransferData instance to this data object.
    
    Parameters:
    
    master - TransferData to be synced to this object
  - synchThisTo
```
public void synchThisTo(FileTransferData slave)
```
    Syncs this Servlet information to the specified FileTransferData instance
    
    Parameters:
    
    slave - TransferData to sync this information to
  - synch
```
public static void synch(FileTransferData client,
                         FileTransferData master)
```
  - synchIgnoreTargetRate
```
public static void synchIgnoreTargetRate(FileTransferData client,
                                         FileTransferData master)
```
  - synchAndConnect
```
public static void synchAndConnect(FileTransferMechanism client,
                                   FileTransferData master)
```
  - synchConnectAndCD
```
public static void synchConnectAndCD(FileTransferMechanism client,
                                     FileTransferData master)
```
  - loadFromProperties
```
public void loadFromProperties()
```
  - saveToProperties
```
public void saveToProperties()
```
  - loadFromFile
```
public void loadFromFile(java.nio.file.Path propFile)
```
  - loadFromChannel
```
protected void loadFromChannel(java.nio.channels.SeekableByteChannel channel)
                        throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - saveToFile
```
public void saveToFile(java.nio.file.Path propFile)
```
  - initializeWorkingDirectory
```
public void initializeWorkingDirectory(java.lang.String pwd)
```
    Initializes the current working directory to the value specified. Value is used to distinguish the current remote directory
    
    Parameters:
    
    pwd - Remote directory to set. If null, working directory becomes uninitialized.
  - isWorkingDirectoryInitialized
```
public boolean isWorkingDirectoryInitialized()
```
    Returns whether or not the working directory is currently initialized. If the value is properly initialized, then the mechanism will return it for calls made to pwd(). Otherwise the mechanism will try to re-establish and reinitialize the working directory
    
    Returns:
    
    True if value is initialized, false otherwise
  - importFile
```
public static void importFile(java.nio.file.Path aFile,
                              FileTransferData destination)
                       throws java.io.IOException
```
    Imports the properties defined within a file, and synchs them with to the supplied FileTransferData object
    
    Parameters:
    
    aFile - File to load the properites from
    
    destination - TransferData to import the properties too.
    
    Throws:
    
    java.io.IOException - Thrown if there is an issue importing the properties
  - importProperties
```
public static void importProperties(java.util.Properties props,
                                    FileTransferData destination)
                             throws java.io.IOException
```
    Imports the properties information and synchs them with to the supplied FileTransferData object
    
    Parameters:
    
    props - Properties object to import into the TransferData
    
    destination - TransferData to import the properties too.
    
    Throws:
    
    java.io.IOException - Thrown if there is an issue importing the properties
  - exportFile
```
public static void exportFile(java.nio.file.Path aFile,
                              FileTransferData source)
                       throws java.io.IOException
```
    Exports the supplied FileTransferData data as properties and writes the information to the specified file path
    
    Parameters:
    
    aFile - Path to which the properties should be exported too.
    
    source - FileTransferData information to be exported
    
    Throws:
    
    java.io.IOException - Thrown if there are issues with file access.
  - exportProperties
```
public static java.util.Properties exportProperties(FileTransferData source)
                                             throws java.io.IOException
```
    Exports the supplied FileTransferData data into a standard properties object
    
    Parameters:
    
    source - FileTransferData information to be exported
    
    Throws:
    
    java.io.IOException - Thrown if there are issues with file access.
  - lastServerRestrictedRate
```
public int lastServerRestrictedRate()
```
    Description copied from interface: FileTransferData
    
    Returns the last rate (kbps) that the Server had replied with. This rate takes into account what the server is imposing during a transfer bandwidth speed.
    
    Specified by:
    
    lastServerRestrictedRate in interface FileTransferData
  - setLastServerRestrictedRate
```
public void setLastServerRestrictedRate(int actual)
```
  - isServerOverridebandwidth
```
public boolean isServerOverridebandwidth()
```
    Description copied from interface: FileTransferData
    
    Returns whether or not the server has specified that the bandwidth should be overridden. If true, then the bandwidth allocated to the client will be the value specified by the current server override bandwidth. If false, then the client will attempt to transfer at the rate specified by the target rate.
    
    Specified by:
    
    isServerOverridebandwidth in interface FileTransferData
    
    Returns:
    
    true if the server is overriding the bandwidth during a transfer, always false if no transfer is happening.
  - setIsServerOverrideBandwidth
```
public void setIsServerOverrideBandwidth(boolean isOverride)
```
  - getServerOverrideBandwidth
```
public int getServerOverrideBandwidth()
```
    Description copied from interface: FileTransferData
    
    Returns the override bandwidth value that has been specified by server. If isServerOverrideBandwith() == false, then 0 is returned
    
    Specified by:
    
    getServerOverrideBandwidth in interface FileTransferData
    
    Returns:
    
    if isServerOverridebandwidth() is true returns the serverOverrideBandwidth otherwise returns 0;
  - setTransferToServerOverride
```
public void setTransferToServerOverride(int serverOverrideBW)
```
    Description copied from interface: FileTransferData
    
    Sets bandwidth value that the Server is attempting to override this client to. If the isServerOverrideBandwidth() returns true, then the client will attempt to transfer at the specified by the server override. Otherwise, it will attempt to transfer at the defined target rate.
    
    Specified by:
    
    setTransferToServerOverride in interface FileTransferData
    
    Parameters:
    
    serverOverrideBW - Kbps bandwidth value
  - setServerOverrideBandwidth
```
public void setServerOverrideBandwidth(int totalOverridebandwidth)
```
  - setTaskID
```
public void setTaskID(java.lang.String taskID)
```
    Description copied from interface: FileTransferData
    
    Sets the current task ID to the new value supplied
    
    Specified by:
    
    setTaskID in interface FileTransferData
  - getTaskID
```
public java.lang.String getTaskID()
```
    Description copied from interface: FileTransferData
    
    Returns the current task ID
    
    Specified by:
    
    getTaskID in interface FileTransferData
    
    Returns:
  - getFileTransferPriority
```
public int getFileTransferPriority()
```
    Description copied from interface: FileTransferData
    
    Returns the task file transfer priority
    
    Specified by:
    
    getFileTransferPriority in interface FileTransferData
    
    Returns:
  - setFileTransferPriority
```
public void setFileTransferPriority(int fileTransferPriority)
```
    Description copied from interface: FileTransferData
    Sets the FileTransferPrioriry to new new value. .
    Valid values are as follows:
    - 0 = Oldest files are transferred first
    - 1 = Newest files are transferred first
    - 2 = Smallest files are transferred first
    - 3 = Largest files are transferred first
    - 4 = No Priority for files
    Specified by:
    
    setFileTransferPriority in interface FileTransferData
  - setIsAuto
```
public void setIsAuto(boolean isAutoMode)
```
  - isFileCatalystServer
```
public boolean isFileCatalystServer()
                             throws java.io.IOException,
                                    unlimited.core.util.common.exception.FCException
```
    Do not use this method, it only throws an exception, was put in during the effort to unify listings between single and multi client
    
    Specified by:
    
    isFileCatalystServer in interface unlimited.fc.client.api.filelist.FileListDataItemSource
    
    Returns:
    
    true if connected to a FileCatalyst server.
    
    Throws:
    
    java.io.IOException
    
    unlimited.core.util.common.exception.FCException
  - streamWithInlineParse
```
public java.util.stream.Stream<FileListDataItem> streamWithInlineParse()
                                                                throws unlimited.core.util.common.exception.FCException,
                                                                       java.io.IOException
```
    Do not use this method, it only throws an exception, was put in during the effort to unify listings between single and multi client
    
    Specified by:
    
    streamWithInlineParse in interface unlimited.fc.client.api.filelist.FileListDataItemSource
    
    Returns:
    
    stream of FileListDataItems
    
    Throws:
    
    unlimited.core.util.common.exception.FCException - If an error in the FC protocol occurs
    
    java.io.IOException - If a timeout, or other IO error occurs
  - list
```
public FileListData list()
                  throws unlimited.core.util.common.exception.FCException,
                         java.io.IOException
```
    Do not use this method, it only throws an exception, was put in during the effort to unify listings between single and multi client
    
    Specified by:
    
    list in interface unlimited.fc.client.api.filelist.FileListDataItemSource
    
    Returns:
    
    meta data for files in the current remote directory.
    
    Throws:
    
    unlimited.core.util.common.exception.FCException - If an error in the FC protocol occurs
    
    java.io.IOException - If a timeout, or other IO error occurs
  - prms
```
public java.lang.String[] prms(java.lang.String filename)
                        throws unlimited.core.util.common.exception.FCException,
                               java.io.IOException
```
    Do not use this method, it only throws an exception, was put in during the effort to unify listings between single and multi client
    
    Specified by:
    
    prms in interface unlimited.fc.client.api.filelist.FileListDataItemSource
    
    Returns:
    
    permissions
    
    Throws:
    
    unlimited.core.util.common.exception.FCException
    
    java.io.IOException
  - size
```
public long size(java.lang.String remoteFile)
          throws unlimited.core.util.common.exception.FCException,
                 java.io.IOException
```
    Do not use this method, it only throws an exception, was put in during the effort to unify listings between single and multi client
    
    Specified by:
    
    size in interface unlimited.fc.client.api.filelist.FileListDataItemSource
    
    Parameters:
    
    remoteFile - String The path to the remote file
    
    Returns:
    
    long the size of the remote file or -1 if it doesn't exist
    
    Throws:
    
    unlimited.core.util.common.exception.FCException - If an error in the FC protocol occurs
    
    java.io.IOException - If a timeout, or other IO error occurs
  - get
```
public void get(java.lang.String localPath,
                java.lang.String remoteFile,
                int inRate,
                long offset,
                long size,
                int numDFEncoders,
                int blockSize,
                int unitSize,
                int mode)
         throws java.io.IOException,
                unlimited.core.util.common.exception.FCException,
                java.security.NoSuchAlgorithmException,
                unlimited.core.util.common.exception.FCException,
                java.io.IOException
```
    Do not use this method, it only throws an exception, was put in during the effort to unify listings between single and multi client
    
    Specified by:
    
    get in interface unlimited.fc.client.api.filelist.FileListDataItemSource
    
    Parameters:
    
    localPath - Location of where to store the file after it has been downloaded
    
    remoteFile - Remote file to be downloaded from the Server
    
    inRate - Rate to use for the download transfer
    
    offset - Location in the local file to start placing downloaded data into (0 = start of file)
    
    size - Amount of date to retrieve from the FC Server. (Typically this is (remote file size - (offset))
    
    numDFEncoders - Number of encoders to use for the
    
    blockSize - Size of blocks to be used in the download transfer
    
    unitSize - Size of the individual units in the download transfer. Value with compared with the Server's max unit size. Minimum of the two values will be used
    
    mode - Transfer mode to be used for the download. Available modes can be at TransferMode
    
    Throws:
    
    java.io.IOException
    
    unlimited.core.util.common.exception.FCException
    
    java.security.NoSuchAlgorithmException
  - delete
```
public void delete(java.lang.String file)
            throws unlimited.core.util.common.exception.FCException,
                   java.io.IOException
```
    Do not use this method, it only throws an exception, was put in during the effort to unify listings between single and multi client
    
    Specified by:
    
    delete in interface unlimited.fc.client.api.filelist.FileListDataItemSource
    
    Parameters:
    
    file - The file to be deleted
    
    Throws:
    
    unlimited.core.util.common.exception.FCException - If an error in the FC protocol occurs
    
    java.io.IOException - If a timeout, or other IO error occurs
  - streamWithInlineParse
```
public java.util.stream.Stream<FileListDataItem> streamWithInlineParse(java.util.function.BooleanSupplier isCancelled)
                                                                throws unlimited.core.util.common.exception.FCException,
                                                                       java.io.IOException
```
    Description copied from interface: unlimited.fc.client.api.filelist.FileListDataItemSource
    
    Returns streaming meta data for files in the current remote directory. Use if you expect a large collection of files to be returned from the Server
    
    Specified by:
    
    streamWithInlineParse in interface unlimited.fc.client.api.filelist.FileListDataItemSource
    
    Parameters:
    
    isCancelled - cancel handler to stop stream on cancel
    
    Returns:
    
    stream of FileListDataItems
    
    Throws:
    
    unlimited.core.util.common.exception.FCException - If an error in the FC protocol occurs
    
    java.io.IOException - If a timeout, or other IO error occurs
  - getClientCredentials
```
public java.util.function.Supplier<ClientCredentials> getClientCredentials()
```
    Description copied from interface: FileTransferData
    
    Returns the credentials supplier that is set for this client.
    
    Specified by:
    
    getClientCredentials in interface FileTransferData
    
    Returns:
    
    the credentials supplier that is set for this client.
  - setClientCredentials
```
public void setClientCredentials(java.util.function.Supplier<ClientCredentials> creds)
```
    Description copied from interface: FileTransferData
    
    Sets the credentials supplier for this connection. Value is used to determine which user this transfer mechanism attempts to connect to a FC Server
    
    Specified by:
    
    setClientCredentials in interface FileTransferData

Class TransferMechanismData

Nested Class Summary

Field Summary

Fields inherited from class java.util.Properties

Constructor Summary

Method Summary

Methods inherited from class unlimited.core.util.common.ConfigTool

Methods inherited from class java.util.Properties

Methods inherited from class java.util.Hashtable

Methods inherited from class java.lang.Object

Methods inherited from interface unlimited.fc.client.api.FileTransferData

Methods inherited from interface unlimited.fc.client.api.filelist.FileListDataItemSource

Field Detail

compressionData

Constructor Detail

TransferMechanismData

TransferMechanismData

Method Detail

clone

getBlastRate

getBlockSize

getCallbackHandler

getClientAgentID

getClientConnectKey

getClientIdentifier

getClientString

getClientSubIdentifier

getCompFileFilter

getCompLevel

getCompMethod

getCompressionData

getCompStrategy

getCongCtrlStrategy

getCongestionControlAggression

getConnectTimeout

getExtendedReadTimeout

getFileFilter

getClientName

getIncomingDataPort

getIncomingDataPorts

getIncrementalMode

getLocalWorkingDirectoryPath

getLogger

getLogLocation

getMaxRetries

getMd5RateLimit

getMode

getNumBlockReaders

getNumBlockWriters

getNumFTPStreams

getNumPacketProcessors

getNumReceiveSockets

getNumSenderSockets

getNumSenderThreads

getNumThreads

getNumUDPSockets

getObserver

getPacketQueueDepth

getPacketSize

getPostTaskSentData

getPostURL

getProgressiveTimeout

getProgressiveTimeoutFilter

getReadBufferSizeKB

getReadTimeout

getRemotePort

getRemoteServer

getRenameExtension

getServerAgentID

getServletLocation

getServletLocationData

getServletMultiplier

getSessionCount

getSessionID

getStartRate

getSSLSocketProducer

getTargetRate

getTempMode

getTransactionID

getTransferEmptyDirectories