Package unlimited.fc.client.api.multiclient

Contains the core MultiClientManager functionality. MultiClient is an extension on the single transfer FCClient mechanism included within the unlimited.fc.client.api package. It allows consumers of the API to transfer multiple files across N clients in a thread safe and concurrent fashion.

Interface Summary

Interface	Description
FileTransferMechanismHandler	Functional interface that defines the method for all derived classes to handle FileTransferMechanism
MultiHookManagerInterface	Defines the common method set that is used within all Multi-Client hooks
StateHandler	StateHandler interface that is used provide easy methods for handling different states that the MultiClientManager enters during it's transactions.
TransferIDHolder

Class Summary

Class	Description
BadState	The Class BadState.
BadState.DisconnectErrorState	The Class DisconnectErrorState.
BadState.FailedConnectAttemptState	The Class FailedConnectAttemptState.
BadState.FailedFinishState	The Class FailedFinishState.
BadState.FailedInitializationState	The Class FailedInitializationState.
BadState.FailedLoginState	The Class FailedLoginState.
BadState.FailedTransferState	The Class FailedTransfer State
CancelledState	The Class CancelledState.
CancellingState	The class CancellingState.
CancellingState.Transition	The Class CancellingState.
CancelTypeState	Multi-Client state that defines common methods for other cancel type states
ClientFactory	A factory for creating Client objects.
ClientFactory.FCClientFactory	A factory for creating FCClient objects.
ConnectedState	The Class ConnectedState.
ConnectedState.Transition	The Class ConnectingState.
CreatedState	The Class CreatedState.
DeleteAfterTransferListener<T>	A listener class that listens for a TransferCompleteState, and then deletes the empty directories once the event fires
FCClientWorker<T extends FileTransferMechanism>	The Class FCClientWorker.
FCClientWorkerPool	The Class FCClientWorkerPool.
FileCacheJobHandler	The Class FileCacheJobHandler.
FinishedState	The Class FinishedState.
FinishedState.Transition	The Class FinishingState.
FolderCleanupTool
HandlerMapGenerator	Generator resource that provides an easy way to generate HandlerData resources for all active client's within a Multi-Manager
IdleState	The Class IdleState.
InitializedState	The Class InitializedState.
InitializedState.DisconnectingState	The Class DisconnectingState.
InitializedState.Transition	The Class InitializingState.
LoggedInState	The Class LoggedInState.
LoggedInState.Transition	The Class LoggingInState.
MaintainFolderModTimeListener	A listener class that collects files (upload / download) while waiting for a transfer success event.
MonitoringState	The Class MonitoringState.
MultiClientCancelHandler	An implementation of the CancelHandler interface.
MultiClientHookObserverDelegate	A delegate class that provides in-house extensions on the observable interface
MultiClientManager	The MultiClientManager is a pooled client solution to transfers.
MultiClientManagerSystemProperties	Resource that defines system properties that super users may define for the multi-client manager
MultiClientState	The Class MultiClientState.
MultiClientTransferControl<T>	The Class MultiClientTransferControl.
MultiClientTransferHook	The Class MultiClientTransferHook.
MultiClientTransferHookDirectionHandler	The Class MultiClientTransferHookDirectionHandler.
MultiClientTransferHookEventListener	The listener interface for receiving multiClientTransferHookEvent events.
MultiClientTransferHookEventListener.JobCombiner	Inner resource that combines the TransferJob provided at construction into all DownloadJobs, and UploadJobs
MultiClientTransferringBandwidthManager	Manager resource that provides the core functionality for distributing bandwidths across the Mulit-Client
MultiManagerStreamCollapser<T,ListType extends java.util.List<T>>	Stream collapser that is used within the multi-client
MultiManagerStreamCollapser.DownloadStreanCollapser	Collapser that provides a common collapser for the download stream functionality
MultiManagerStreamCollapser.UploadStreamCollapser	Collapser that provides a common collapser for the upload stream functionality
PostTransferIdleState	The PostTransferIdleState class
ProcessingState	The ProcssingState class
ReadOnlyState	The Class ReadOnlyState.
ReadyState	The Class ReadyState.
ReadyState.Transition	The Class CreatingWorkerThreadsState.
StateHandler.Adapter	The StateHandler adapter class that provides an empty over-rideable shell for all of the methods defined within the Handler
StateSignal	Signal object that lets external resources listen for events within the Multi-Manager
StateSignal.StateListener	Class that provides the functionality for registering and deregistering state signals
StateSignal.StateSignalBuilder	A builder class that is used to easily build StateSignal objects
StatusCodeHandler	A StateHandler implementation that sets the status code for the MultiClientManager whenever a new event comes into the system.
StickySessionIDSupplier
ThreadSafeMultiHook	A derived class that provides thread safe access to the methods defined within the TransferHook base class
TransferCacheFileRemover	Job Handler that provides methods for removing items from the transfer cache
TransferCompleteState	The TransferCompleteState class
TransferCompleteState.Transition	Transition class that defines transitional behaviour between the previous state and the TransferComplete state.
TransferIDCallback	Callback resource that provides access to methods for checking whether or not there is a transfer, and what the message of that transfer is
TransferringState	The Class TransferringState.
TransferringState.TransferringWithNoPendingWorkAllFilesInTransit
TransferringState.TransferringWithNoPendingWorkState	The Class TransferringWithNoPendingWorkState.

Enum Summary

Enum	Description
BandwidthDistributionMode	This is used to tell the multiclient manager how to distribute its bandwidth during a setTargetRate(int rate, BandwidthDistributionMode mode)
SessionManageMode	An enumeration that keeps track of the type of session ID management that we should have

Exception Summary

Exception	Description
MultiClientState.StateMachineException	The Class StateMachineException.