public class XferParams extends Object
Modifier and Type | Field and Description |
---|---|
Path |
alternateConfigFile |
boolean |
autoDetectCapacity
Deprecated.
|
String |
checkSshFingerprint |
ContentProtection |
contentProtection
Deprecated.
|
String |
contentProtectionPass
Content protection passphrase.
|
String |
cookie
An arbitrary field used for application-specific requirements.
|
boolean |
createPath
Create target directory if it doesn't already exist.
|
int |
datagramSize
Specify the datagram size (MTU) for fasp to use.
|
static String |
DEFAULT_DESTINATION_ROOT |
DeleteSource |
deleteSource
Deprecated.
use XferParams.removeFileAfterTransfer and/or XferParams.removeEmptyDirectories
|
String |
destinationRoot
Specify the destination root directory of the transfers.
|
Encryption |
encryption
Specify the encryption cipher to use.
|
Integer |
excludeNewerThan |
Integer |
excludeOlderThan |
List<String> |
excludePatterns
List of patterns (maximum 16) used to exclude files from transferring.
|
FaspProxy |
faspProxy
Specify a FASP proxy if the transfer is going through a Fasp proxy.
|
Version |
faspVersion
The fasp version.
|
HashAlgorithm |
fileChecksum
File checksum method
Usage is:
|
Manifest |
generateManifest
Generate a manifest file to log the transfer.
|
HTTPFallback |
httpFallback
Specify to use HTTP protocol to conduct the transfer when UDP connection fails.
|
String |
license
License to use for this transfer
|
String |
localLogDir
Specify a directory to write the log file in for the local host, instead of using the default directory.
|
String |
manifestDirectory
Directory where the manifest should be generated.
|
int |
minimumRateKbps
The minimum transfer rate in Kbps.
|
int |
minimumRatePercent
Deprecated.
|
Overwrite |
overwrite
Policy to overwrite files that already exist at the destination.
|
String |
partialFileSuffix |
boolean |
persist
When set to true the transfer is launched in persistent mode.
|
Policy |
policy
Transfer rate policy.
|
boolean |
preCalculateJobSize
Pre-calculate and report the total job size.
|
String |
prePostCommand |
boolean |
preserveDates
Preserve file date attributes.
|
boolean |
preserveFileOwnerGID
Preserve file owner GID.
|
boolean |
preserveFileOwnerUID
Preserve file owner UID.
|
int |
readSize
Read block size in bytes.
|
String |
remoteLogDir
Specify a directory to write the log file in for the local host, instead of using the default directory.
|
boolean |
removeEmptyDirectories
Remove source empty directories after transferring.
|
boolean |
removeFileAfterTransfer
Remove source files after transferring.
|
Resume |
resumeCheck
Resume policy for partially transferred files.
|
Integer |
retransmissionRequestMaxSize |
int |
retryTimeoutS
Informs any monitoring applications how long you intend to retry.
|
boolean |
saveBeforeOverwriteEnabled |
boolean |
skipSpecialFiles
Skip special files.
|
String |
sourceBase
Specify the prefix to be stripped off from each source object.
|
SymLinkPolicy |
symLinkPolicy
How symbolic links are handled.
|
com.google.gson.JsonObject |
tags |
int |
targetRateKbps
The target transfer rate in kbps.
|
int |
targetRatePercent
Deprecated.
|
int |
tcpPort
The TCP port used for transfer initialization.
|
String |
token
Security token.
|
int |
udpPort
The UDP port used for transferring data.
|
protected String |
validationError
Error string describing the error found in validation.
|
int |
writeSize
Write block size in bytes.
|
Constructor and Description |
---|
XferParams() |
Modifier and Type | Method and Description |
---|---|
protected com.google.gson.JsonObject |
appendToAsperaTags() |
protected List<AscpParameter> |
buildCommandLineParams(Mode mode,
UUID xferId) |
protected List<AscpParameter> |
buildCommandLineParams(Mode mode,
UUID xferId,
int xferRetry) |
String |
getDestinationRoot() |
Version |
getVersion() |
@Deprecated public boolean autoDetectCapacity
public String cookie
public int datagramSize
public Encryption encryption
public Version faspVersion
public Manifest generateManifest
public String license
public String localLogDir
public String manifestDirectory
public int minimumRateKbps
@Deprecated public int minimumRatePercent
public Policy policy
public String remoteLogDir
public int retryTimeoutS
public int targetRateKbps
@Deprecated public int targetRatePercent
public int tcpPort
public String token
public int udpPort
protected String validationError
@Deprecated public ContentProtection contentProtection
public String contentProtectionPass
public boolean createPath
@Deprecated public DeleteSource deleteSource
DeleteSource.OFF
public boolean removeFileAfterTransfer
public boolean removeEmptyDirectories
public boolean skipSpecialFiles
public boolean preserveFileOwnerUID
public boolean preserveFileOwnerGID
public String destinationRoot
public int readSize
public int writeSize
public List<String> excludePatterns
public Overwrite overwrite
Overwrite.DIFFERENT
public boolean persist
public boolean preCalculateJobSize
public boolean preserveDates
public SymLinkPolicy symLinkPolicy
public Resume resumeCheck
public String sourceBase
public FaspProxy faspProxy
public HashAlgorithm fileChecksum
XferParams params = new XferParams(); params.fileChecksum = HashAlgorithm.MD5;to enable MD5 checksum generation for the transfer.
public com.google.gson.JsonObject tags
public String prePostCommand
public Path alternateConfigFile
public String partialFileSuffix
public Integer excludeNewerThan
public Integer excludeOlderThan
public boolean saveBeforeOverwriteEnabled
public String checkSshFingerprint
public Integer retransmissionRequestMaxSize
public HTTPFallback httpFallback
public static final String DEFAULT_DESTINATION_ROOT
public String getDestinationRoot()
protected List<AscpParameter> buildCommandLineParams(Mode mode, UUID xferId)
protected List<AscpParameter> buildCommandLineParams(Mode mode, UUID xferId, int xferRetry)
protected com.google.gson.JsonObject appendToAsperaTags()
public Version getVersion()
Copyright © 2015 Aspera Inc.. All rights reserved.