unlimited.fc.client.engine

Class FCClientEngineHTTP

java.lang.Object

unlimited.fc.client.engine.FCClientEngine

unlimited.fc.client.engine.FCClientEngineHTTP

All Implemented Interfaces:

java.util.Observer

public class FCClientEngineHTTP
extends FCClientEngine

Field Summary

Fields inherited from class unlimited.fc.client.engine.FCClientEngine

AUTO, cachePWD, clientAgentID, clientName, clientWorkingPath, commandChannelProtocol, FTP, http, HTTP, isConnected, isFileCatalystServer, isFileCatalystServerEnterprise, isFileCatalystServerPro, isLoggedIn, isTransferringData, maxServerRate, modtimeCache, monitoredTransfer, newDownloadRate, printDebugStatements, readTimeoutLong, remoteServiceVersion, serverAgentID, servletLocation, sessionCount, sessionID, sessionPriority, sessionTimeStamp, shouldPerformServerPostProcess, sizeCache, sslSocketProducer, streamCap, systemCache, targetRate, TERMINAL, TOKEN_AUTH_SUCCESS_HEADER, transferID, transferSettings, UDP, UNABLE_TO_CONNECT_TO_NON_FILE_CATALYST_SERVER

Constructor Summary

Constructors

Constructor and Description
FCClientEngineHTTP(java.lang.String host, int port, java.lang.String serfoLocation, LogUtils log)
FCClientEngineHTTP(java.lang.String host, int port, java.lang.String serfoLocation, java.lang.String sid, LogUtils log)
FCClientEngineHTTP(java.lang.String host, int port, java.lang.String serfoLocation, java.lang.String sid, LogUtils log, boolean isPrintSolution)

Method Summary

Modifier and Type	Method and Description
void	applyPatch(java.lang.String remoteFile, java.lang.String remotePatch, long offset) Applies a patch file on the remote server to the specified file at the specified offset
boolean	cancelTransfer() Cancels the current transfer, if one is occurring
void	cdup() Change to the parent directory
void	chdir(java.lang.String dir) Change the remote working directory to that supplied
java.lang.String	createPatch(java.lang.String remoteFile, long offset, long length) Creates a new patch file on the remote server that contains the bytes from offset to offeset+length of remoteFile
void	delete(java.lang.String remoteFile) Delete the specified remote file
void	deleteAll(FileListData remoteFiles, boolean ftpDelete)
void	deleteAll(java.util.List<java.lang.String> remoteFiles) Bulk delete, deletes all the specified files in a single command.
void	detectFCServer()
java.util.stream.Stream<FileListDataItem>	doDirStream(DirListParams params)
java.util.ArrayList<FileSystemEvent>	fileSystemEvents(long timeout) Get a list of file system events from the server
void	filter(FileCatalystFileFilter<?> filter) Initializes the file filter on the server.
void	filter(long olderThan, long newerThan, long upperByteLimit, long lowerByteLimit, java.lang.String filterString, int filterMode, boolean applyFilterToDirectories) Initializes the file filter on the server.
java.lang.Object	getComLock()
int	getCurrentRate()
protected DirListTool	getDirListTool(DirListParams p, FCClientEngine e)
ForceFileOwnershipConfig	getForceFileOwnerConfig()
void	getHTTP(DownloadTransferRequestData requestData)
protected int	getIdealTransferMode(int rate, long length)
boolean	getIsPrintSolution()
protected java.lang.String	getLocalHost()
java.lang.String	getMD5(java.lang.String remoteFile) Request the MD5 digest of the remote file
java.lang.String	getMD5(java.lang.String remoteFile, long offset, long length) Request the MD5 digest of the remote file
protected java.lang.String	getRemoteHost()
int	getServletMultiplier()
protected java.lang.String	getSystKey()
protected void	informServerToWriteReport(PropertyTransmission reportArgs)
java.lang.String	innerSyst()
boolean	isDeltasStillGrowing()
boolean	isHttp() should be overridden in FCClientEngineHTTP and return true
boolean	isServerTimeout()
boolean	isSSL()
boolean	isTransferCancelled()
boolean	isZipStillExtracting()
boolean	isZipStillGrowing(java.lang.String zipFileName)
void	mkdir(java.lang.String dir) Create the specified remote working directory
void	mkdlt(java.lang.String srcfile, java.lang.String sigfile, int blockLength, boolean compress, int compLevel, int strategy) Called by ReceiverHandler to create a delta file remotely.
void	mkdlt(java.lang.String srcfile, java.lang.String sigfile, int blockLength, boolean compress, int compLevel, int strategy, java.lang.String uniqueID, boolean waitForDeltaCreation) Called by ReceiverHandler to create a delta file remotely.
void	mkfile(java.lang.String file) Create the specified remote working directory
java.lang.String	mksig(java.lang.String srcfile, boolean compress, java.lang.String uniqueID)
java.lang.String	mksig(java.lang.String srcfile, java.lang.String uniqueID)
java.util.Date	modtime(java.lang.String remoteFile) Get modification time for a remote file
java.util.Date	modtime(java.lang.String remoteFile, boolean bypassCache) Get modification time for a remote file
void	modtime(java.lang.String remoteFile, java.util.Date d) Set modification time for a remote file
void	moveFilesToServer(java.lang.String remoteFile)
void	noop() Send a NOOP command
protected java.lang.String	performAsyncMD5(java.lang.String md5Command)
protected java.lang.String	performSyncedMD5(java.lang.String md5Command)
java.lang.String[]	prms(java.lang.String fileName) Return the file permission of the file/directory listed in the argument from the remote server.
void	put(UploadTransferRequestData data) Put a local file onto the FileCatalyst server.
protected void	putHTTP(java.nio.file.Path file, java.lang.String remoteFile, long sfSize, long offset, boolean append, int targetBandwidth)
java.lang.String	pwd() Get the current remote working directory
void	quit() Quit the FileCatalyst session
void	quote(java.lang.String command, java.lang.String[] validCodes) Issue arbitrary FileCatalyst commands to the FileCatalyst server.
java.lang.String	rbfil(java.lang.String srcfile, java.lang.String deltafile, int blockLength, boolean compress, int level, boolean uniqueName)
void	reconnect()
void	remoteTransferInitiate(ServerToServerTransferSettings settings) Initiate a
java.lang.String	remoteTransferStatus()
void	rename(java.lang.String from, java.lang.String to) Rename a file or directory
void	rmdir(java.lang.String dir) Delete the specified remote working directory
void	rmdirRecursive(FileListDataItem item) Recursively delete a remote folder
void	sendEmail(java.lang.String emailAddress, int statusCode, java.lang.String note) Instruct the server to send an email to the administrator
protected void	sendTransmitRateCommand(int targetRate, int startRate)
WeblinkResult	sendWeblink(WeblinkDataContainer linkDO) Creates A Weblink From The Data Container Given
void	serverPostProcess(java.lang.String file) Execute post processing on the specified file
int	setBandwidth(int bandwidth)
void	setForceFileOwnerConfig(ForceFileOwnershipConfig forceOwnerConfig)
void	setIsPrintSolution(boolean isPrintSolution)
void	setServletMultiplier(int servletMultiplier)
void	setTimeout(int millis)
void	setup(java.util.function.Supplier<ClientCredentials> credentials) Login into an account on the FileCatalyst server.
boolean	site(java.lang.String command) Run a site-specific command on the server.
java.lang.String	size(java.lang.String fileName)
java.lang.String	size(java.lang.String fileName, boolean bypassCache) Get the size of the named file from the remote server.
int	testApproximateDownloadSpeed() Performs a quick test to determine the approximate download speed to the connected server.
int	testApproximateUploadSpeed() Performs a quick test to determine the approximate upload speed to the connected server.
int	testMaximumDownloadSpeed() Performs a quick test to determine the approximate download speed to the connected server.
int	testMaximumUploadSpeed() Performs a quick test to determine the approximate upload speed to the connected server.
void	unzip(java.lang.String remoteFile, boolean maintainPermissions, boolean maintainTimeStamp) Request that a file on the server be unzipped
void	zip(java.lang.String zipFilename, java.util.List remoteFiles, long zipSizeLimit, boolean waitForZipCreation, boolean needsRecurse)

Methods inherited from class unlimited.fc.client.engine.FCClientEngine

abort, abortAck, accessTime, addClientConnectKey, applyRemoteFileAttributesToLocalFile, binary, buildFilterCommand, buildUNZIPCommand, buildWeblinkCommand, checkDownloadPermissions, checkUploadModifyPermissions, close, createFCClientEngine, createFCClientEngine, createFCClientEngine, createFCClientEngine, createFCClientEngine, createFCClientEngine, createThirdPartyFTPServerDataConnection, creationTime, ctrlClient, deleteAll, deleteAll, detectSessionKilledByAdmin, dir, dir, dir, dir, dir, dirRaw, doDirListing, doDirListing, doDirStream, exists, exists, featureSet, flushCaches, generateNewTransferID, get, getAllServerClientConfigs, getAutoDetectData, getBlastRate, getCachedPWD, getClientAgentID, getClientIdentifier, getClientString, getClientSubIdentifier, getCompLevel, getCompMethod, getCompStrategy, getCongestionControlAggression, getCurrentFileToIDs, getCurrentGoodputRate, getCurrentRTT, getDataPort, getDone, getDone, getErrorMessage, getFCClientObject, getHashCode, getIdealConcurrentFTPStreams, getIsTransferringData, getLastReplyText, getLastThroughtput, getLastValidReply, getLogger, getMD5, getMeanEffectiveRate, getMonitoredTransfer, getNumFTPStreams, getNumUDPSockets, getPacketLoss, getPlatForm, getRemoteServiceVersion, getReporter, getReportManager, getReportStatus, getServerAgentID, getServerConfigurationValue, getServerLinkExpiryDayValue, getServerVersion, getServletLocation, getSessionCount, getSessionID, getSpeedcache, getStartRate, getTaskID, getTransferGoodput, getTransferID, getTransferLength, getTransferMetrics, getTransferPercent, getTransferRate, getTransferSettings, getTransferThroughput, getTransmitZipRatio, getUserEmail, getUserFullName, getUserPermissions, getVersionForSetup, getWelcomeMessage, gobbleExtraReplies, hasAutoDetectData, hasReporter, help, initAES, initFCTransfer, initSOCKS, initSOCKSAuthentication, innerZipChunkTest, isAborted, isAllowConnectNonFileCatalystServer, isChannelClosed, isComplete, isCongestionControl, isConnected, isFileCatalystServer, isFileCatalystServerEnterprise, isFileCatalystServerPro, isForceTCPmodeACKs, isLinkEnabledOnServer, isLoggedIn, isProgressiveTransfer, isQuitting, isReportingEnabled, isServerBandwidthOverride, isTimeout, isTransferComplete, isTransferError, isUseCompression, lastServerRestrictedRate, lastValidReply, lastValidReply, log, log, monitorIsNull, notifyServerOfCurrentRTT, numFTPStreams, numFTPStreams, overrideSessionID, putDone, putDone, putIsFinished, quit, readTimeout, readTimeout, reconnect, refreshCachedPWD, registerReportListener, remoteServiceVersion, remoteSynchFile, resetTransferVariables, sendJobStatus, sendRTTKeepALive, serverSupportsFSEvents, serverSupportsUDP, setAutoDetectData, setBandwidthFTPReceiver, setBandwidthFTPTransmit, setBandwidthRemoteTransfer, setBandwidthUDPSender, setBandwidthUPDReceiver, setClientAgentID, setClientIdentifier, setClientName, setClientString, setClientSubIdentifier, setClientWorkingPath, setCompLevel, setCompMethod, setCompStrategy, setCongestionControl, setCongestionControlAggression, setConnectMode, setCurrentFilesMatch, setCurrentFileToIDs, setDataPort, setDownloadRate, setErrorMessage, setForceTCPmodeACKs, setHttp, setLastValidReply, setLogStream, setMaxRate, setMaxServerRate, setMonitoredTransfer, setNumFTPStreams, setNumUDPSockets, setOverrideServerBandwidth, setProgressiveTransfer, setQuitting, setReadTimeout, setReadTimeoutLong, setReportManager, setServletLocation, setSessionPriority, setSslSocketProducer, setStartRate, setTaskID, setTransferID, setTransferSettings, setUDPTransferMetrics, setUseCompression, setUserEmail, setUserFullName, setVerifyMode, setWelcomeMessage, shouldPerformServerPostProcess, streamWithInlineParse, streamWithInlineParse, streamWithInlineParse, streamWithInlineParse, syncFileType, system, testDataConnection, testDataConnection, testIncomingUDP, testMultiDataConnection, testOutgoingUDP, testUDPACKs, update, updateReportWriter, validateLinkDataContainer, waitingForAbortAck, zip, zip, zipErrors

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FCClientEngineHTTP

public FCClientEngineHTTP(java.lang.String host,
                          int port,
                          java.lang.String serfoLocation,
                          LogUtils log)
                   throws java.io.IOException

Throws:

java.io.IOException

FCClientEngineHTTP

public FCClientEngineHTTP(java.lang.String host,
                          int port,
                          java.lang.String serfoLocation,
                          java.lang.String sid,
                          LogUtils log)
                   throws java.io.IOException

Throws:

java.io.IOException

FCClientEngineHTTP

public FCClientEngineHTTP(java.lang.String host,
                          int port,
                          java.lang.String serfoLocation,
                          java.lang.String sid,
                          LogUtils log,
                          boolean isPrintSolution)
                   throws java.io.IOException

Throws:

java.io.IOException

Method Detail

getComLock

public java.lang.Object getComLock()

Overrides:

getComLock in class FCClientEngine

getSystKey

protected java.lang.String getSystKey()

Overrides:

getSystKey in class FCClientEngine

noop

public void noop()
          throws FCException,
                 java.io.IOException

Description copied from class: FCClientEngine

Send a NOOP command

Overrides:

noop in class FCClientEngine

Throws:

FCException

java.io.IOException

pwd

public java.lang.String pwd()
                     throws FCException,
                            java.io.IOException

Description copied from class: FCClientEngine

Get the current remote working directory

Overrides:

pwd in class FCClientEngine

Returns:

the current working directory

Throws:

FCException

java.io.IOException

put

public void put(UploadTransferRequestData data)
         throws java.io.IOException,
                FCException

Put a local file onto the FileCatalyst server. It is placed in the current directory. Allows appending if current file exists

Overrides:

put in class FCClientEngine

Parameters:

localPath - path of the local file

remoteFile - name of remote file in current directory

outRate - sending bandwidth

numDFEncoders - number of DF encoders to be used

append - true if appending, false otherwise

Throws:

java.io.IOException

FCException

getIdealTransferMode

protected int getIdealTransferMode(int rate,
                                   long length)

putHTTP

protected void putHTTP(java.nio.file.Path file,
                       java.lang.String remoteFile,
                       long sfSize,
                       long offset,
                       boolean append,
                       int targetBandwidth)
                throws java.io.IOException,
                       FCException,
                       java.io.IOException

Throws:

java.io.IOException

FCException

moveFilesToServer

public void moveFilesToServer(java.lang.String remoteFile)
                       throws FCException,
                              java.io.IOException

Throws:

FCException

java.io.IOException

getHTTP

public void getHTTP(DownloadTransferRequestData requestData)
             throws java.io.IOException,
                    FCException,
                    java.io.IOException

Overrides:

getHTTP in class FCClientEngine

Throws:

java.io.IOException

FCException

getLocalHost

protected java.lang.String getLocalHost()

Overrides:

getLocalHost in class FCClientEngine

Returns:

getRemoteHost

protected java.lang.String getRemoteHost()

Overrides:

getRemoteHost in class FCClientEngine

Returns:

size

public java.lang.String size(java.lang.String fileName)
                      throws java.io.IOException,
                             FCException

Throws:

java.io.IOException

FCException

size

public java.lang.String size(java.lang.String fileName,
                             boolean bypassCache)
                      throws java.io.IOException,
                             FCException

Description copied from class: FCClientEngine

Get the size of the named file from the remote server.

Overrides:

size in class FCClientEngine

Parameters:

fileName - name of the file

Returns:

the size of the file

Throws:

java.io.IOException

FCException

cdup

public void cdup()
          throws java.io.IOException,
                 FCException

Description copied from class: FCClientEngine

Change to the parent directory

Overrides:

cdup in class FCClientEngine

Throws:

java.io.IOException

FCException

chdir

public void chdir(java.lang.String dir)
           throws java.io.IOException,
                  FCException

Description copied from class: FCClientEngine

Change the remote working directory to that supplied

Overrides:

chdir in class FCClientEngine

Parameters:

dir - name of remote directory to change to

Throws:

java.io.IOException

FCException

deleteAll

public void deleteAll(java.util.List<java.lang.String> remoteFiles)
               throws java.io.IOException,
                      FCException

Description copied from class: FCClientEngine

Bulk delete, deletes all the specified files in a single command. The server returns intermediate replies to keep the connection alive during a long delete

Overrides:

deleteAll in class FCClientEngine

Parameters:

remoteFiles - files to delete

Throws:

java.io.IOException

FCException

deleteAll

public void deleteAll(FileListData remoteFiles,
                      boolean ftpDelete)
               throws FCException,
                      java.io.IOException

Overrides:

deleteAll in class FCClientEngine

Throws:

FCException

java.io.IOException

delete

public void delete(java.lang.String remoteFile)
            throws java.io.IOException,
                   FCException

Description copied from class: FCClientEngine

Delete the specified remote file

Overrides:

delete in class FCClientEngine

Parameters:

remoteFile - name of remote file to delete

Throws:

java.io.IOException

FCException

setup

public void setup(java.util.function.Supplier<ClientCredentials> credentials)
           throws java.io.IOException,
                  FCException

Description copied from class: FCClientEngine

Login into an account on the FileCatalyst server. This call completes the entire login process Note that we only use the User/Pass if we haven't set the tokens on this client. If we have tokens we call that method.

Overrides:

setup in class FCClientEngine

Throws:

java.io.IOException

FCException

detectFCServer

public void detectFCServer()
                    throws java.io.IOException,
                           FCException

Overrides:

detectFCServer in class FCClientEngine

Throws:

java.io.IOException

FCException

mkdir

public void mkdir(java.lang.String dir)
           throws java.io.IOException,
                  FCException

Description copied from class: FCClientEngine

Create the specified remote working directory

Overrides:

mkdir in class FCClientEngine

Throws:

java.io.IOException

FCException

rmdir

public void rmdir(java.lang.String dir)
           throws java.io.IOException,
                  FCException

Description copied from class: FCClientEngine

Delete the specified remote working directory

Overrides:

rmdir in class FCClientEngine

Parameters:

dir - name of remote directory to delete

Throws:

java.io.IOException

FCException

rmdirRecursive

public void rmdirRecursive(FileListDataItem item)
                    throws FCException,
                           java.io.IOException

Recursively delete a remote folder

Overrides:

rmdirRecursive in class FCClientEngine

Parameters:

item -

Throws:

java.io.IOException

FCException

java.lang.Exception

fileSystemEvents

public java.util.ArrayList<FileSystemEvent> fileSystemEvents(long timeout)
                                                      throws java.io.IOException,
                                                             FCException

Get a list of file system events from the server

Overrides:

fileSystemEvents in class FCClientEngine

Returns:

String a list of file system events from the server

Throws:

java.io.IOException

FCException

rename

public void rename(java.lang.String from,
                   java.lang.String to)
            throws java.io.IOException,
                   FCException

Description copied from class: FCClientEngine

Rename a file or directory

Overrides:

rename in class FCClientEngine

Parameters:

from - name of file or directory to rename

to - intended name

Throws:

java.io.IOException

FCException

site

public boolean site(java.lang.String command)
             throws java.io.IOException,
                    FCException

Description copied from class: FCClientEngine

Run a site-specific command on the server. Support for commands is dependent on the server

Overrides:

site in class FCClientEngine

Parameters:

command - the site command to run

Returns:

true if command ok, false if command not implemented

Throws:

java.io.IOException

FCException

quit

public void quit()
          throws java.io.IOException,
                 FCException

Description copied from class: FCClientEngine

Quit the FileCatalyst session

Overrides:

quit in class FCClientEngine

Throws:

java.io.IOException

FCException

quote

public void quote(java.lang.String command,
                  java.lang.String[] validCodes)
           throws java.io.IOException,
                  FCException

Description copied from class: FCClientEngine

Issue arbitrary FileCatalyst commands to the FileCatalyst server.

Overrides:

quote in class FCClientEngine

Parameters:

command - command to be sent to server

validCodes - valid return codes for this command

Throws:

java.io.IOException

FCException

mkfile

public void mkfile(java.lang.String file)
            throws java.io.IOException,
                   FCException

Description copied from class: FCClientEngine

Create the specified remote working directory

Overrides:

mkfile in class FCClientEngine

Throws:

java.io.IOException

FCException

filter

public void filter(FileCatalystFileFilter<?> filter)
            throws java.io.IOException

Description copied from class: FCClientEngine

Initializes the file filter on the server. This filter is applied to the next listing that is requested from the server. It is immediately reset by the server after each listing. Therefore it should be reset each time a listing is done if needed.

Overrides:

filter in class FCClientEngine

Parameters:

filter - Filter object containing the data that you wish to filter on

Throws:

java.io.IOException

filter

public void filter(long olderThan,
                   long newerThan,
                   long upperByteLimit,
                   long lowerByteLimit,
                   java.lang.String filterString,
                   int filterMode,
                   boolean applyFilterToDirectories)
            throws java.io.IOException,
                   FCException

Initializes the file filter on the server. THis filter is applied to the next listing that is requested from the server. It is immediately reset by the server after each listing. Therefore it should be reset each time a listing is done if needed.

Overrides:

filter in class FCClientEngine

Parameters:

olderThan -

newerThan -

upperByteLimit -

lowerByteLimit -

filterString -

filterMode -

Throws:

java.io.IOException

FCException*

FCException

mksig

public java.lang.String mksig(java.lang.String srcfile,
                              java.lang.String uniqueID)
                       throws java.io.IOException,
                              FCException

Overrides:

mksig in class FCClientEngine

Throws:

java.io.IOException

FCException

mksig

public java.lang.String mksig(java.lang.String srcfile,
                              boolean compress,
                              java.lang.String uniqueID)
                       throws java.io.IOException,
                              FCException

Overrides:

mksig in class FCClientEngine

Parameters:

srcfile - String Name of the source file.

compress - boolean Compress flag for the signature. Default false (value currently ignored in v2.4.2)

uniqueID - String Unique identifier for the delta transfer

Returns:

String reply from target. if target < v2.4.2 will return: block size if target >= v2.4.2 will return: block size + " " + "unique file name"

Throws:

java.io.IOException

FCException

mkdlt

public void mkdlt(java.lang.String srcfile,
                  java.lang.String sigfile,
                  int blockLength,
                  boolean compress,
                  int compLevel,
                  int strategy)
           throws java.io.IOException,
                  FCException

Called by ReceiverHandler to create a delta file remotely. Legacy call -- pre v2.4.2. Does not include a UNIQUEID, so multiple concurrent delta calculations on the same file may corrupt it.

Overrides:

mkdlt in class FCClientEngine

Parameters:

srcfile - String

sigfile - String

blockLength - int

compress - boolean

compLevel - int

strategy - int

Throws:

java.io.IOException

FCException

mkdlt

public void mkdlt(java.lang.String srcfile,
                  java.lang.String sigfile,
                  int blockLength,
                  boolean compress,
                  int compLevel,
                  int strategy,
                  java.lang.String uniqueID,
                  boolean waitForDeltaCreation)
           throws java.io.IOException,
                  FCException

Called by ReceiverHandler to create a delta file remotely. Uses UNIQUEID, to allow concurrent deltas to be created on the same file. v2.4.2+.

Overrides:

mkdlt in class FCClientEngine

Parameters:

srcfile - String

sigfile - String

blockLength - int

compress - boolean

compLevel - int

strategy - int

uniqueID - String

Throws:

java.io.IOException

FCException

rbfil

public java.lang.String rbfil(java.lang.String srcfile,
                              java.lang.String deltafile,
                              int blockLength,
                              boolean compress,
                              int level,
                              boolean uniqueName)
                       throws java.io.IOException,
                              FCException

Overrides:

rbfil in class FCClientEngine

Parameters:

srcfile -

deltafile -

blockLength - int

compress - boolean

level - int

uniqueName - boolean

Returns:

String The remote filename, may be the original destination, or a unique name.

Throws:

java.io.IOException

FCException

setTimeout

public void setTimeout(int millis)
                throws java.net.SocketException

Throws:

java.net.SocketException

getMD5

public java.lang.String getMD5(java.lang.String remoteFile,
                               long offset,
                               long length)
                        throws java.io.IOException,
                               FCException

Request the MD5 digest of the remote file

Overrides:

getMD5 in class FCClientEngine

Parameters:

remoteFile - name of remote file to delete

Throws:

java.io.IOException

FCException

prms

public java.lang.String[] prms(java.lang.String fileName)
                        throws java.io.IOException,
                               FCException

Description copied from class: FCClientEngine

Return the file permission of the file/directory listed in the argument from the remote server.

Overrides:

prms in class FCClientEngine

Parameters:

fileName - name of the file

Returns:

permissions

Throws:

java.io.IOException

FCException

getMD5

public java.lang.String getMD5(java.lang.String remoteFile)
                        throws java.io.IOException,
                               FCException

Description copied from class: FCClientEngine

Request the MD5 digest of the remote file

Overrides:

getMD5 in class FCClientEngine

Parameters:

remoteFile - name of remote file to delete

Throws:

java.io.IOException

FCException

performSyncedMD5

protected java.lang.String performSyncedMD5(java.lang.String md5Command)
                                     throws java.io.IOException,
                                            FCException

Overrides:

performSyncedMD5 in class FCClientEngine

Throws:

java.io.IOException

FCException

performAsyncMD5

protected java.lang.String performAsyncMD5(java.lang.String md5Command)
                                    throws java.io.IOException

Overrides:

performAsyncMD5 in class FCClientEngine

Throws:

java.io.IOException

serverPostProcess

public void serverPostProcess(java.lang.String file)
                       throws java.io.IOException,
                              FCException

Description copied from class: FCClientEngine

Execute post processing on the specified file

Overrides:

serverPostProcess in class FCClientEngine

Parameters:

file - The file on which to perform post processing

Throws:

java.io.IOException

FCException

modtime

public void modtime(java.lang.String remoteFile,
                    java.util.Date d)
             throws java.io.IOException,
                    FCException

Description copied from class: FCClientEngine

Set modification time for a remote file

Overrides:

modtime in class FCClientEngine

Parameters:

remoteFile - name of remote file

Throws:

java.io.IOException

FCException

modtime

public java.util.Date modtime(java.lang.String remoteFile)
                       throws java.io.IOException,
                              FCException

Description copied from class: FCClientEngine

Get modification time for a remote file

Overrides:

modtime in class FCClientEngine

Parameters:

remoteFile - name of remote file

Returns:

modification time of file as a date

Throws:

java.io.IOException

FCException

modtime

public java.util.Date modtime(java.lang.String remoteFile,
                              boolean bypassCache)
                       throws java.io.IOException,
                              FCException

Get modification time for a remote file

Overrides:

modtime in class FCClientEngine

Parameters:

remoteFile - name of remote file

Returns:

modification time of file as a date

Throws:

java.io.IOException

FCException

isHttp

public boolean isHttp()

should be overridden in FCClientEngineHTTP and return true

Overrides:

isHttp in class FCClientEngine

Returns:

innerSyst

public java.lang.String innerSyst()
                           throws java.io.IOException,
                                  FCException

Overrides:

innerSyst in class FCClientEngine

Throws:

java.io.IOException

FCException

setBandwidth

public int setBandwidth(int bandwidth)

Overrides:

setBandwidth in class FCClientEngine

cancelTransfer

public boolean cancelTransfer()

Description copied from class: FCClientEngine

Cancels the current transfer, if one is occurring

Overrides:

cancelTransfer in class FCClientEngine

isTransferCancelled

public boolean isTransferCancelled()

Overrides:

isTransferCancelled in class FCClientEngine

Returns:

true if a transfer was cancelled

getDirListTool

protected DirListTool getDirListTool(DirListParams p,
                                     FCClientEngine e)
                              throws FCException,
                                     java.io.IOException

Overrides:

getDirListTool in class FCClientEngine

Throws:

FCException

java.io.IOException

doDirStream

public java.util.stream.Stream<FileListDataItem> doDirStream(DirListParams params)
                                                      throws FCException,
                                                             java.io.IOException,
                                                             java.net.SocketException,
                                                             java.io.UnsupportedEncodingException

Overrides:

doDirStream in class FCClientEngine

Throws:

FCException

java.io.IOException

java.net.SocketException

java.io.UnsupportedEncodingException

isServerTimeout

public boolean isServerTimeout()
                        throws FCException

Overrides:

isServerTimeout in class FCClientEngine

Throws:

FCException

zip

public void zip(java.lang.String zipFilename,
                java.util.List remoteFiles,
                long zipSizeLimit,
                boolean waitForZipCreation,
                boolean needsRecurse)
         throws java.io.IOException,
                FCException

Overrides:

zip in class FCClientEngine

Throws:

java.io.IOException

FCException

isDeltasStillGrowing

public boolean isDeltasStillGrowing()
                             throws FCException,
                                    java.io.IOException

Overrides:

isDeltasStillGrowing in class FCClientEngine

Throws:

FCException

java.io.IOException

isZipStillGrowing

public boolean isZipStillGrowing(java.lang.String zipFileName)
                          throws FCException,
                                 java.io.IOException

Overrides:

isZipStillGrowing in class FCClientEngine

Throws:

FCException

java.io.IOException

isZipStillExtracting

public boolean isZipStillExtracting()
                             throws FCException,
                                    java.io.IOException

Overrides:

isZipStillExtracting in class FCClientEngine

Throws:

FCException

java.io.IOException

unzip

public void unzip(java.lang.String remoteFile,
                  boolean maintainPermissions,
                  boolean maintainTimeStamp)
           throws java.io.IOException,
                  FCException

Description copied from class: FCClientEngine

Request that a file on the server be unzipped

Overrides:

unzip in class FCClientEngine

Parameters:

remoteFile - name of remote file to unzip

Throws:

java.io.IOException

FCException

sendEmail

public void sendEmail(java.lang.String emailAddress,
                      int statusCode,
                      java.lang.String note)
               throws java.io.IOException,
                      FCException

Instruct the server to send an email to the administrator

Overrides:

sendEmail in class FCClientEngine

Parameters:

email - the senders email address

code - the constant code representing the transfer status

Throws:

java.io.IOException

FCException

getServletMultiplier

public int getServletMultiplier()

setServletMultiplier

public void setServletMultiplier(int servletMultiplier)

reconnect

public void reconnect()
               throws FCException,
                      java.io.IOException

Throws:

FCException

java.io.IOException

getCurrentRate

public int getCurrentRate()

Overrides:

getCurrentRate in class FCClientEngine

getIsPrintSolution

public boolean getIsPrintSolution()

setIsPrintSolution

public void setIsPrintSolution(boolean isPrintSolution)

testApproximateUploadSpeed

public int testApproximateUploadSpeed()
                               throws FCException,
                                      java.io.IOException

Description copied from class: FCClientEngine

Performs a quick test to determine the approximate upload speed to the connected server.

Overrides:

testApproximateUploadSpeed in class FCClientEngine

Returns:

int the rate detected in Kbps

Throws:

FCException

java.io.IOException

testApproximateDownloadSpeed

public int testApproximateDownloadSpeed()
                                 throws FCException,
                                        java.io.IOException

Description copied from class: FCClientEngine

Performs a quick test to determine the approximate download speed to the connected server.

Overrides:

testApproximateDownloadSpeed in class FCClientEngine

Returns:

int the rate detected in Kbps

Throws:

FCException

java.io.IOException

testMaximumUploadSpeed

public int testMaximumUploadSpeed()
                           throws FCException,
                                  java.io.IOException

Description copied from class: FCClientEngine

Performs a quick test to determine the approximate upload speed to the connected server.

Overrides:

testMaximumUploadSpeed in class FCClientEngine

Returns:

int the rate detected in Kbps

Throws:

FCException

java.io.IOException

testMaximumDownloadSpeed

public int testMaximumDownloadSpeed()
                             throws FCException,
                                    java.io.IOException

Description copied from class: FCClientEngine

Performs a quick test to determine the approximate download speed to the connected server.

Overrides:

testMaximumDownloadSpeed in class FCClientEngine

Returns:

int the rate detected in Kbps

Throws:

FCException

java.io.IOException

remoteTransferInitiate

public void remoteTransferInitiate(ServerToServerTransferSettings settings)
                            throws java.io.IOException,
                                   FCException

Description copied from class: FCClientEngine

Initiate a

Overrides:

remoteTransferInitiate in class FCClientEngine

Throws:

FCException

java.io.IOException

createPatch

public java.lang.String createPatch(java.lang.String remoteFile,
                                    long offset,
                                    long length)
                             throws java.io.IOException,
                                    FCException

Creates a new patch file on the remote server that contains the bytes from offset to offeset+length of remoteFile

Overrides:

createPatch in class FCClientEngine

Parameters:

remoteFile -

offset -

length -

Returns:

Throws:

java.io.IOException

FCException

applyPatch

public void applyPatch(java.lang.String remoteFile,
                       java.lang.String remotePatch,
                       long offset)
                throws java.io.IOException,
                       FCException

Applies a patch file on the remote server to the specified file at the specified offset

Overrides:

applyPatch in class FCClientEngine

Parameters:

remoteFile -

remotePatch -

offset -

Throws:

java.io.IOException

FCException

remoteTransferStatus

public java.lang.String remoteTransferStatus()
                                      throws FCException,
                                             java.io.IOException

Overrides:

remoteTransferStatus in class FCClientEngine

Throws:

FCException

java.io.IOException

sendWeblink

public WeblinkResult sendWeblink(WeblinkDataContainer linkDO)
                          throws FCException,
                                 java.io.IOException

Description copied from class: FCClientEngine

Creates A Weblink From The Data Container Given

Overrides:

sendWeblink in class FCClientEngine

Parameters:

linkDO - - Data Container Containing Data For The Link

Throws:

FCException

java.io.IOException

sendTransmitRateCommand

protected void sendTransmitRateCommand(int targetRate,
                                       int startRate)
                                throws java.io.IOException

Overrides:

sendTransmitRateCommand in class FCClientEngine

Throws:

java.io.IOException

isSSL

public boolean isSSL()

getForceFileOwnerConfig

public ForceFileOwnershipConfig getForceFileOwnerConfig()

Overrides:

getForceFileOwnerConfig in class FCClientEngine

setForceFileOwnerConfig

public void setForceFileOwnerConfig(ForceFileOwnershipConfig forceOwnerConfig)

informServerToWriteReport

protected void informServerToWriteReport(PropertyTransmission reportArgs)

Overrides:

informServerToWriteReport in class FCClientEngine