java.lang.Object
- unlimited.fc.client.api.multiclient.MultiClientState
- - unlimited.fc.client.api.multiclient.CreatedState

Direct Known Subclasses:

InitializedState, InitializedState.DisconnectingState, InitializedState.Transition
```
public class CreatedState
extends MultiClientState
```
The Class CreatedState.

Nested Class Summary
- Nested classes/interfaces inherited from class unlimited.fc.client.api.multiclient.MultiClientState
  MultiClientState.StateMachineException

Field Summary
- Fields inherited from class unlimited.fc.client.api.multiclient.MultiClientState
  cause, parent

Constructor Summary

Constructors
Modifier Constructor Description

protected CreatedState(MultiClientState oldState)

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`protected void`	`addCustomLogHandler(java.util.logging.Handler handler)`	Adds a custom log handler to which API logs will be published.
`protected void`	`applyRemoteFileAttributesToLocalFile(java.nio.file.Path localFile, java.lang.String remoteFile)`	Applies the remote file attributes to the local file instance.
`protected void`	`autoDetectConectionMode()`
`protected void`	`autoDetectConectionModeDownload()`	This method will attempt to detect the optimal connection method based on the provided server information, HTTP servlet location, and ports.
`protected void`	`autoDetectConectionModeDownload(boolean testUDP, boolean portFallback)`	This method will attempt to detect the optimal connection method based on the provided server information, HTTP servlet location, and ports.
`protected void`	`autoDetectConectionModeUpload()`	This method will attempt to detect the optimal connection method based on the provided server information, HTTP servlet location, and ports.
`protected void`	`autoDetectConectionModeUpload(boolean testUDP, boolean portFallback)`	This method will attempt to detect the optimal connection method based on the provided server information, HTTP servlet location, and ports.
`protected void`	`autoDetectConectionModeUploadAndDownload()`	This method will attempt to detect the optimal connection method based on the provided server information, HTTP servlet location, and ports.
`protected void`	`autoDetectConectionModeUploadAndDownload(boolean portFallback)`	This method will attempt to detect the optimal connection method based on the provided server information, HTTP servlet location, and ports.
`protected void`	`cd(java.lang.String path)`	Navigates the manager into the supplied path.
`protected void`	`cdup()`	Move up one directory on the remote directory structure.
`protected void`	`connect()`	Connect to the FileCatalyst server.
`protected void`	`delete(java.lang.String file)`	Deletes the specified file from the remote file system.
`protected void`	`deleteAll(java.util.List files)`	Delete all specified files in a single efficient command.
`protected void`	`deleteAll(FileListData files)`	Delete all specified files in a single efficient command.
`protected void`	`deleteAll(FileListDataItem[] files)`	Delete all specified files in a single efficient command.
`protected void`	`disconnect()`	Disconnect from the server.
`protected void`	`doJob(TransferRunner runner)`
`protected TransferHook`	`download(java.lang.String remoteFile)`	Download a the specified file to the current local working directory.
`protected TransferHook`	`download(java.lang.String remoteFile, java.lang.String localPath)`	Download the specified file to the specified local path.
`protected TransferHook`	`download(java.util.List<java.lang.String> files)`	Downloads the files as specified by the paths (in String format) contained in the specified vector to the current working directory.
`protected TransferHook`	`download(java.util.List<java.lang.String> files, java.lang.String localPath)`	Download the specified file to the specified local file.
`protected TransferHook`	`download(java.util.List<java.lang.String> files, java.lang.String localPath, java.lang.String transferUniqueID, boolean needsRecurse)`	Downloads the files as specified by the paths (in String format) contained in the specified vector to the current working directory.
`protected TransferHook`	`download(FileListData files)`	Downloads the files specified in the FileListData object to the current local working directory.
`protected TransferHook`	`download(FileListData files, java.lang.String localPath, java.lang.String transferUniqueID, boolean needsRecurse)`	Downloads the files specified in the FileListData object to the specified path.
`protected TransferHook`	`downloadAs(FileListDataItem remoteFile, java.nio.file.Path localFile, java.lang.String transferUniqueID)`	Download the specified file to the specified local file.
`protected void`	`downloadRange(java.nio.file.Path localFile, java.lang.String remoteFile, long offset, long length)`	Downloads a range of rate for the given file
`protected void`	`downloadStream(java.util.stream.Stream<FileListDataItem> stream)`
`protected boolean`	`exists(java.lang.String remoteFile)`	Test if the remote file, denoted by the given remote path, exists on the server and returns true if it exists, false otherwise.
`protected unlimited.core.util.common.AutoClose<unlimited.core.util.common.stream.PairStream<java.lang.String,java.lang.Boolean>>`	`exists(java.util.stream.Stream<java.lang.String> remoteFile)`	Test if the remote file, denoted by the given remote path, exists on the server and returns true if it exists, false otherwise.
`protected boolean`	`filesMatch(java.nio.file.Path file, java.lang.String rFile, int md5RateLimit, unlimited.core.util.common.CancelHandler cancelHandler)`	Verifies whether a local file matches a remote file using MD5 checksum
`protected java.util.List<FileSystemEvent>`	`fileSystemEvents(long timeout)`	Returns the file system events, (if any I assume).
`protected void`	`finish()`	Cleans up memory allocated by the native libraries component of FileCatalyst.
`protected void`	`flushCaches()`	Deletes underlying caches for file sizes and date/time stamps
`protected void`	`fsEvents()`	Prints out a list of the current file system events that are set on the server.
`protected void`	`get(java.lang.String localPath, java.lang.String remoteFile, int inRate, long offset, long size, int numDFEncoders, int blockSize, int unitSize, int mode)`
`ServerConfigs`	`getAllAvailableServerConfigs()`	Request if link is enabled on the server that you are connected too
`protected int`	`getBlastRate()`
`protected int`	`getBlockSize()`
`protected FileCatalystClientCallbackHandler`	`getCallbackHandler()`	Returns the current callback handler
`protected java.lang.String`	`getClientConnectKey()`
`protected java.util.function.Supplier<ClientCredentials>`	`getClientCredentials()`
`protected java.lang.String`	`getClientName()`
`protected java.lang.String`	`getCompFileFilter()`
`protected int`	`getCongCtrlStrategy()`
`protected int`	`getCongestionControlAggression()`
`protected ConnectivityTestResultContainer`	`getConnectivityTestResults()`	Returns a data container object that contains information about whether or not uploads, downloads or overall transfers will work
`protected int`	`getConnectTimeout()`
`protected TransferMechanismData`	`getData()`
`protected int`	`getExtendedReadTimeout()`
`protected FileCatalystFileFilter`	`getFileFilter()`
`void`	`getHandledBy(StateHandler handler)`	Gets the handled by.
`java.lang.String`	`getHumanReadableName()`	Returns a human readable name for the state.
`protected int`	`getIncomingDataPort()`
`protected int[]`	`getIncomingDataPorts()`
`protected int`	`getIncrementalMode()`
`protected java.lang.String`	`getLocalWorkingDirectory()`
`protected unlimited.core.util.common.logs.LogUtils`	`getLogger()`
`protected java.lang.String`	`getLogLocation()`
`protected int`	`getMaxRetries()`
`protected java.lang.String`	`getMD5(java.lang.String remote)`	Returns the MD5 checksum for the specified remote file if it exists
`protected java.lang.String`	`getMD5Checksum(java.lang.String rFile)`	Returns the MD5 checksum for the given remote file
`protected int`	`getMd5RateLimit()`
`protected int`	`getMode()`
`protected int`	`getNumBlockReaders()`	Returns the number of block readers
`protected int`	`getNumBlockWriters()`
`protected int`	`getNumFTPStreams()`
`protected int`	`getNumPacketProcessors()`
`protected int`	`getNumReceiveSockets()`
`protected int`	`getNumSenderSockets()`
`protected int`	`getNumSenderThreads()`
`protected int`	`getNumThreads()`
`protected int`	`getNumUDPSockets()`
`protected java.util.Observer`	`getObserver()`
`protected int`	`getPacketQueueDepth()`
`protected int`	`getPacketSize()`
`protected java.lang.String`	`getPostURL()`
`protected int`	`getProgressiveTimeout()`
`protected java.lang.String`	`getProgressiveTimeoutFilter()`
`protected int`	`getReadBufferSizeKB()`	Returns the read buffer size in KB
`protected int`	`getReadTimeout()`
`protected int`	`getRemotePort()`
`protected java.lang.String`	`getRemoteServer()`
`protected boolean`	`getRenameExtension()`
`protected java.lang.String`	`getServerAgentID()`
`java.lang.String`	`getServerConfigurationValue(java.lang.String value)`	Request if link is enabled on the server that you are connected too
`protected java.lang.String`	`getServletLocation()`
`protected int`	`getServletMultiplier()`
`protected int`	`getSessionCount()`
`protected int`	`getStartRate()`
`protected boolean`	`getTransferEmptyDirectories()`
`protected int`	`getTransferRate()`
`protected int`	`getUnitSize()`
`protected java.lang.String`	`getUserEmailAddress()`	Get The User's Email Address When Called
`protected java.lang.String`	`getUserFullName()`	Get The User's Full Name When Called
`protected UserPermissionsContainer`	`getUserPermissions()`	Gather's the user's permissions
`protected int`	`getVerifyMode()`
`protected long`	`getWaitRetry()`
`protected int`	`getWriteBufferSizeKB()`	Returns the write buffer size
`protected java.lang.String`	`getWriteFileMode()`	Gets the write file mode when called
`protected void`	`initialize(boolean generateUserLogs)`	Initialize Multi-Client object.
`protected void`	`initializeNoUserLogs()`	Initializes the TransferMechanism with no user logs
`protected void`	`initSession()`
`protected boolean`	`isAutoResume()`
`protected boolean`	`isAutoUnzip()`
`protected boolean`	`isCancelled()`
`protected boolean`	`isCongestionControlEnabled()`
`protected boolean`	`isDebug()`
`protected boolean`	`isDeleteAfterTransfer()`
`protected boolean`	`isDowngradeModeOnReConnect()`	Returns whether or not the state is set to downgrade mode on reconnect
`protected boolean`	`isFileCatalystServer()`	Returns true if connected to a FileCatalyst server.
`protected boolean`	`isForceTCPmodeACKs()`
`boolean`	`isLinkEnabledOnServer()`	Request if link is enabled on the server that you are connected too
`protected boolean`	`isMaintainLastModified()`
`protected boolean`	`isMaintainPermissions()`
`protected boolean`	`isOptimizeBlockSize()`
`protected boolean`	`isProgressiveTransfers()`
`protected boolean`	`isShowConsoleLog()`
`protected boolean`	`isTransferEmptyDirectories()`
`protected boolean`	`isTransferWithTempName()`
`protected boolean`	`isUDPSupported()`	Returns true if connected to a FileCatalyst server that supports UDP.
`protected boolean`	`isUseCongestionControl()`
`protected boolean`	`isUseSSL()`
`protected boolean`	`isVerifyIntegrity()`
`protected void`	`jobPushed(TransferJob job)`	Pushes a TransferJob into the Multi-Client for transfer.
`protected FileListData`	`list()`	Returns meta data for files in the current remote directory.
`protected FileListData`	`list(java.lang.String wildcard)`	Returns meta data for files in the current remote directory.
`protected FileListData`	`list(java.lang.String wildcard, java.lang.String remoteDirectory)`	Returns meta data for files in the remote directory.
`FileListData`	`listNoParse(java.lang.String directory)`
`protected FileListData`	`listRecursiveFTPCompatible(java.lang.String directory)`	This is a ftp compatible listWithInlineParse();
`protected FileListData`	`listWithInlineParse()`	Returns meta data for files in the current remote directory.
`protected FileListData`	`listWithInlineParse(java.lang.String directory)`	Returns meta data for files in the given remote directory.
`protected void`	`login(java.util.function.Supplier<ClientCredentials> creds)`	Login to the server with the specifed credentials.
`protected void`	`mkdir(java.lang.String dir)`	Creates the specified directory on the remote file system.
`protected void`	`modtime(FileListDataItem item)`	This will update the modtime of the file existing on the server to whatever the incoming FileListDataItem is set to
`protected void`	`noop()`
`protected void`	`preProcess(TransferJob job)`	Preprocess the job with all of the preprocess that are currently set
`protected java.lang.String[]`	`prms(java.lang.String filename)`	Return the file permission of the file/directory listed in the argument from the remote server.
`protected MultiClientTransferHook`	`pushJob(TransferJob job)`
`protected MultiClientTransferHook`	`pushJobNoProcessing(TransferJob job)`	Pushes a TransferJob into the Multi-Client for transfer.
`protected java.lang.String`	`pwd()`
`protected java.lang.String`	`quote(java.lang.String command)`	Issue arbitrary FileCatalyst commands to the FileCatalyst server.
`protected java.util.stream.Stream<FileListDataItem>`	`remoteSynchFile(java.util.stream.Stream<FileListDataItem> fileStream)`
`protected void`	`remoteSynchFile(FileListDataItem aFile)`	This is useful for progressive downloads when the updated value of the FileListData is required.
`protected TransferHook`	`remoteUpload(FCClient destServer, java.lang.String sourceFile, java.lang.String destFile)`	This method will initiate an upload from the server to which this FCClient object (Server A) is connected to the server specified by the destServer parameter passed in (Server B).
`protected TransferHook`	`remoteUpload(FCClient destServer, java.util.List<java.lang.String> sourceFiles, java.util.List<java.lang.String> destFiles)`	This method will initiate an upload from the server to which this FCClient object (Server A) is connected to the server specified by the destServer parameter passed in (Server B).
`protected void`	`rename(java.lang.String oldName, java.lang.String newName)`	Renames the specified file to the new name.
`protected void`	`resetAutoDetectInfo()`	Resets all Auto-detect information
`protected void`	`resetSession()`
`protected void`	`rmdir(java.lang.String dir)`	Deletes the specified directory from the remote file system.
`protected void`	`rmdirRecursive(FileListDataItem fileListDataItem)`	Deletes a directory on the server in a recursive manner.
`void`	`runWorkerClient(FileTransferMechanismHandler handler)`
`protected WeblinkResult`	`sendWeblink(java.util.List<java.lang.String> to, java.lang.String from, java.lang.String message, java.util.Set<java.lang.String> files)`	Deprecated.
`protected WeblinkResult`	`sendWeblink(WeblinkDataContainer dataDO)`	Creates a weblink with the parameters provided by the client.
`protected java.lang.String`	`serverVersion()`	Returns the FileCatalyst server version.
`protected void`	`setAutoResume(boolean autoResume)`
`protected void`	`setAutoUnzip(boolean autoUnzip)`
`protected void`	`setBlockSize(int blockSize)`
`protected void`	`setCallbackHandler(FileCatalystClientCallbackHandler callbackHandler)`	Sets the current call back handler when called
`protected void`	`setCancelled()`
`protected void`	`setClientAgentID(java.lang.String clientAgentID)`
`protected void`	`setClientConnectKey(java.lang.String clientConnectKey)`
`protected void`	`setClientCredentials(java.util.function.Supplier<ClientCredentials> creds)`
`protected void`	`setClientIdentifier(int clientIdentifier)`
`protected void`	`setClientName(java.lang.String clientName)`
`protected void`	`setClientString(java.lang.String clientString)`
`protected void`	`setClientSubIdentifier(int clientSubIdentifier)`
`protected void`	`setClientWorkingPath(java.nio.file.Path clientWorkingPath)`
`protected void`	`setCompFileFilter(java.lang.String compFileFilter)`
`protected void`	`setCongCtrlStrategy(int congCtrlStrategy)`
`protected void`	`setCongestionControlAggression(int congestionControlAggression)`
`protected void`	`setCongestionControlEnabled(boolean enabled)`
`protected void`	`setConnectTimeout(int millisec)`
`protected void`	`setDebug(boolean debug)`
`protected void`	`setDeleteAfterTransfer(boolean deleteAfterTransfer)`
`protected void`	`setDowngradeModeOnReConnect(boolean downgradeModeOnReConnect)`
`protected void`	`setExtendedReadTimeout(int millisecs)`
`protected void`	`setFileFilter(FileCatalystFileFilter filter)`
`protected void`	`setFileTransferPriority(int priority)`
`protected void`	`setForceFileOwnershipEnabled(boolean isForceFileOwnershipEnabled)`
`protected void`	`setForceFileOwnershipGroup(java.lang.String forceFileOwnershipGroup)`
`protected void`	`setForceFileOwnershipUser(java.lang.String forceFileOwnershipUser)`
`protected void`	`setForceTCPmodeACKs(boolean forceTCPmodeACKs)`
`protected void`	`setIncomingDataPort(int inDataPort)`
`protected void`	`setIncomingDataPorts(int[] inDataPorts)`
`protected void`	`setIncrementalMode(int incrementalMode)`
`void`	`setIncrementalSizeCheckOnly(boolean incrementalSizeCheckOnly)`
`protected void`	`setLocalWorkingDirectory(java.nio.file.Path localWorkingDirectory)`
`protected void`	`setLogger(unlimited.core.util.common.logs.LogUtils logger)`
`protected java.lang.Throwable`	`setLoggerAttempt(unlimited.core.util.common.logs.LogUtils logger)`
`protected void`	`setLogLocation(java.lang.String logLocation)`
`void`	`setLogPrefix(java.lang.String logPrefix)`	Sets the prefix of the log files to whatever value is supplied
`protected void`	`setMaintainLastModified(boolean maintainLastModified)`
`protected void`	`setMaintainPermissions(boolean maintainPermissions)`
`protected void`	`setMaxRetries(int maxRetries)`
`protected void`	`setMd5RateLimit(int md5RateLimit)`
`protected void`	`setMode(int mode)`
`protected void`	`setNumBlockReaders(int numBlockReaders)`
`protected void`	`setNumBlockWriters(int numBlockWriters)`
`protected void`	`setNumFTPStreams(int numFTPStreams)`
`protected void`	`setNumPacketProcessors(int numPacketProcessors)`
`protected void`	`setNumReceiveSockets(int numReceiveSockets)`
`protected void`	`setNumSenderSockets(int numSenderSockets)`
`protected void`	`setNumSenderThreads(int numThreads)`
`protected void`	`setNumThreads(int numThreads)`
`protected void`	`setNumUDPSockets(int numUDPSockets)`
`protected void`	`setObserver(java.util.Observer observer)`
`protected void`	`setOptimizeBlockSize(boolean optimizeBlockSize)`
`protected void`	`setPacketQueueDepth(int packetQueueDepth)`
`protected void`	`setPacketSize(int packetSize)`
`protected void`	`setPostTaskSentData(PostTaskSentData data)`
`protected void`	`setPostURL(java.lang.String postURL)`
`protected void`	`setProgressiveTimeout(int progressiveTimeout)`
`protected void`	`setProgressiveTimeoutFilter(java.lang.String progressiveTimeoutFilter)`
`protected void`	`setProgressiveTransfers(boolean progressiveTransfers)`
`protected void`	`setReadBufferSizeKB(int bufferSizeKB)`	Sets the read buffer size to the value supplied
`protected void`	`setReadTimeout(int millisecs)`
`protected void`	`setRemotePort(int remotePort)`
`protected void`	`setRemoteServer(java.lang.String remoteServer)`
`protected void`	`setRenameExtension(boolean renameExtension)`
`void`	`setReport(unlimited.fc.reporting.ClientDataReport reporter)`	Sets the report object.
`protected void`	`setServletLocation(java.lang.String servletLocation)`
`protected void`	`setServletLocation(java.lang.String servletLocation, java.lang.String servletSessionID, java.lang.String welcomeMessage)`
`protected void`	`setServletMultiplier(int servletMultiplier)`
`protected void`	`setSessionID(java.lang.String sessionID)`
`protected void`	`setShowConsoleLog(boolean showConsoleLog)`
`protected void`	`setSSLSocketProducer(unlimited.core.util.common.net.ssl.FCSSLSocketProducerImpl socketProducer)`
`protected void`	`setStartRate(int slowStartRate)`
`protected void`	`setTargetRate(int targetRate, BandwidthDistributionMode skipOverrides)`
`protected void`	`setTaskID(java.lang.String taskID)`
`protected void`	`setTransactionID(java.lang.String uniqueID)`
`protected void`	`setTransferEmptyDirectories(boolean transferEmptyDirectories)`
`protected void`	`setTransferMode()`
`protected void`	`setTransferToServerOverride(int serverOverrideBW)`
`protected void`	`setTransferWithTempName(boolean transferWithTempName)`
`protected void`	`setTransferWithTempName(boolean transferWithTempName, int tempMode)`
`protected void`	`setUnitSize(int unitSize)`
`protected void`	`setUseCongestionControl(boolean useCongestionControl)`
`protected void`	`setUserEmailAddress(java.lang.String newEmailAddress)`	Sets The User's Email Address When Called
`protected void`	`setUserFullName(java.lang.String newFullName)`	Set's The User's Name When Called
`void`	`setUserRelativePriority(int priority)`
`protected void`	`setUseSSL(boolean useSSL)`
`protected void`	`setVerifyIntegrity(boolean verifyIntegrity)`
`protected void`	`setVerifyMode(int verifyMode)`
`protected void`	`setWaitRetry(long waitRetry)`
`protected void`	`setWriteBufferSizeKB(int bufferSizeKB)`	Set the write buffer size
`protected void`	`setWriteFileMode(java.lang.String mode)`	Set the write file mode
`protected long`	`size(java.lang.String remoteFile, boolean bypassCache)`	Get the size of the named file from the remote server.
`protected void`	`start()`
`protected void`	`stopSpeedTesting()`	Stops the current speed testing methods that this TransferMechanism may be executing
`protected java.util.stream.Stream<FileListDataItem>`	`streamWithInlineParse(java.lang.String directory)`	Returns streaming meta data for files in the current remote directory.
`protected java.util.stream.Stream<FileListDataItem>`	`streamWithInlineParse(java.lang.String directory, java.util.function.BooleanSupplier isCancelled)`
`protected boolean`	`synchClient(FileTransferMechanism client)`
`protected int`	`testApproximateDownloadSpeed()`	Performs a quick test to determine the approximate download speed to the connected server.
`protected int`	`testApproximateUploadSpeed()`	Performs a quick test to determine the approximate upload speed to the connected server.
`protected int`	`testMaximumDownloadSpeed()`	Performs a series of tests to determine the maximum download speed from the connected server.
`protected int`	`testMaximumUploadSpeed()`	Performs a series of tests to determine the maximum upload speed to the connected server.
`protected void`	`testUDPACKs()`	Tests if UDP ACK mode is possible an configures internal variables.
`protected int`	`testWriteSpeed()`	Perform a write to current directory with recommended values for determining storage rate.
`protected int`	`testWriteSpeed(java.nio.file.Path file, int size, int timeout)`	Perform a write to specified file with specified size and timeout for determining storage rate.
`protected <FileType> void`	`transferJobStream(java.util.stream.Stream<TransferJob.FileTypeJob<FileType>> stream)`
`protected void`	`updateServerOverrides()`
`protected TransferHook`	`upload(java.lang.String localFile)`	Upload the specified file to the current remote working directory.
`protected TransferHook`	`upload(java.nio.file.Path localFile)`	Upload the specified file to the current remote working directory.
`protected TransferHook`	`upload(java.nio.file.Path localFile, java.lang.String remotePath)`	Upload the specified file to the specified remote directory.
`protected TransferHook`	`upload(java.nio.file.Path localFile, java.lang.String remotePath, java.lang.String transferUniqueID)`	Upload the specified file to the specified remote directory and specifies a unique transaction id.
`protected TransferHook`	`upload(java.util.List<java.nio.file.Path> files)`	Uploads all File objects in the Vector provided to the current remote working directory.
`protected TransferHook`	`upload(java.util.List<java.nio.file.Path> files, java.lang.String remotePath)`	Uploads all File objects in the Vector provided to the specified remote directory.
`protected TransferHook`	`upload(java.util.List<java.nio.file.Path> files, java.lang.String remotePath, java.lang.String transferUniqueID)`	Uploads all File objects in the Vector provided to the specified remote directory.
`protected TransferHook`	`uploadAs(java.nio.file.Path localFile, java.lang.String remoteFilename)`	Upload the specified file to the specified remote filename.
`protected TransferHook`	`uploadAs(java.nio.file.Path localFile, java.lang.String remoteFilename, java.lang.String transferUniqueID)`	Upload the specified file to the specified remote filename.
`protected TransferHook`	`uploadList(java.util.List files, java.lang.String remotePath, java.lang.String transferUniqueID, boolean needsRecurse)`	Uploads a list of files to the connected Server.
`protected void`	`uploadRange(java.nio.file.Path localFile, java.lang.String remoteFile, long offset, long length)`	Uploads a range of rate for the given file
`protected void`	`uploadStream(java.util.stream.Stream<java.nio.file.Path> stream)`
`protected boolean`	`willTransferWork()`	Returns whether or not transfers will work under the current settings

Methods inherited from class unlimited.fc.client.api.multiclient.MultiClientState
cleanupClientIfNeeded, completeClientFailure, connected, deleteAll, equals, getInitialState, getNextSessionID, getOldState, getParent, getReport, getTargetRateSlice, handleFailedTransfer, handleSuccessfulTransfer, informTransferFinished, informTransferStart, invalidState, isBadState, isCancelling, isIdle, isIncrementalSizeCheckOnly, isInitialized, isLoggedIn, isTransferComplete, notImplemented, resetBadState, sendEmail, setPostProcessorOverrides, synchClients, synchSpecificTypes, toString, transferComplete, transferStarted

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

- Constructor Detail
  - CreatedState
```
protected CreatedState(MultiClientState oldState)
```
- Method Detail
  - start
```
protected void start()
              throws unlimited.core.util.common.exception.FCException,
                     java.io.IOException
```
    Overrides:
    
    start in class MultiClientState
    
    Throws:
    
    unlimited.core.util.common.exception.FCException
    
    java.io.IOException
  - pushJob
```
protected MultiClientTransferHook pushJob(TransferJob job)
                                   throws unlimited.core.util.common.exception.FCException,
                                          java.io.IOException
```
    Overrides:
    
    pushJob in class MultiClientState
    
    Throws:
    
    unlimited.core.util.common.exception.FCException
    
    java.io.IOException
  - preProcess
```
protected void preProcess(TransferJob job)
                   throws unlimited.core.util.common.exception.FCException,
                          java.io.IOException
```
    Description copied from class: MultiClientState
    
    Preprocess the job with all of the preprocess that are currently set
    
    Overrides:
    
    preProcess in class MultiClientState
    
    Parameters:
    
    job - Job to preprocess
    
    Throws:
    
    unlimited.core.util.common.exception.FCException - if a FileCatalyst protocol error occurs.
    
    java.io.IOException - if an error occurs either connecting to the destination server, or if a transfer I/O error occurs.
  - pushJobNoProcessing
```
protected MultiClientTransferHook pushJobNoProcessing(TransferJob job)
                                               throws unlimited.core.util.common.exception.FCException,
                                                      java.io.IOException
```
    Description copied from class: MultiClientState
    
    Pushes a TransferJob into the Multi-Client for transfer. For this method, the job will not be processed before it is attempted
    
    Overrides:
    
    pushJobNoProcessing in class MultiClientState
    
    Parameters:
    
    job - Job to attempt
    
    Throws:
    
    unlimited.core.util.common.exception.FCException
    
    java.io.IOException
  - jobPushed
```
protected void jobPushed(TransferJob job)
```
    Description copied from class: MultiClientState
    
    Pushes a TransferJob into the Multi-Client for transfer. It will be attempted when it is pulled from the Multi-Client's TransferJobQueue
    
    Overrides:
    
    jobPushed in class MultiClientState
    
    Parameters:
    
    job - Job to attempt
  - setPostTaskSentData
```
protected void setPostTaskSentData(PostTaskSentData data)
```
    Overrides:
    
    setPostTaskSentData in class MultiClientState
  - getHandledBy
```
public void getHandledBy(StateHandler handler)
```
    Description copied from class: MultiClientState
    
    Gets the handled by.
    
    Overrides:
    
    getHandledBy in class MultiClientState
    
    Parameters:
    
    handler - the handler
  - cd
```
protected void cd(java.lang.String path)
           throws unlimited.core.util.common.exception.FCException,
                  java.io.IOException
```
    Description copied from class: MultiClientState
    
    Navigates the manager into the supplied path.
    
    Overrides:
    
    cd in class MultiClientState
    
    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
  - remoteSynchFile
```
protected void remoteSynchFile(FileListDataItem aFile)
                        throws unlimited.core.util.common.exception.FCException
```
    Description copied from class: MultiClientState
    
    This is useful for progressive downloads when the updated value of the FileListData is required.
    
    Overrides:
    
    remoteSynchFile in class MultiClientState
    
    Parameters:
    
    aFile - a FileListDataItem with a valid name that the size and modified time will be updated.
    
    Throws:
    
    unlimited.core.util.common.exception.FCException
  - remoteSynchFile
```
protected java.util.stream.Stream<FileListDataItem> remoteSynchFile(java.util.stream.Stream<FileListDataItem> fileStream)
                                                             throws unlimited.core.util.common.exception.FCException
```
    Overrides:
    
    remoteSynchFile in class MultiClientState
    
    Throws:
    
    unlimited.core.util.common.exception.FCException
  - cdup
```
protected void cdup()
             throws unlimited.core.util.common.exception.FCException,
                    java.io.IOException
```
    Description copied from class: MultiClientState
    
    Move up one directory on the remote directory structure.
    
    Overrides:
    
    cdup in class MultiClientState
    
    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
  - doJob
```
protected void doJob(TransferRunner runner)
              throws unlimited.core.util.common.exception.FCException,
                     java.io.IOException
```
    Overrides:
    
    doJob in class MultiClientState
    
    Throws:
    
    unlimited.core.util.common.exception.FCException
    
    java.io.IOException
  - initialize
```
protected void initialize(boolean generateUserLogs)
```
    Description copied from class: MultiClientState
    
    Initialize Multi-Client object. This will initialize the logs for this session. The log location can be configured with the setLogLocation() method, but must be done before the initialize() method is called.
    
    Overrides:
    
    initialize in class MultiClientState
  - initializeNoUserLogs
```
protected void initializeNoUserLogs()
```
    Description copied from class: MultiClientState
    
    Initializes the TransferMechanism with no user logs
    
    Overrides:
    
    initializeNoUserLogs in class MultiClientState
  - connect
```
protected void connect()
                throws unlimited.core.util.common.exception.FCException,
                       java.io.IOException
```
    Description copied from class: MultiClientState
    
    Connect to the FileCatalyst server. Reporting disabled.
    
    Overrides:
    
    connect in class MultiClientState
    
    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
  - isDowngradeModeOnReConnect
```
protected boolean isDowngradeModeOnReConnect()
```
    Description copied from class: MultiClientState
    
    Returns whether or not the state is set to downgrade mode on reconnect
    
    Overrides:
    
    isDowngradeModeOnReConnect in class MultiClientState
    
    Returns:
  - setDowngradeModeOnReConnect
```
protected void setDowngradeModeOnReConnect(boolean downgradeModeOnReConnect)
```
    Overrides:
    
    setDowngradeModeOnReConnect in class MultiClientState
  - setClientSubIdentifier
```
protected void setClientSubIdentifier(int clientSubIdentifier)
```
    Overrides:
    
    setClientSubIdentifier in class MultiClientState
  - setClientString
```
protected void setClientString(java.lang.String clientString)
```
    Overrides:
    
    setClientString in class MultiClientState
  - getObserver
```
protected java.util.Observer getObserver()
```
    Overrides:
    
    getObserver in class MultiClientState
  - setObserver
```
protected void setObserver(java.util.Observer observer)
```
    Overrides:
    
    setObserver in class MultiClientState
  - getCallbackHandler
```
protected FileCatalystClientCallbackHandler getCallbackHandler()
```
    Description copied from class: MultiClientState
    
    Returns the current callback handler
    
    Overrides:
    
    getCallbackHandler in class MultiClientState
    
    Returns:
  - setCallbackHandler
```
protected void setCallbackHandler(FileCatalystClientCallbackHandler callbackHandler)
```
    Description copied from class: MultiClientState
    
    Sets the current call back handler when called
    
    Overrides:
    
    setCallbackHandler in class MultiClientState
  - synchClient
```
protected boolean synchClient(FileTransferMechanism client)
                       throws unlimited.core.util.common.exception.FCException,
                              java.io.IOException
```
    Overrides:
    
    synchClient in class MultiClientState
    
    Throws:
    
    unlimited.core.util.common.exception.FCException
    
    java.io.IOException
  - getWriteFileMode
```
protected java.lang.String getWriteFileMode()
```
    Description copied from class: MultiClientState
    
    Gets the write file mode when called
    
    Overrides:
    
    getWriteFileMode in class MultiClientState
    
    Returns:
  - setWriteFileMode
```
protected void setWriteFileMode(java.lang.String mode)
```
    Description copied from class: MultiClientState
    
    Set the write file mode
    
    Overrides:
    
    setWriteFileMode in class MultiClientState
  - getWriteBufferSizeKB
```
protected int getWriteBufferSizeKB()
```
    Description copied from class: MultiClientState
    
    Returns the write buffer size
    
    Overrides:
    
    getWriteBufferSizeKB in class MultiClientState
    
    Returns:
  - setWriteBufferSizeKB
```
protected void setWriteBufferSizeKB(int bufferSizeKB)
```
    Description copied from class: MultiClientState
    
    Set the write buffer size
    
    Overrides:
    
    setWriteBufferSizeKB in class MultiClientState
  - getReadBufferSizeKB
```
protected int getReadBufferSizeKB()
```
    Description copied from class: MultiClientState
    
    Returns the read buffer size in KB
    
    Overrides:
    
    getReadBufferSizeKB in class MultiClientState
    
    Returns:
  - setReadBufferSizeKB
```
protected void setReadBufferSizeKB(int bufferSizeKB)
```
    Description copied from class: MultiClientState
    
    Sets the read buffer size to the value supplied
    
    Overrides:
    
    setReadBufferSizeKB in class MultiClientState
  - getNumBlockReaders
```
protected int getNumBlockReaders()
```
    Description copied from class: MultiClientState
    
    Returns the number of block readers
    
    Overrides:
    
    getNumBlockReaders in class MultiClientState
    
    Returns:
  - setNumBlockReaders
```
protected void setNumBlockReaders(int numBlockReaders)
```
    Overrides:
    
    setNumBlockReaders in class MultiClientState
  - getNumBlockWriters
```
protected int getNumBlockWriters()
```
    Overrides:
    
    getNumBlockWriters in class MultiClientState
  - setNumBlockWriters
```
protected void setNumBlockWriters(int numBlockWriters)
```
    Overrides:
    
    setNumBlockWriters in class MultiClientState
  - getNumSenderThreads
```
protected int getNumSenderThreads()
```
    Overrides:
    
    getNumSenderThreads in class MultiClientState
  - setNumSenderThreads
```
protected void setNumSenderThreads(int numThreads)
```
    Overrides:
    
    setNumSenderThreads in class MultiClientState
  - getNumReceiveSockets
```
protected int getNumReceiveSockets()
```
    Overrides:
    
    getNumReceiveSockets in class MultiClientState
  - setNumReceiveSockets
```
protected void setNumReceiveSockets(int numReceiveSockets)
```
    Overrides:
    
    setNumReceiveSockets in class MultiClientState
  - getNumSenderSockets
```
protected int getNumSenderSockets()
```
    Overrides:
    
    getNumSenderSockets in class MultiClientState
  - setNumSenderSockets
```
protected void setNumSenderSockets(int numSenderSockets)
```
    Overrides:
    
    setNumSenderSockets in class MultiClientState
  - getPacketQueueDepth
```
protected int getPacketQueueDepth()
```
    Overrides:
    
    getPacketQueueDepth in class MultiClientState
  - setPacketQueueDepth
```
protected void setPacketQueueDepth(int packetQueueDepth)
```
    Overrides:
    
    setPacketQueueDepth in class MultiClientState
  - getNumPacketProcessors
```
protected int getNumPacketProcessors()
```
    Overrides:
    
    getNumPacketProcessors in class MultiClientState
  - setNumPacketProcessors
```
protected void setNumPacketProcessors(int numPacketProcessors)
```
    Overrides:
    
    setNumPacketProcessors in class MultiClientState
  - isCongestionControlEnabled
```
protected boolean isCongestionControlEnabled()
```
    Overrides:
    
    isCongestionControlEnabled in class MultiClientState
  - getCongestionControlAggression
```
protected int getCongestionControlAggression()
```
    Overrides:
    
    getCongestionControlAggression in class MultiClientState
  - setCongestionControlEnabled
```
protected void setCongestionControlEnabled(boolean enabled)
```
    Overrides:
    
    setCongestionControlEnabled in class MultiClientState
  - getCongCtrlStrategy
```
protected int getCongCtrlStrategy()
```
    Overrides:
    
    getCongCtrlStrategy in class MultiClientState
  - setCongCtrlStrategy
```
protected void setCongCtrlStrategy(int congCtrlStrategy)
```
    Overrides:
    
    setCongCtrlStrategy in class MultiClientState
  - willTransferWork
```
protected boolean willTransferWork()
```
    Description copied from class: MultiClientState
    
    Returns whether or not transfers will work under the current settings
    
    Overrides:
    
    willTransferWork in class MultiClientState
    
    Returns:
  - getConnectivityTestResults
```
protected ConnectivityTestResultContainer getConnectivityTestResults()
```
    Description copied from class: MultiClientState
    
    Returns a data container object that contains information about whether or not uploads, downloads or overall transfers will work
    
    Overrides:
    
    getConnectivityTestResults in class MultiClientState
    
    Returns:
  - resetAutoDetectInfo
```
protected void resetAutoDetectInfo()
```
    Description copied from class: MultiClientState
    
    Resets all Auto-detect information
    
    Overrides:
    
    resetAutoDetectInfo in class MultiClientState
  - autoDetectConectionMode
```
protected void autoDetectConectionMode()
                                throws unlimited.core.util.common.exception.FCException,
                                       java.io.IOException
```
    Overrides:
    
    autoDetectConectionMode in class MultiClientState
    
    Throws:
    
    unlimited.core.util.common.exception.FCException
    
    java.io.IOException
  - autoDetectConectionModeDownload
```
protected void autoDetectConectionModeDownload()
                                        throws unlimited.core.util.common.exception.FCException,
                                               java.io.IOException
```
    Description copied from class: MultiClientState
    
    This method will attempt to detect the optimal connection method based on the provided server information, HTTP servlet location, and ports. It will also detect which mode to use for downloading files.
    
    Overrides:
    
    autoDetectConectionModeDownload in class MultiClientState
    
    Throws:
    
    unlimited.core.util.common.exception.FCException
    
    java.io.IOException
  - autoDetectConectionModeUpload
```
protected void autoDetectConectionModeUpload()
                                      throws unlimited.core.util.common.exception.FCException,
                                             java.io.IOException
```
    Description copied from class: MultiClientState
    
    This method will attempt to detect the optimal connection method based on the provided server information, HTTP servlet location, and ports. It will also detect which mode to use for uploading files.
    
    Overrides:
    
    autoDetectConectionModeUpload in class MultiClientState
    
    Throws:
    
    unlimited.core.util.common.exception.FCException
    
    java.io.IOException
  - autoDetectConectionModeUploadAndDownload
```
protected void autoDetectConectionModeUploadAndDownload()
                                                 throws unlimited.core.util.common.exception.FCException,
                                                        java.io.IOException
```
    Description copied from class: MultiClientState
    
    This method will attempt to detect the optimal connection method based on the provided server information, HTTP servlet location, and ports. It will also detect which mode to use for uploading AND downloading files. If UDP fails for EITHER upload OR download, the mode will be reverted to FTP or HTTP
    
    Overrides:
    
    autoDetectConectionModeUploadAndDownload in class MultiClientState
    
    Throws:
    
    unlimited.core.util.common.exception.FCException
    
    java.io.IOException
  - autoDetectConectionModeDownload
```
protected void autoDetectConectionModeDownload(boolean testUDP,
                                               boolean portFallback)
                                        throws unlimited.core.util.common.exception.FCException,
                                               java.io.IOException
```
    Description copied from class: MultiClientState
    
    This method will attempt to detect the optimal connection method based on the provided server information, HTTP servlet location, and ports. It will also detect which mode to use for downloading files.
    
    Overrides:
    
    autoDetectConectionModeDownload in class MultiClientState
    
    Parameters:
    
    testUDP - true/false whether or not UDP test should be performed
    
    portFallback - true/false whether TCP data connection test should fallback to PORT if PASV fails.
    
    Throws:
    
    unlimited.core.util.common.exception.FCException
    
    java.io.IOException
  - autoDetectConectionModeUpload
```
protected void autoDetectConectionModeUpload(boolean testUDP,
                                             boolean portFallback)
                                      throws unlimited.core.util.common.exception.FCException,
                                             java.io.IOException
```
    Description copied from class: MultiClientState
    
    This method will attempt to detect the optimal connection method based on the provided server information, HTTP servlet location, and ports. It will also detect which mode to use for uploading files.
    
    Overrides:
    
    autoDetectConectionModeUpload in class MultiClientState
    
    Parameters:
    
    testUDP - true/false whether or not UDP test should be performed
    
    portFallback - true/false whether TCP data connection test should fallback to PORT if PASV fails.
    
    Throws:
    
    unlimited.core.util.common.exception.FCException
    
    java.io.IOException
  - autoDetectConectionModeUploadAndDownload
```
protected void autoDetectConectionModeUploadAndDownload(boolean portFallback)
                                                 throws unlimited.core.util.common.exception.FCException,
                                                        java.io.IOException
```
    Description copied from class: MultiClientState
    
    This method will attempt to detect the optimal connection method based on the provided server information, HTTP servlet location, and ports. It will also detect which mode to use for uploading AND downloading files. If UDP fails for EITHER upload OR download, the mode will be reverted to FTP or HTTP
    
    Overrides:
    
    autoDetectConectionModeUploadAndDownload in class MultiClientState
    
    Parameters:
    
    portFallback - true/false whether TCP data connection test should fallback to PORT if PASV fails.
    
    Throws:
    
    unlimited.core.util.common.exception.FCException
    
    java.io.IOException
  - login
```
protected void login(java.util.function.Supplier<ClientCredentials> creds)
              throws unlimited.core.util.common.exception.FCException,
                     java.io.IOException
```
    Description copied from class: MultiClientState
    
    Login to the server with the specifed credentials.
    
    Overrides:
    
    login in class MultiClientState
    
    Parameters:
    
    creds - The Credentials with which to authenticate
    
    Throws:
    
    unlimited.core.util.common.exception.FCException - If authentication fails
    
    java.io.IOException - If a timeout, or other I/O error occurs
  - disconnect
```
protected void disconnect()
                   throws unlimited.core.util.common.exception.FCException,
                          java.io.IOException
```
    Description copied from class: MultiClientState
    
    Disconnect from the server.
    
    Overrides:
    
    disconnect in class MultiClientState
    
    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
  - finish
```
protected void finish()
```
    Description copied from class: MultiClientState
    
    Cleans up memory allocated by the native libraries component of FileCatalyst. This should be called when all transfers are completed and the FCClient object is no longer needed.
    
    Overrides:
    
    finish in class MultiClientState
  - exists
```
protected boolean exists(java.lang.String remoteFile)
                  throws unlimited.core.util.common.exception.FCException,
                         java.io.IOException
```
    Description copied from class: MultiClientState
    
    Test if the remote file, denoted by the given remote path, exists on the server and returns true if it exists, false otherwise.
    
    Overrides:
    
    exists in class MultiClientState
    
    Parameters:
    
    remoteFile - String The path to the remote file
    
    Returns:
    
    boolean True if the file exists, false otherwise
    
    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
  - exists
```
protected unlimited.core.util.common.AutoClose<unlimited.core.util.common.stream.PairStream<java.lang.String,java.lang.Boolean>> exists(java.util.stream.Stream<java.lang.String> remoteFile)
                                                                                                                                       throws unlimited.core.util.common.exception.FCException,
                                                                                                                                              java.io.IOException
```
    Description copied from class: MultiClientState
    
    Test if the remote file, denoted by the given remote path, exists on the server and returns true if it exists, false otherwise.
    
    Overrides:
    
    exists in class MultiClientState
    
    Parameters:
    
    remoteFile - String The path to the remote file
    
    Returns:
    
    boolean True if the file exists, false otherwise
    
    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
  - size
```
protected long size(java.lang.String remoteFile,
                    boolean bypassCache)
             throws unlimited.core.util.common.exception.FCException,
                    java.io.IOException
```
    Description copied from class: MultiClientState
    
    Get the size of the named file from the remote server.
    
    Overrides:
    
    size in class MultiClientState
    
    Returns:
    
    the size of the file
    
    Throws:
    
    unlimited.core.util.common.exception.FCException - if a FileCatalyst protocol error occurs.
    
    java.io.IOException - if an error occurs either connecting to the destination server, or if a transfer I/O error occurs.
  - download
```
protected TransferHook download(java.lang.String remoteFile)
                         throws java.io.IOException,
                                unlimited.core.util.common.exception.FCException
```
    Description copied from class: MultiClientState
    
    Download a the specified file to the current local working directory.
    
    Overrides:
    
    download in class MultiClientState
    
    Parameters:
    
    remoteFile - The remote file to be downloaded. Can be a relative or absolute path to the file.
    
    Returns:
    
    A handler object that can be monitored for progress and status information.
    
    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
  - download
```
protected TransferHook download(java.lang.String remoteFile,
                                java.lang.String localPath)
                         throws unlimited.core.util.common.exception.FCException,
                                java.io.IOException
```
    Description copied from class: MultiClientState
    
    Download the specified file to the specified local path.
    
    Overrides:
    
    download in class MultiClientState
    
    Parameters:
    
    remoteFile - The remote file to be downloaded. Can be a relative or absolute path to the file.
    
    localPath - The local path to which the file will be stored
    
    Returns:
    
    A handler object that can be monitored for progress and status information.
    
    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
  - download
```
protected TransferHook download(java.util.List<java.lang.String> files)
                         throws java.io.IOException,
                                unlimited.core.util.common.exception.FCException
```
    Description copied from class: MultiClientState
    
    Downloads the files as specified by the paths (in String format) contained in the specified vector to the current working directory.
    
    Overrides:
    
    download in class MultiClientState
    
    Parameters:
    
    files - A Vector containing paths (as String) of files to be downloaded
    
    Returns:
    
    A handler object that can be monitored for progress and status information.
    
    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
  - download
```
protected TransferHook download(FileListData files)
                         throws java.io.IOException,
                                unlimited.core.util.common.exception.FCException
```
    Description copied from class: MultiClientState
    
    Downloads the files specified in the FileListData object to the current local working directory.
    
    Overrides:
    
    download in class MultiClientState
    
    Parameters:
    
    files - List of files to be downloaded
    
    Returns:
    
    A handler object that can be monitored for progress and status information.
    
    Throws:
    
    java.io.IOException - If a timeout, or other IO error occurs
    
    unlimited.core.util.common.exception.FCException - If an error in the FC protocol occurs
  - download
```
protected TransferHook download(FileListData files,
                                java.lang.String localPath,
                                java.lang.String transferUniqueID,
                                boolean needsRecurse)
                         throws java.io.IOException,
                                unlimited.core.util.common.exception.FCException
```
    Description copied from class: MultiClientState
    
    Downloads the files specified in the FileListData object to the specified path.
    
    Overrides:
    
    download in class MultiClientState
    
    Parameters:
    
    files - FileListData
    
    localPath - String
    
    transferUniqueID - Assigns a unique transaction ID for the duration of this transfer. Overrides global setUniqueID() variable.
    
    needsRecurse - flag to recurse in any directories passed into the client object for transfer
    
    Returns:
    
    A handler object that can be monitored for progress and status information.
    
    Throws:
    
    java.io.IOException - If a timeout, or other IO error occurs
    
    unlimited.core.util.common.exception.FCException - If an error in the FC protocol occurs
  - download
```
protected TransferHook download(java.util.List<java.lang.String> files,
                                java.lang.String localPath)
                         throws java.io.IOException,
                                unlimited.core.util.common.exception.FCException
```
    Description copied from class: MultiClientState
    
    Download the specified file to the specified local file.
    
    Overrides:
    
    download in class MultiClientState
    
    Returns:
    
    A handler object that can be monitored for progress and status information.
    
    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
  - download
```
protected TransferHook download(java.util.List<java.lang.String> files,
                                java.lang.String localPath,
                                java.lang.String transferUniqueID,
                                boolean needsRecurse)
                         throws java.io.IOException,
                                unlimited.core.util.common.exception.FCException
```
    Description copied from class: MultiClientState
    
    Downloads the files as specified by the paths (in String format) contained in the specified vector to the current working directory.
    
    Overrides:
    
    download in class MultiClientState
    
    Parameters:
    
    files - A Vector containing paths (as String) of files to be downloaded
    
    localPath - The local path to which the files will be stored
    
    transferUniqueID - Assigns a unique transaction ID for the duration of this transfer. Overrides global setUniqueID() variable.
    
    needsRecurse - flag to recurse in any directories passed into the client object for transfer
    
    Returns:
    
    A handler object that can be monitored for progress and status information.
    
    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
  - uploadStream
```
protected void uploadStream(java.util.stream.Stream<java.nio.file.Path> stream)
                     throws unlimited.core.util.common.exception.FCException,
                            java.io.IOException
```
    Overrides:
    
    uploadStream in class MultiClientState
    
    Throws:
    
    unlimited.core.util.common.exception.FCException
    
    java.io.IOException
  - downloadStream
```
protected void downloadStream(java.util.stream.Stream<FileListDataItem> stream)
                       throws unlimited.core.util.common.exception.FCException,
                              java.io.IOException
```
    Overrides:
    
    downloadStream in class MultiClientState
    
    Throws:
    
    unlimited.core.util.common.exception.FCException
    
    java.io.IOException
  - transferJobStream
```
protected <FileType> void transferJobStream(java.util.stream.Stream<TransferJob.FileTypeJob<FileType>> stream)
                                     throws unlimited.core.util.common.exception.FCException,
                                            java.io.IOException
```
    Overrides:
    
    transferJobStream in class MultiClientState
    
    Throws:
    
    unlimited.core.util.common.exception.FCException
    
    java.io.IOException
  - uploadList
```
protected TransferHook uploadList(java.util.List files,
                                  java.lang.String remotePath,
                                  java.lang.String transferUniqueID,
                                  boolean needsRecurse)
                           throws java.io.IOException,
                                  unlimited.core.util.common.exception.FCException
```
    Description copied from class: MultiClientState
    
    Uploads a list of files to the connected Server.
    
    Overrides:
    
    uploadList in class MultiClientState
    
    Parameters:
    
    files - List of Paths to be uploaded
    
    remotePath - Remote path of where the files should land on the Server
    
    transferUniqueID - Unique ID that you wish to have for the transfer
    
    needsRecurse - Whether or not the code should recurse into the file to transfer it (defaults to true)
    
    Returns:
    
    Throws:
    
    unlimited.core.util.common.exception.FCException - if a FileCatalyst protocol error occurs.
    
    java.io.IOException - if an error occurs either connecting to the destination server, or if a transfer I/O error occurs.
  - upload
```
protected TransferHook upload(java.lang.String localFile)
                       throws java.io.IOException,
                              unlimited.core.util.common.exception.FCException
```
    Description copied from class: MultiClientState
    
    Upload the specified file to the current remote working directory.
    
    Overrides:
    
    upload in class MultiClientState
    
    Parameters:
    
    localFile - The local file to be uploaded, can be a directory as well
    
    Returns:
    
    A handler object that can be monitored for progress and status information.
    
    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
  - upload
```
protected TransferHook upload(java.nio.file.Path localFile)
                       throws java.io.IOException,
                              unlimited.core.util.common.exception.FCException
```
    Description copied from class: MultiClientState
    
    Upload the specified file to the current remote working directory.
    
    Overrides:
    
    upload in class MultiClientState
    
    Parameters:
    
    localFile - The local file to be uploaded, can be a directory as well
    
    Returns:
    
    A handler object that can be monitored for progress and status information.
    
    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
  - upload
```
protected TransferHook upload(java.nio.file.Path localFile,
                              java.lang.String remotePath)
                       throws unlimited.core.util.common.exception.FCException,
                              java.io.IOException
```
    Description copied from class: MultiClientState
    
    Upload the specified file to the specified remote directory.
    
    Overrides:
    
    upload in class MultiClientState
    
    Parameters:
    
    localFile - The local file to be uploaded, can be a directory as well
    
    remotePath - The remote path where files should be uploaded
    
    Returns:
    
    A handler object that can be monitored for progress and status information.
    
    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
  - upload
```
protected TransferHook upload(java.nio.file.Path localFile,
                              java.lang.String remotePath,
                              java.lang.String transferUniqueID)
                       throws unlimited.core.util.common.exception.FCException,
                              java.io.IOException
```
    Description copied from class: MultiClientState
    
    Upload the specified file to the specified remote directory and specifies a unique transaction id.
    
    Overrides:
    
    upload in class MultiClientState
    
    Parameters:
    
    localFile - The local file to be uploaded, can be a directory as well
    
    remotePath - The remote path where files should be uploaded
    
    transferUniqueID - Assigns a unique transaction ID for the duration of this transfer. Overrides global setUniqueID() variable.
    
    Returns:
    
    A handler object that can be monitored for progress and status information.
    
    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
  - uploadAs
```
protected TransferHook uploadAs(java.nio.file.Path localFile,
                                java.lang.String remoteFilename)
                         throws unlimited.core.util.common.exception.FCException,
                                java.io.IOException
```
    Description copied from class: MultiClientState
    
    Upload the specified file to the specified remote filename. The remoteFilename filename parameter can be a plain filename, in which case it will be uploaded to the current remote directory. It can also be a relative or absolute path on the remote server. i.e. /path/to/stor/file.zip
    
    Overrides:
    
    uploadAs in class MultiClientState
    
    Parameters:
    
    localFile - The local file to be uploaded, can be a directory as well
    
    remoteFilename - The filename to which this file will be stored
    
    Returns:
    
    A handler object that can be monitored for progress and status information.
    
    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
  - uploadAs
```
protected TransferHook uploadAs(java.nio.file.Path localFile,
                                java.lang.String remoteFilename,
                                java.lang.String transferUniqueID)
                         throws unlimited.core.util.common.exception.FCException,
                                java.io.IOException
```
    Description copied from class: MultiClientState
    
    Upload the specified file to the specified remote filename. The remoteFilename filename parameter can be a plain filename, in which case it will be uploaded to the current remote directory. It can also be a relative or absolute path on the remote server. i.e. /path/to/stor/file.zip
    
    Overrides:
    
    uploadAs in class MultiClientState
    
    Parameters:
    
    localFile - The local file to be uploaded, can be a directory as well
    
    remoteFilename - The filename to which this file will be stored
    
    transferUniqueID - Assigns a unique transaction ID for the duration of this transfer. Overrides global setUniqueID() variable.
    
    Returns:
    
    A handler object that can be monitored for progress and status information.
    
    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
  - upload
```
protected TransferHook upload(java.util.List<java.nio.file.Path> files)
                       throws java.io.IOException,
                              unlimited.core.util.common.exception.FCException
```
    Description copied from class: MultiClientState
    
    Uploads all File objects in the Vector provided to the current remote working directory.
    
    Overrides:
    
    upload in class MultiClientState
    
    Parameters:
    
    files - A Vector of File objects to be uploaded
    
    Returns:
    
    A handler object that can be monitored for progress and status information.
    
    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
  - upload
```
protected TransferHook upload(java.util.List<java.nio.file.Path> files,
                              java.lang.String remotePath)
                       throws java.io.IOException,
                              unlimited.core.util.common.exception.FCException
```
    Description copied from class: MultiClientState
    
    Uploads all File objects in the Vector provided to the specified remote directory.
    
    Overrides:
    
    upload in class MultiClientState
    
    Parameters:
    
    files - A Vector of File objects to be uploaded
    
    remotePath - The remote path where files should be uploaded
    
    Returns:
    
    A handler object that can be monitored for progress and status information.
    
    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
  - upload
```
protected TransferHook upload(java.util.List<java.nio.file.Path> files,
                              java.lang.String remotePath,
                              java.lang.String transferUniqueID)
                       throws java.io.IOException,
                              unlimited.core.util.common.exception.FCException
```
    Description copied from class: MultiClientState
    
    Uploads all File objects in the Vector provided to the specified remote directory.
    
    Overrides:
    
    upload in class MultiClientState
    
    Parameters:
    
    files - A Vector of File objects to be uploaded
    
    remotePath - The remote path where files should be uploaded
    
    transferUniqueID - Assigns a unique transaction ID for the duration of this transfer. Overrides global setUniqueID() variable.
    
    Returns:
    
    A handler object that can be monitored for progress and status information.
    
    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
  - addCustomLogHandler
```
protected void addCustomLogHandler(java.util.logging.Handler handler)
```
    Description copied from class: MultiClientState
    
    Adds a custom log handler to which API logs will be published. This should be called prior to calling initialize() to have an affect.
    
    Overrides:
    
    addCustomLogHandler in class MultiClientState
    
    Parameters:
    
    handler - The log handler to add.
  - quote
```
protected java.lang.String quote(java.lang.String command)
                          throws java.io.IOException,
                                 unlimited.core.util.common.exception.FCException
```
    Description copied from class: MultiClientState
    
    Issue arbitrary FileCatalyst commands to the FileCatalyst server. example: MD5 commands can be called from here
    
    Overrides:
    
    quote in class MultiClientState
    
    Parameters:
    
    command - command to be sent to server
    
    Returns:
    
    sends back the server response to the command.
    
    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
  - noop
```
protected void noop()
             throws java.io.IOException,
                    unlimited.core.util.common.exception.FCException
```
    Overrides:
    
    noop in class MultiClientState
    
    Throws:
    
    java.io.IOException
    
    unlimited.core.util.common.exception.FCException
  - pwd
```
protected java.lang.String pwd()
                        throws unlimited.core.util.common.exception.FCException,
                               java.io.IOException
```
    Overrides:
    
    pwd in class MultiClientState
    
    Throws:
    
    unlimited.core.util.common.exception.FCException
    
    java.io.IOException
  - fsEvents
```
protected void fsEvents()
                 throws unlimited.core.util.common.exception.FCException,
                        java.io.IOException
```
    Description copied from class: MultiClientState
    
    Prints out a list of the current file system events that are set on the server. Uses a default timeout value of 1000.
    
    Overrides:
    
    fsEvents in class MultiClientState
    
    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
  - delete
```
protected void delete(java.lang.String file)
               throws unlimited.core.util.common.exception.FCException,
                      java.io.IOException
```
    Description copied from class: MultiClientState
    
    Deletes the specified file from the remote file system.
    
    Overrides:
    
    delete in class MultiClientState
    
    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
  - deleteAll
```
protected void deleteAll(java.util.List files)
                  throws unlimited.core.util.common.exception.FCException,
                         java.io.IOException
```
    Description copied from class: MultiClientState
    
    Delete all specified files in a single efficient command. Files and directories may be passed, and are deleted recursively.
    
    Overrides:
    
    deleteAll in class MultiClientState
    
    Parameters:
    
    files - List of files to delete
    
    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
  - deleteAll
```
protected void deleteAll(FileListData files)
                  throws java.io.IOException,
                         unlimited.core.util.common.exception.FCException
```
    Description copied from class: MultiClientState
    
    Delete all specified files in a single efficient command. Files and directories may be passed, and are deleted recursively.
    
    Overrides:
    
    deleteAll in class MultiClientState
    
    Parameters:
    
    files - List of files to delete
    
    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
  - deleteAll
```
protected void deleteAll(FileListDataItem[] files)
                  throws java.io.IOException,
                         unlimited.core.util.common.exception.FCException
```
    Description copied from class: MultiClientState
    
    Delete all specified files in a single efficient command. Files and directories may be passed, and are deleted recursively.
    
    Overrides:
    
    deleteAll in class MultiClientState
    
    Parameters:
    
    files - List of files to delete
    
    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
  - flushCaches
```
protected void flushCaches()
```
    Description copied from class: MultiClientState
    
    Deletes underlying caches for file sizes and date/time stamps
    
    Overrides:
    
    flushCaches in class MultiClientState
  - mkdir
```
protected void mkdir(java.lang.String dir)
              throws unlimited.core.util.common.exception.FCException,
                     java.io.IOException
```
    Description copied from class: MultiClientState
    
    Creates the specified directory on the remote file system.
    
    Overrides:
    
    mkdir in class MultiClientState
    
    Parameters:
    
    dir - The directory to be created
    
    Throws:
    
    unlimited.core.util.common.exception.FCException - If an error in the FC protocol occurs, i.e. permissions denied
    
    java.io.IOException - If a timeout, or other IO error occurs
  - rmdir
```
protected void rmdir(java.lang.String dir)
              throws unlimited.core.util.common.exception.FCException,
                     java.io.IOException
```
    Description copied from class: MultiClientState
    
    Deletes the specified directory from the remote file system.
    
    Overrides:
    
    rmdir in class MultiClientState
    
    Parameters:
    
    dir - The directory 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
  - rmdirRecursive
```
protected void rmdirRecursive(FileListDataItem fileListDataItem)
                       throws java.lang.Exception
```
    Description copied from class: MultiClientState
    
    Deletes a directory on the server in a recursive manner.
    
    Overrides:
    
    rmdirRecursive in class MultiClientState
    
    Parameters:
    
    fileListDataItem - Directory that should be deleted
    
    Throws:
    
    java.lang.Exception - IOException or FCException depending on the issue encountered
  - rename
```
protected void rename(java.lang.String oldName,
                      java.lang.String newName)
               throws unlimited.core.util.common.exception.FCException,
                      java.io.IOException
```
    Description copied from class: MultiClientState
    
    Renames the specified file to the new name.
    
    Overrides:
    
    rename in class MultiClientState
    
    Parameters:
    
    oldName - File to be renamed
    
    newName - New name for the file
    
    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
```
protected FileListData list()
                     throws unlimited.core.util.common.exception.FCException,
                            java.io.IOException
```
    Description copied from class: MultiClientState
    
    Returns meta data for files in the current remote directory.
    
    Overrides:
    
    list in class MultiClientState
    
    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
  - list
```
protected FileListData list(java.lang.String wildcard,
                            java.lang.String remoteDirectory)
                     throws unlimited.core.util.common.exception.FCException,
                            java.io.IOException
```
    Description copied from class: MultiClientState
    
    Returns meta data for files in the remote directory.
    
    Overrides:
    
    list in class MultiClientState
    
    Parameters:
    
    wildcard - only return items that match this pattern
    
    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
  - listWithInlineParse
```
protected FileListData listWithInlineParse()
                                    throws unlimited.core.util.common.exception.FCException,
                                           java.io.IOException
```
    Description copied from class: MultiClientState
    
    Returns meta data for files in the current remote directory.
    
    Overrides:
    
    listWithInlineParse in class MultiClientState
    
    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
  - listWithInlineParse
```
protected FileListData listWithInlineParse(java.lang.String directory)
                                    throws unlimited.core.util.common.exception.FCException,
                                           java.io.IOException
```
    Description copied from class: MultiClientState
    
    Returns meta data for files in the given remote directory.
    
    Overrides:
    
    listWithInlineParse in class MultiClientState
    
    Parameters:
    
    directory - to get data from
    
    Returns:
    
    meta data for files in the given 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
  - streamWithInlineParse
```
protected java.util.stream.Stream<FileListDataItem> streamWithInlineParse(java.lang.String directory)
                                                                   throws unlimited.core.util.common.exception.FCException,
                                                                          java.io.IOException
```
    Description copied from class: MultiClientState
    
    Returns streaming meta data for files in the current remote directory.
    
    Overrides:
    
    streamWithInlineParse in class MultiClientState
    
    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
  - streamWithInlineParse
```
protected java.util.stream.Stream<FileListDataItem> streamWithInlineParse(java.lang.String directory,
                                                                          java.util.function.BooleanSupplier isCancelled)
                                                                   throws unlimited.core.util.common.exception.FCException,
                                                                          java.io.IOException
```
    Overrides:
    
    streamWithInlineParse in class MultiClientState
    
    Throws:
    
    unlimited.core.util.common.exception.FCException
    
    java.io.IOException
  - listNoParse
```
public FileListData listNoParse(java.lang.String directory)
                         throws unlimited.core.util.common.exception.FCException,
                                java.io.IOException
```
    Overrides:
    
    listNoParse in class MultiClientState
    
    Throws:
    
    unlimited.core.util.common.exception.FCException
    
    java.io.IOException
  - list
```
protected FileListData list(java.lang.String wildcard)
                     throws unlimited.core.util.common.exception.FCException,
                            java.io.IOException
```
    Description copied from class: MultiClientState
    
    Returns meta data for files in the current remote directory.
    
    Overrides:
    
    list in class MultiClientState
    
    Parameters:
    
    wildcard - only return items that match this pattern
    
    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
  - listRecursiveFTPCompatible
```
protected FileListData listRecursiveFTPCompatible(java.lang.String directory)
                                           throws unlimited.core.util.common.exception.FCException,
                                                  java.io.IOException
```
    Description copied from class: MultiClientState
    
    This is a ftp compatible listWithInlineParse();
    
    Overrides:
    
    listRecursiveFTPCompatible in class MultiClientState
    
    Throws:
    
    unlimited.core.util.common.exception.FCException
    
    java.io.IOException
  - getRemoteServer
```
protected java.lang.String getRemoteServer()
```
    Overrides:
    
    getRemoteServer in class MultiClientState
  - setRemoteServer
```
protected void setRemoteServer(java.lang.String remoteServer)
```
    Overrides:
    
    setRemoteServer in class MultiClientState
  - getRemotePort
```
protected int getRemotePort()
```
    Overrides:
    
    getRemotePort in class MultiClientState
  - setRemotePort
```
protected void setRemotePort(int remotePort)
```
    Overrides:
    
    setRemotePort in class MultiClientState
  - getMode
```
protected int getMode()
```
    Overrides:
    
    getMode in class MultiClientState
  - setMode
```
protected void setMode(int mode)
```
    Overrides:
    
    setMode in class MultiClientState
  - setTargetRate
```
protected void setTargetRate(int targetRate,
                             BandwidthDistributionMode skipOverrides)
```
    Overrides:
    
    setTargetRate in class MultiClientState
  - setTransferToServerOverride
```
protected void setTransferToServerOverride(int serverOverrideBW)
```
    Overrides:
    
    setTransferToServerOverride in class MultiClientState
  - updateServerOverrides
```
protected void updateServerOverrides()
```
    Overrides:
    
    updateServerOverrides in class MultiClientState
  - getBlockSize
```
protected int getBlockSize()
```
    Overrides:
    
    getBlockSize in class MultiClientState
  - setBlockSize
```
protected void setBlockSize(int blockSize)
```
    Overrides:
    
    setBlockSize in class MultiClientState
  - getPacketSize
```
protected int getPacketSize()
```
    Overrides:
    
    getPacketSize in class MultiClientState
  - setPacketSize
```
protected void setPacketSize(int packetSize)
```
    Overrides:
    
    setPacketSize in class MultiClientState
  - setTransactionID
```
protected void setTransactionID(java.lang.String uniqueID)
```
    Overrides:
    
    setTransactionID in class MultiClientState
  - isAutoResume
```
protected boolean isAutoResume()
```
    Overrides:
    
    isAutoResume in class MultiClientState
  - setAutoResume
```
protected void setAutoResume(boolean autoResume)
```
    Overrides:
    
    setAutoResume in class MultiClientState
  - isVerifyIntegrity
```
protected boolean isVerifyIntegrity()
```
    Overrides:
    
    isVerifyIntegrity in class MultiClientState
  - setVerifyIntegrity
```
protected void setVerifyIntegrity(boolean verifyIntegrity)
```
    Overrides:
    
    setVerifyIntegrity in class MultiClientState
  - isMaintainPermissions
```
protected boolean isMaintainPermissions()
```
    Overrides:
    
    isMaintainPermissions in class MultiClientState
  - setMaintainPermissions
```
protected void setMaintainPermissions(boolean maintainPermissions)
```
    Overrides:
    
    setMaintainPermissions in class MultiClientState
  - isMaintainLastModified
```
protected boolean isMaintainLastModified()
```
    Overrides:
    
    isMaintainLastModified in class MultiClientState
  - setMaintainLastModified
```
protected void setMaintainLastModified(boolean maintainLastModified)
```
    Overrides:
    
    setMaintainLastModified in class MultiClientState
  - isOptimizeBlockSize
```
protected boolean isOptimizeBlockSize()
```
    Overrides:
    
    isOptimizeBlockSize in class MultiClientState
  - setOptimizeBlockSize
```
protected void setOptimizeBlockSize(boolean optimizeBlockSize)
```
    Overrides:
    
    setOptimizeBlockSize in class MultiClientState
  - getClientCredentials
```
protected java.util.function.Supplier<ClientCredentials> getClientCredentials()
```
    Overrides:
    
    getClientCredentials in class MultiClientState
  - setClientCredentials
```
protected void setClientCredentials(java.util.function.Supplier<ClientCredentials> creds)
```
    Overrides:
    
    setClientCredentials in class MultiClientState
  - isUseSSL
```
protected boolean isUseSSL()
```
    Overrides:
    
    isUseSSL in class MultiClientState
  - setUseSSL
```
protected void setUseSSL(boolean useSSL)
```
    Overrides:
    
    setUseSSL in class MultiClientState
  - setSSLSocketProducer
```
protected void setSSLSocketProducer(unlimited.core.util.common.net.ssl.FCSSLSocketProducerImpl socketProducer)
```
    Overrides:
    
    setSSLSocketProducer in class MultiClientState
  - getLogLocation
```
protected java.lang.String getLogLocation()
```
    Overrides:
    
    getLogLocation in class MultiClientState
  - setLogLocation
```
protected void setLogLocation(java.lang.String logLocation)
```
    Overrides:
    
    setLogLocation in class MultiClientState
  - setLogPrefix
```
public void setLogPrefix(java.lang.String logPrefix)
```
    Description copied from class: MultiClientState
    
    Sets the prefix of the log files to whatever value is supplied
    
    Overrides:
    
    setLogPrefix in class MultiClientState
    
    Parameters:
    
    logPrefix - New prefix to apply
  - getLogger
```
protected unlimited.core.util.common.logs.LogUtils getLogger()
```
    Overrides:
    
    getLogger in class MultiClientState
  - setLogger
```
protected void setLogger(unlimited.core.util.common.logs.LogUtils logger)
```
    Overrides:
    
    setLogger in class MultiClientState
  - setLoggerAttempt
```
protected java.lang.Throwable setLoggerAttempt(unlimited.core.util.common.logs.LogUtils logger)
```
  - getStartRate
```
protected int getStartRate()
```
    Overrides:
    
    getStartRate in class MultiClientState
  - setStartRate
```
protected void setStartRate(int slowStartRate)
```
    Overrides:
    
    setStartRate in class MultiClientState
  - getConnectTimeout
```
protected int getConnectTimeout()
```
    Overrides:
    
    getConnectTimeout in class MultiClientState
  - setConnectTimeout
```
protected void setConnectTimeout(int millisec)
```
    Overrides:
    
    setConnectTimeout in class MultiClientState
  - isShowConsoleLog
```
protected boolean isShowConsoleLog()
```
    Overrides:
    
    isShowConsoleLog in class MultiClientState
  - setShowConsoleLog
```
protected void setShowConsoleLog(boolean showConsoleLog)
```
    Overrides:
    
    setShowConsoleLog in class MultiClientState
  - isDebug
```
protected boolean isDebug()
```
    Overrides:
    
    isDebug in class MultiClientState
  - setDebug
```
protected void setDebug(boolean debug)
```
    Overrides:
    
    setDebug in class MultiClientState
  - getNumFTPStreams
```
protected int getNumFTPStreams()
```
    Overrides:
    
    getNumFTPStreams in class MultiClientState
  - getIncrementalMode
```
protected int getIncrementalMode()
```
    Overrides:
    
    getIncrementalMode in class MultiClientState
  - isTransferWithTempName
```
protected boolean isTransferWithTempName()
```
    Overrides:
    
    isTransferWithTempName in class MultiClientState
  - getReadTimeout
```
protected int getReadTimeout()
```
    Overrides:
    
    getReadTimeout in class MultiClientState
  - getExtendedReadTimeout
```
protected int getExtendedReadTimeout()
```
    Overrides:
    
    getExtendedReadTimeout in class MultiClientState
  - getVerifyMode
```
protected int getVerifyMode()
```
    Overrides:
    
    getVerifyMode in class MultiClientState
  - getServletLocation
```
protected java.lang.String getServletLocation()
```
    Overrides:
    
    getServletLocation in class MultiClientState
  - getLocalWorkingDirectory
```
protected java.lang.String getLocalWorkingDirectory()
```
    Overrides:
    
    getLocalWorkingDirectory in class MultiClientState
  - isDeleteAfterTransfer
```
protected boolean isDeleteAfterTransfer()
```
    Overrides:
    
    isDeleteAfterTransfer in class MultiClientState
  - isProgressiveTransfers
```
protected boolean isProgressiveTransfers()
```
    Overrides:
    
    isProgressiveTransfers in class MultiClientState
  - getProgressiveTimeout
```
protected int getProgressiveTimeout()
```
    Overrides:
    
    getProgressiveTimeout in class MultiClientState
  - getProgressiveTimeoutFilter
```
protected java.lang.String getProgressiveTimeoutFilter()
```
    Overrides:
    
    getProgressiveTimeoutFilter in class MultiClientState
  - getIncomingDataPort
```
protected int getIncomingDataPort()
```
    Overrides:
    
    getIncomingDataPort in class MultiClientState
  - getIncomingDataPorts
```
protected int[] getIncomingDataPorts()
```
    Overrides:
    
    getIncomingDataPorts in class MultiClientState
  - getServletMultiplier
```
protected int getServletMultiplier()
```
    Overrides:
    
    getServletMultiplier in class MultiClientState
  - getClientConnectKey
```
protected java.lang.String getClientConnectKey()
```
    Overrides:
    
    getClientConnectKey in class MultiClientState
  - setNumFTPStreams
```
protected void setNumFTPStreams(int numFTPStreams)
```
    Overrides:
    
    setNumFTPStreams in class MultiClientState
  - setIncrementalMode
```
protected void setIncrementalMode(int incrementalMode)
```
    Overrides:
    
    setIncrementalMode in class MultiClientState
  - setIncrementalSizeCheckOnly
```
public void setIncrementalSizeCheckOnly(boolean incrementalSizeCheckOnly)
```
    Overrides:
    
    setIncrementalSizeCheckOnly in class MultiClientState
  - setTransferWithTempName
```
protected void setTransferWithTempName(boolean transferWithTempName)
```
    Overrides:
    
    setTransferWithTempName in class MultiClientState
  - setReadTimeout
```
protected void setReadTimeout(int millisecs)
```
    Overrides:
    
    setReadTimeout in class MultiClientState
  - setExtendedReadTimeout
```
protected void setExtendedReadTimeout(int millisecs)
```
    Overrides:
    
    setExtendedReadTimeout in class MultiClientState
  - setFileTransferPriority
```
protected void setFileTransferPriority(int priority)
```
    Overrides:
    
    setFileTransferPriority in class MultiClientState
  - setVerifyMode
```
protected void setVerifyMode(int verifyMode)
```
    Overrides:
    
    setVerifyMode in class MultiClientState
  - setServletLocation
```
protected void setServletLocation(java.lang.String servletLocation)
```
    Overrides:
    
    setServletLocation in class MultiClientState
  - setServletLocation
```
protected void setServletLocation(java.lang.String servletLocation,
                                  java.lang.String servletSessionID,
                                  java.lang.String welcomeMessage)
```
    Overrides:
    
    setServletLocation in class MultiClientState
  - setLocalWorkingDirectory
```
protected void setLocalWorkingDirectory(java.nio.file.Path localWorkingDirectory)
```
    Overrides:
    
    setLocalWorkingDirectory in class MultiClientState
  - setDeleteAfterTransfer
```
protected void setDeleteAfterTransfer(boolean deleteAfterTransfer)
```
    Overrides:
    
    setDeleteAfterTransfer in class MultiClientState
  - setProgressiveTransfers
```
protected void setProgressiveTransfers(boolean progressiveTransfers)
```
    Overrides:
    
    setProgressiveTransfers in class MultiClientState
  - setProgressiveTimeout
```
protected void setProgressiveTimeout(int progressiveTimeout)
```
    Overrides:
    
    setProgressiveTimeout in class MultiClientState
  - setProgressiveTimeoutFilter
```
protected void setProgressiveTimeoutFilter(java.lang.String progressiveTimeoutFilter)
```
    Overrides:
    
    setProgressiveTimeoutFilter in class MultiClientState
  - setIncomingDataPort
```
protected void setIncomingDataPort(int inDataPort)
```
    Overrides:
    
    setIncomingDataPort in class MultiClientState
  - setIncomingDataPorts
```
protected void setIncomingDataPorts(int[] inDataPorts)
```
    Overrides:
    
    setIncomingDataPorts in class MultiClientState
  - setServletMultiplier
```
protected void setServletMultiplier(int servletMultiplier)
```
    Overrides:
    
    setServletMultiplier in class MultiClientState
  - setClientConnectKey
```
protected void setClientConnectKey(java.lang.String clientConnectKey)
```
    Overrides:
    
    setClientConnectKey in class MultiClientState
  - setClientIdentifier
```
protected void setClientIdentifier(int clientIdentifier)
```
    Overrides:
    
    setClientIdentifier in class MultiClientState
  - setCongestionControlAggression
```
protected void setCongestionControlAggression(int congestionControlAggression)
```
    Overrides:
    
    setCongestionControlAggression in class MultiClientState
  - setTransferWithTempName
```
protected void setTransferWithTempName(boolean transferWithTempName,
                                       int tempMode)
```
    Overrides:
    
    setTransferWithTempName in class MultiClientState
  - testWriteSpeed
```
protected int testWriteSpeed()
                      throws java.io.FileNotFoundException,
                             java.io.IOException
```
    Description copied from class: MultiClientState
    
    Perform a write to current directory with recommended values for determining storage rate.
    
    Overrides:
    
    testWriteSpeed in class MultiClientState
    
    Returns:
    
    write speed in kilobits per second
    
    Throws:
    
    java.io.FileNotFoundException
    
    java.io.IOException
  - testWriteSpeed
```
protected int testWriteSpeed(java.nio.file.Path file,
                             int size,
                             int timeout)
                      throws java.io.FileNotFoundException,
                             java.io.IOException
```
    Description copied from class: MultiClientState
    
    Perform a write to specified file with specified size and timeout for determining storage rate.
    
    Overrides:
    
    testWriteSpeed in class MultiClientState
    
    Parameters:
    
    file - file to write
    
    size - size of file in bytes
    
    timeout - timeout of write in milliseconds
    
    Returns:
    
    write speed in kilobits per second
    
    Throws:
    
    java.io.FileNotFoundException
    
    java.io.IOException
  - testMaximumUploadSpeed
```
protected int testMaximumUploadSpeed()
                              throws unlimited.core.util.common.exception.FCException,
                                     java.io.IOException
```
    Description copied from class: MultiClientState
    
    Performs a series of tests to determine the maximum upload speed to the connected server.
    
    Overrides:
    
    testMaximumUploadSpeed in class MultiClientState
    
    Returns:
    
    int the rate detected in Kbps
    
    Throws:
    
    unlimited.core.util.common.exception.FCException
    
    java.io.IOException
  - testMaximumDownloadSpeed
```
protected int testMaximumDownloadSpeed()
                                throws unlimited.core.util.common.exception.FCException,
                                       java.io.IOException
```
    Description copied from class: MultiClientState
    
    Performs a series of tests to determine the maximum download speed from the connected server.
    
    Overrides:
    
    testMaximumDownloadSpeed in class MultiClientState
    
    Returns:
    
    int the rate detected in Kbps
    
    Throws:
    
    unlimited.core.util.common.exception.FCException
    
    java.io.IOException
  - stopSpeedTesting
```
protected void stopSpeedTesting()
```
    Description copied from class: MultiClientState
    
    Stops the current speed testing methods that this TransferMechanism may be executing
    
    Overrides:
    
    stopSpeedTesting in class MultiClientState
  - filesMatch
```
protected boolean filesMatch(java.nio.file.Path file,
                             java.lang.String rFile,
                             int md5RateLimit,
                             unlimited.core.util.common.CancelHandler cancelHandler)
                      throws unlimited.core.util.common.exception.FCException,
                             java.io.IOException,
                             java.lang.Exception
```
    Description copied from class: MultiClientState
    
    Verifies whether a local file matches a remote file using MD5 checksum
    
    Overrides:
    
    filesMatch in class MultiClientState
    
    Parameters:
    
    file - Local file
    
    rFile - Remote file
    
    cancelHandler - Cancel Handler
    
    Returns:
    
    true if the local file matches the remote file, false if they don't match
    
    Throws:
    
    unlimited.core.util.common.exception.FCException
    
    java.io.IOException
    
    java.lang.Exception
  - getMD5Checksum
```
protected java.lang.String getMD5Checksum(java.lang.String rFile)
                                   throws unlimited.core.util.common.exception.FCException,
                                          java.io.IOException
```
    Description copied from class: MultiClientState
    
    Returns the MD5 checksum for the given remote file
    
    Overrides:
    
    getMD5Checksum in class MultiClientState
    
    Returns:
    
    the MD5 checksum for the given remote file
    
    Throws:
    
    unlimited.core.util.common.exception.FCException
    
    java.io.IOException
  - getMD5
```
protected java.lang.String getMD5(java.lang.String remote)
                           throws unlimited.core.util.common.exception.FCException,
                                  java.io.IOException
```
    Description copied from class: MultiClientState
    
    Returns the MD5 checksum for the specified remote file if it exists
    
    Overrides:
    
    getMD5 in class MultiClientState
    
    Parameters:
    
    remote - file to checksum
    
    Returns:
    
    String representation of the remote file's MD5 checksum
    
    Throws:
    
    unlimited.core.util.common.exception.FCException - if not connected
    
    java.io.IOException
  - serverVersion
```
protected java.lang.String serverVersion()
                                  throws unlimited.core.util.common.exception.FCException
```
    Description copied from class: MultiClientState
    
    Returns the FileCatalyst server version.
    
    Overrides:
    
    serverVersion in class MultiClientState
    
    Returns:
    
    FileCatalyst Server version
    
    Throws:
    
    unlimited.core.util.common.exception.FCException - Exception thrown if not connected.
  - isFileCatalystServer
```
protected boolean isFileCatalystServer()
                                throws java.io.IOException,
                                       unlimited.core.util.common.exception.FCException
```
    Description copied from class: MultiClientState
    
    Returns true if connected to a FileCatalyst server. Returns false if connected to a standard FTP server.
    
    Overrides:
    
    isFileCatalystServer in class MultiClientState
    
    Returns:
    
    true if connected to a FileCatalyst server.
    
    Throws:
    
    java.io.IOException
    
    unlimited.core.util.common.exception.FCException
  - isUDPSupported
```
protected boolean isUDPSupported()
                          throws java.io.IOException,
                                 unlimited.core.util.common.exception.FCException
```
    Description copied from class: MultiClientState
    
    Returns true if connected to a FileCatalyst server that supports UDP.
    
    Overrides:
    
    isUDPSupported in class MultiClientState
    
    Returns:
    
    Returns false if you are not FileCatalyst or if UDP is not supported by license.
    
    Throws:
    
    java.io.IOException
    
    unlimited.core.util.common.exception.FCException
  - getMaxRetries
```
protected int getMaxRetries()
```
    Overrides:
    
    getMaxRetries in class MultiClientState
  - setMaxRetries
```
protected void setMaxRetries(int maxRetries)
```
    Overrides:
    
    setMaxRetries in class MultiClientState
  - getWaitRetry
```
protected long getWaitRetry()
```
    Overrides:
    
    getWaitRetry in class MultiClientState
  - isForceTCPmodeACKs
```
protected boolean isForceTCPmodeACKs()
```
    Overrides:
    
    isForceTCPmodeACKs in class MultiClientState
  - setForceTCPmodeACKs
```
protected void setForceTCPmodeACKs(boolean forceTCPmodeACKs)
```
    Overrides:
    
    setForceTCPmodeACKs in class MultiClientState
  - setWaitRetry
```
protected void setWaitRetry(long waitRetry)
```
    Overrides:
    
    setWaitRetry in class MultiClientState
  - testUDPACKs
```
protected void testUDPACKs()
                    throws unlimited.core.util.common.exception.FCException,
                           java.io.IOException
```
    Description copied from class: MultiClientState
    
    Tests if UDP ACK mode is possible an configures internal variables. This method only needs to be called if the FCClient object was created using an existing authenticated Socket object.
    
    Overrides:
    
    testUDPACKs in class MultiClientState
    
    Throws:
    
    unlimited.core.util.common.exception.FCException
    
    java.io.IOException
  - isUseCongestionControl
```
protected boolean isUseCongestionControl()
```
    Overrides:
    
    isUseCongestionControl in class MultiClientState
  - setUseCongestionControl
```
protected void setUseCongestionControl(boolean useCongestionControl)
```
    Overrides:
    
    setUseCongestionControl in class MultiClientState
  - getUnitSize
```
protected int getUnitSize()
```
    Overrides:
    
    getUnitSize in class MultiClientState
  - setUnitSize
```
protected void setUnitSize(int unitSize)
```
    Overrides:
    
    setUnitSize in class MultiClientState
  - getNumUDPSockets
```
protected int getNumUDPSockets()
```
    Overrides:
    
    getNumUDPSockets in class MultiClientState
  - setNumUDPSockets
```
protected void setNumUDPSockets(int numUDPSockets)
```
    Overrides:
    
    setNumUDPSockets in class MultiClientState
  - getNumThreads
```
protected int getNumThreads()
```
    Overrides:
    
    getNumThreads in class MultiClientState
  - setNumThreads
```
protected void setNumThreads(int numThreads)
```
    Overrides:
    
    setNumThreads in class MultiClientState
  - setFileFilter
```
protected void setFileFilter(FileCatalystFileFilter filter)
```
    Overrides:
    
    setFileFilter in class MultiClientState
  - setReport
```
public void setReport(unlimited.fc.reporting.ClientDataReport reporter)
```
    Description copied from class: MultiClientState
    
    Sets the report object.
    
    Overrides:
    
    setReport in class MultiClientState
  - remoteUpload
```
protected TransferHook remoteUpload(FCClient destServer,
                                    java.lang.String sourceFile,
                                    java.lang.String destFile)
                             throws unlimited.core.util.common.exception.FCException,
                                    java.io.IOException,
                                    java.lang.Exception
```
    Description copied from class: MultiClientState
    
    This method will initiate an upload from the server to which this FCClient object (Server A) is connected to the server specified by the destServer parameter passed in (Server B). The sourceFile is the path to a file on Server A and the desFile is the path on Server B where the file will be uploaded. This method returns a TransferHook which may be monitored for status information, and which allows the transfer to be canceled. All transfer parameters, transfer mode, etc... are specified through the regular API methods, such as setBlocksize(), setMode(), etc...
    
    Overrides:
    
    remoteUpload in class MultiClientState
    
    Parameters:
    
    destServer - an FCClient object from which remote connection information will be taken. It doesn't have to be connected.
    
    sourceFile - the absolute or relative path to the source file
    
    destFile - the absolute or relative path to the destination file
    
    Returns:
    
    a TransferHook which may be monitored for status information
    
    Throws:
    
    unlimited.core.util.common.exception.FCException - if a FileCatalyst protocol error occurs.
    
    java.io.IOException - if an error occurs either connecting to the destination server, or if a transfer I/O error occurs.
    
    java.lang.Exception
  - remoteUpload
```
protected TransferHook remoteUpload(FCClient destServer,
                                    java.util.List<java.lang.String> sourceFiles,
                                    java.util.List<java.lang.String> destFiles)
                             throws unlimited.core.util.common.exception.FCException,
                                    java.io.IOException,
                                    java.lang.Exception
```
    Description copied from class: MultiClientState
    
    This method will initiate an upload from the server to which this FCClient object (Server A) is connected to the server specified by the destServer parameter passed in (Server B). The sourceFile is the path to a file on Server A and the desFile is the path on Server B where the file will be uploaded. This method returns a TransferHook which may be monitored for status information, and which allows the transfer to be canceled. All transfer parameters, transfer mode, etc... are specified through the regular API methods, such as setBlocksize(), setMode(), etc...
    
    Overrides:
    
    remoteUpload in class MultiClientState
    
    Parameters:
    
    destServer - an FCClient object from which remote connection information will be taken. It doesn't have to be connected.
    
    sourceFiles - a list of absolute or relative paths to the source files to be transferred
    
    destFiles - a list of absolute or relative paths to the destination files. Size must match sourceFiles List.
    
    Returns:
    
    a TransferHook which may be monitored for status information
    
    Throws:
    
    unlimited.core.util.common.exception.FCException - if a FileCatalyst protocol error occurs.
    
    java.io.IOException - if an error occurs either connecting to the destination server, or if a transfer I/O error occurs.
    
    java.lang.Exception
  - downloadAs
```
protected TransferHook downloadAs(FileListDataItem remoteFile,
                                  java.nio.file.Path localFile,
                                  java.lang.String transferUniqueID)
                           throws unlimited.core.util.common.exception.FCException,
                                  java.io.IOException
```
    Description copied from class: MultiClientState
    
    Download the specified file to the specified local file.
    
    Overrides:
    
    downloadAs in class MultiClientState
    
    Parameters:
    
    remoteFile - The remote file to be downloaded. Can be a relative or absolute path to the file.
    
    localFile - The local path to which the file will be stored. Can be a different path entirely
    
    transferUniqueID - Unique ID for the transfer
    
    Returns:
    
    A handler object that can be monitored for progress and status information.
    
    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
  - testApproximateUploadSpeed
```
protected int testApproximateUploadSpeed()
                                  throws unlimited.core.util.common.exception.FCException,
                                         java.io.IOException
```
    Description copied from class: MultiClientState
    
    Performs a quick test to determine the approximate upload speed to the connected server.
    
    Overrides:
    
    testApproximateUploadSpeed in class MultiClientState
    
    Returns:
    
    int the rate detected in Kbps
    
    Throws:
    
    unlimited.core.util.common.exception.FCException
    
    java.io.IOException
  - getHumanReadableName
```
public java.lang.String getHumanReadableName()
```
    Description copied from class: MultiClientState
    
    Returns a human readable name for the state. Used within toString()
    
    Overrides:
    
    getHumanReadableName in class MultiClientState
    
    Returns:
    
    A human readable name
  - testApproximateDownloadSpeed
```
protected int testApproximateDownloadSpeed()
                                    throws unlimited.core.util.common.exception.FCException,
                                           java.io.IOException
```
    Description copied from class: MultiClientState
    
    Performs a quick test to determine the approximate download speed to the connected server.
    
    Overrides:
    
    testApproximateDownloadSpeed in class MultiClientState
    
    Returns:
    
    int the rate detected in Kbps
    
    Throws:
    
    unlimited.core.util.common.exception.FCException
    
    java.io.IOException
  - setCompFileFilter
```
protected void setCompFileFilter(java.lang.String compFileFilter)
```
    Overrides:
    
    setCompFileFilter in class MultiClientState
  - setPostURL
```
protected void setPostURL(java.lang.String postURL)
```
    Overrides:
    
    setPostURL in class MultiClientState
  - setMd5RateLimit
```
protected void setMd5RateLimit(int md5RateLimit)
```
    Overrides:
    
    setMd5RateLimit in class MultiClientState
  - setRenameExtension
```
protected void setRenameExtension(boolean renameExtension)
```
    Overrides:
    
    setRenameExtension in class MultiClientState
  - fileSystemEvents
```
protected java.util.List<FileSystemEvent> fileSystemEvents(long timeout)
                                                    throws unlimited.core.util.common.exception.FCException,
                                                           java.io.IOException
```
    Description copied from class: MultiClientState
    
    Returns the file system events, (if any I assume).
    
    Overrides:
    
    fileSystemEvents in class MultiClientState
    
    Throws:
    
    unlimited.core.util.common.exception.FCException
    
    java.io.IOException
  - setTransferEmptyDirectories
```
protected void setTransferEmptyDirectories(boolean transferEmptyDirectories)
```
    Overrides:
    
    setTransferEmptyDirectories in class MultiClientState
  - setCancelled
```
protected void setCancelled()
```
    Overrides:
    
    setCancelled in class MultiClientState
  - prms
```
protected java.lang.String[] prms(java.lang.String filename)
                           throws unlimited.core.util.common.exception.FCException,
                                  java.io.IOException
```
    Description copied from class: MultiClientState
    
    Return the file permission of the file/directory listed in the argument from the remote server.
    
    Overrides:
    
    prms in class MultiClientState
    
    Returns:
    
    permissions
    
    Throws:
    
    unlimited.core.util.common.exception.FCException
    
    java.io.IOException
  - get
```
protected 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 unlimited.core.util.common.exception.FCException,
                   java.io.IOException,
                   java.security.NoSuchAlgorithmException
```
    Overrides:
    
    get in class MultiClientState
    
    Throws:
    
    unlimited.core.util.common.exception.FCException
    
    java.io.IOException
    
    java.security.NoSuchAlgorithmException
  - isCancelled
```
protected boolean isCancelled()
```
    Overrides:
    
    isCancelled in class MultiClientState
  - getData
```
protected TransferMechanismData getData()
```
  - applyRemoteFileAttributesToLocalFile
```
protected void applyRemoteFileAttributesToLocalFile(java.nio.file.Path localFile,
                                                    java.lang.String remoteFile)
                                             throws unlimited.core.util.common.exception.FCException,
                                                    java.io.IOException
```
    Description copied from class: MultiClientState
    
    Applies the remote file attributes to the local file instance.
    
    Overrides:
    
    applyRemoteFileAttributesToLocalFile in class MultiClientState
    
    Parameters:
    
    localFile - Path of the local file that you wish to change
    
    remoteFile - Path of the remote tile that you would like the attributes from
    
    Throws:
    
    java.io.IOException
    
    unlimited.core.util.common.exception.FCException
  - getTransferRate
```
protected int getTransferRate()
```
    Overrides:
    
    getTransferRate in class MultiClientState
  - getBlastRate
```
protected int getBlastRate()
```
    Overrides:
    
    getBlastRate in class MultiClientState
  - getServerAgentID
```
protected java.lang.String getServerAgentID()
```
    Overrides:
    
    getServerAgentID in class MultiClientState
  - setSessionID
```
protected void setSessionID(java.lang.String sessionID)
```
    Overrides:
    
    setSessionID in class MultiClientState
  - resetSession
```
protected void resetSession()
                     throws unlimited.core.util.common.exception.FCException,
                            java.io.IOException
```
    Overrides:
    
    resetSession in class MultiClientState
    
    Throws:
    
    unlimited.core.util.common.exception.FCException
    
    java.io.IOException
  - getSessionCount
```
protected int getSessionCount()
```
    Overrides:
    
    getSessionCount in class MultiClientState
  - getCompFileFilter
```
protected java.lang.String getCompFileFilter()
```
    Overrides:
    
    getCompFileFilter in class MultiClientState
  - getTransferEmptyDirectories
```
protected boolean getTransferEmptyDirectories()
```
    Overrides:
    
    getTransferEmptyDirectories in class MultiClientState
  - getPostURL
```
protected java.lang.String getPostURL()
```
    Overrides:
    
    getPostURL in class MultiClientState
  - getMd5RateLimit
```
protected int getMd5RateLimit()
```
    Overrides:
    
    getMd5RateLimit in class MultiClientState
  - getRenameExtension
```
protected boolean getRenameExtension()
```
    Overrides:
    
    getRenameExtension in class MultiClientState
  - setClientWorkingPath
```
protected void setClientWorkingPath(java.nio.file.Path clientWorkingPath)
```
    Overrides:
    
    setClientWorkingPath in class MultiClientState
  - setClientName
```
protected void setClientName(java.lang.String clientName)
```
    Overrides:
    
    setClientName in class MultiClientState
  - getClientName
```
protected java.lang.String getClientName()
```
    Overrides:
    
    getClientName in class MultiClientState
  - setClientAgentID
```
protected void setClientAgentID(java.lang.String clientAgentID)
```
    Overrides:
    
    setClientAgentID in class MultiClientState
  - setUserRelativePriority
```
public void setUserRelativePriority(int priority)
```
    Overrides:
    
    setUserRelativePriority in class MultiClientState
  - isTransferEmptyDirectories
```
protected boolean isTransferEmptyDirectories()
```
    Overrides:
    
    isTransferEmptyDirectories in class MultiClientState
  - getFileFilter
```
protected FileCatalystFileFilter getFileFilter()
```
    Overrides:
    
    getFileFilter in class MultiClientState
  - setTransferMode
```
protected void setTransferMode()
```
  - getUserEmailAddress
```
protected java.lang.String getUserEmailAddress()
                                        throws java.io.IOException
```
    Description copied from class: MultiClientState
    
    Get The User's Email Address When Called
    
    Overrides:
    
    getUserEmailAddress in class MultiClientState
    
    Returns:
    
    - A string containing the user's email address
    
    Throws:
    
    java.io.IOException - - If there are issues an exception will be thrown
  - getUserFullName
```
protected java.lang.String getUserFullName()
                                    throws java.io.IOException
```
    Description copied from class: MultiClientState
    
    Get The User's Full Name When Called
    
    Overrides:
    
    getUserFullName in class MultiClientState
    
    Throws:
    
    java.io.IOException
  - sendWeblink
```
protected WeblinkResult sendWeblink(WeblinkDataContainer dataDO)
                             throws unlimited.core.util.common.exception.FCException,
                                    java.io.IOException
```
    Description copied from class: MultiClientState
    
    Creates a weblink with the parameters provided by the client. Currently supported method for data creation
    
    Overrides:
    
    sendWeblink in class MultiClientState
    
    Returns:
    
    Data object containing the results of the weblink creation
    
    Throws:
    
    unlimited.core.util.common.exception.FCException - if a FileCatalyst protocol error occurs.
    
    java.io.IOException - if an error occurs either connecting to the destination server, or if a transfer I/O error occurs.
  - sendWeblink
```
@Deprecated
protected WeblinkResult sendWeblink(java.util.List<java.lang.String> to,
                                    java.lang.String from,
                                    java.lang.String message,
                                    java.util.Set<java.lang.String> files)
                             throws unlimited.core.util.common.exception.FCException,
                                    java.io.IOException
```
    Deprecated.
    
    Description copied from class: MultiClientState
    
    Method for creating a Weblink on FC Servers.
    
    Overrides:
    
    sendWeblink in class MultiClientState
    
    Parameters:
    
    to - List of to email addresses that you would like to send the link to
    
    message - Message contained in the email that is sent out
    
    files - File listing that you wish to include the link. All files are relative to connected user home
    
    Returns:
    
    Data object containing the results of the weblink creation
    
    Throws:
    
    unlimited.core.util.common.exception.FCException - if a FileCatalyst protocol error occurs.
    
    java.io.IOException - if an error occurs either connecting to the destination server, or if a transfer I/O error occurs.
  - getUserPermissions
```
protected UserPermissionsContainer getUserPermissions()
                                               throws unlimited.core.util.common.exception.FCException,
                                                      java.io.IOException
```
    Description copied from class: MultiClientState
    
    Gather's the user's permissions
    
    Overrides:
    
    getUserPermissions in class MultiClientState
    
    Returns:
    
    Throws:
    
    unlimited.core.util.common.exception.FCException - if a FileCatalyst protocol error occurs.
    
    java.io.IOException - if an error occurs either connecting to the destination server, or if a transfer I/O error occurs.
  - isLinkEnabledOnServer
```
public boolean isLinkEnabledOnServer()
                              throws unlimited.core.util.common.exception.FCException,
                                     java.io.IOException
```
    Description copied from class: MultiClientState
    
    Request if link is enabled on the server that you are connected too
    
    Overrides:
    
    isLinkEnabledOnServer in class MultiClientState
    
    Returns:
    
    Throws:
    
    java.io.IOException - if an error occurs either connecting to the destination server, or if a transfer I/O error occurs.
    
    unlimited.core.util.common.exception.FCException
  - uploadRange
```
protected void uploadRange(java.nio.file.Path localFile,
                           java.lang.String remoteFile,
                           long offset,
                           long length)
                    throws java.io.IOException
```
    Description copied from class: MultiClientState
    
    Uploads a range of rate for the given file
    
    Overrides:
    
    uploadRange in class MultiClientState
    
    Parameters:
    
    localFile - The file the patch will be drawn from
    
    remoteFile - The file to be patched
    
    offset - Starting byte for the patch
    
    length - Length of the patch
    
    Throws:
    
    java.io.IOException - Problems with the transfer
  - downloadRange
```
protected void downloadRange(java.nio.file.Path localFile,
                             java.lang.String remoteFile,
                             long offset,
                             long length)
                      throws java.io.IOException
```
    Description copied from class: MultiClientState
    
    Downloads a range of rate for the given file
    
    Overrides:
    
    downloadRange in class MultiClientState
    
    Parameters:
    
    localFile - The file the patch will be drawn from
    
    remoteFile - The file to be patched
    
    offset - Starting byte for the patch
    
    length - Length of the patch
    
    Throws:
    
    java.io.IOException - Problems with the transfer
  - getServerConfigurationValue
```
public java.lang.String getServerConfigurationValue(java.lang.String value)
                                             throws java.io.IOException
```
    Description copied from class: MultiClientState
    
    Request if link is enabled on the server that you are connected too
    
    Overrides:
    
    getServerConfigurationValue in class MultiClientState
    
    Returns:
    
    Throws:
    
    java.io.IOException - if an error occurs either connecting to the destination server, or if a transfer I/O error occurs.
  - getAllAvailableServerConfigs
```
public ServerConfigs getAllAvailableServerConfigs()
                                           throws java.io.IOException
```
    Description copied from class: MultiClientState
    
    Request if link is enabled on the server that you are connected too
    
    Overrides:
    
    getAllAvailableServerConfigs in class MultiClientState
    
    Returns:
    
    Throws:
    
    java.io.IOException - if an error occurs either connecting to the destination server, or if a transfer I/O error occurs.
  - modtime
```
protected void modtime(FileListDataItem item)
                throws java.io.IOException
```
    Description copied from class: MultiClientState
    
    This will update the modtime of the file existing on the server to whatever the incoming FileListDataItem is set to
    
    Overrides:
    
    modtime in class MultiClientState
    
    Parameters:
    
    item - - item with a modification time to be sent to the server;
    
    Throws:
    
    java.io.IOException
  - runWorkerClient
```
public void runWorkerClient(FileTransferMechanismHandler handler)
                     throws java.lang.Exception
```
    Overrides:
    
    runWorkerClient in class MultiClientState
    
    Throws:
    
    java.lang.Exception
  - isAutoUnzip
```
protected boolean isAutoUnzip()
```
    Overrides:
    
    isAutoUnzip in class MultiClientState
  - setAutoUnzip
```
protected void setAutoUnzip(boolean autoUnzip)
```
    Overrides:
    
    setAutoUnzip in class MultiClientState
  - setTaskID
```
protected void setTaskID(java.lang.String taskID)
```
    Overrides:
    
    setTaskID in class MultiClientState
  - setUserEmailAddress
```
protected void setUserEmailAddress(java.lang.String newEmailAddress)
                            throws java.io.IOException
```
    Description copied from class: MultiClientState
    
    Sets The User's Email Address When Called
    
    Overrides:
    
    setUserEmailAddress in class MultiClientState
    
    Parameters:
    
    newEmailAddress - - The New Email To Be Set
    
    Throws:
    
    java.io.IOException
  - setUserFullName
```
protected void setUserFullName(java.lang.String newFullName)
                        throws java.io.IOException
```
    Description copied from class: MultiClientState
    
    Set's The User's Name When Called
    
    Overrides:
    
    setUserFullName in class MultiClientState
    
    Throws:
    
    java.io.IOException
  - setForceFileOwnershipEnabled
```
protected void setForceFileOwnershipEnabled(boolean isForceFileOwnershipEnabled)
```
    Overrides:
    
    setForceFileOwnershipEnabled in class MultiClientState
  - setForceFileOwnershipUser
```
protected void setForceFileOwnershipUser(java.lang.String forceFileOwnershipUser)
```
    Overrides:
    
    setForceFileOwnershipUser in class MultiClientState
  - setForceFileOwnershipGroup
```
protected void setForceFileOwnershipGroup(java.lang.String forceFileOwnershipGroup)
```
    Overrides:
    
    setForceFileOwnershipGroup in class MultiClientState
  - initSession
```
protected void initSession()
```
    Overrides:
    
    initSession in class MultiClientState

Class CreatedState

Nested Class Summary

Nested classes/interfaces inherited from class unlimited.fc.client.api.multiclient.MultiClientState

Field Summary

Fields inherited from class unlimited.fc.client.api.multiclient.MultiClientState

Constructor Summary

Method Summary

Methods inherited from class unlimited.fc.client.api.multiclient.MultiClientState

Methods inherited from class java.lang.Object

Constructor Detail

CreatedState

Method Detail

start

pushJob

preProcess

pushJobNoProcessing

jobPushed

setPostTaskSentData

getHandledBy

cd

remoteSynchFile

remoteSynchFile

cdup

doJob

initialize

initializeNoUserLogs

connect

isDowngradeModeOnReConnect

setDowngradeModeOnReConnect

setClientSubIdentifier

setClientString

getObserver

setObserver

getCallbackHandler

setCallbackHandler

synchClient

getWriteFileMode

setWriteFileMode

getWriteBufferSizeKB

setWriteBufferSizeKB

getReadBufferSizeKB

setReadBufferSizeKB

getNumBlockReaders

setNumBlockReaders

getNumBlockWriters

setNumBlockWriters

getNumSenderThreads

setNumSenderThreads

getNumReceiveSockets

setNumReceiveSockets

getNumSenderSockets

setNumSenderSockets

getPacketQueueDepth

setPacketQueueDepth

getNumPacketProcessors

setNumPacketProcessors

isCongestionControlEnabled

getCongestionControlAggression

setCongestionControlEnabled

getCongCtrlStrategy

setCongCtrlStrategy

willTransferWork

getConnectivityTestResults

resetAutoDetectInfo

autoDetectConectionMode

autoDetectConectionModeDownload

autoDetectConectionModeUpload

autoDetectConectionModeUploadAndDownload

autoDetectConectionModeDownload

autoDetectConectionModeUpload

autoDetectConectionModeUploadAndDownload

login

disconnect

finish

exists

exists

size

download

download

download