public class XferParams extends Object
Modifier and Type | Field and Description |
---|---|
AclOption |
aclOption
Specify ACLs preservation modes (local and remote)
|
Path |
alternateConfigFile |
boolean |
applyLocalDocroot
Apply a local docroot for the local paths.
|
boolean |
autoDetectCapacity
Deprecated.
|
String |
checkSshFingerprint
Specify a fingerprint (e.g.
|
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 |
boolean |
deleteBeforeTransfer
Delete all extraneous files from the destination folder before any file is transferred.
|
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
Exclude files from the transfer based on when the file was last changed.
|
Integer |
excludeOlderThan
Exclude files from the transfer based on when the file was last changed.
|
List<String> |
excludePatterns
List of patterns (maximum 16) used to exclude files from transferring.
|
ExtendedAttributesOption |
extendedAttributesOption
Specify Extended Attributes preservation modes (local and remote)
|
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.
|
boolean |
ignoreSshFingerprint
Ignore server SSH host key fingerprint when initiating the transfer session.
|
List<String> |
includePatterns
List of patterns (maximum 16) used to include files for transfer.
|
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.
|
String |
moveAfterTransferPath
Move transferred files to this location after transfer success
|
long |
multiSessionThreshold
This value, if set, is used to skip multi-session if file size
is less than this threshold
|
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 |
preserveAccessTime
Preserve access time.
|
boolean |
preserveCreationTime
Preserve creation time.
|
boolean |
preserveDates
Preserve file date attributes.
|
boolean |
preserveFileOwnerGID
Preserve file owner GID.
|
boolean |
preserveFileOwnerUID
Preserve file owner UID.
|
boolean |
preserveModificationTime
Preserve modification time.
|
boolean |
preserveSourceAccessTime
Preserve source access time.
|
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 |
removeEmptySourceDirectory
Remove the source directory itself if empty.
|
boolean |
removeFileAfterTransfer
Remove source files after transferring.
|
boolean |
reportSkippedFiles
Include skipped files in the transfer information report.
|
Resume |
resumeCheck
Resume policy for partially transferred files.
|
Integer |
retransmissionRequestMaxSize |
int |
retryTimeoutS
Informs any monitoring applications how long you intend to retry.
|
boolean |
saveBeforeOverwriteEnabled
If a transfer would result in an existing file <filename>.<ext> being overwritten, move that file
to <filename>.yyyy.mm.dd.hh.mm.ss.index.<ext> (where index is set to 1 at the beginning of each new second
and incremented for each file saved in this manner during the same second) in the same directory before
writing the new file.
|
boolean |
skipDuplicateCheck
Do not check for duplicate files in the directory scan..
|
boolean |
skipSpecialFiles
Skip special files.
|
String |
sourceBase
Specify the prefix to be stripped off from each source object.
|
String |
sourceRoot
Specify the root path of the transfers.
|
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() |
protected List<String> |
getExtendedParameters()
Allow to extend the current list of parameters supported by the FaspManager through
XferParams . |
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 String sourceRoot
If this option is used, implementers must make sure that all specified source paths are relative to this defined source root path.
public int readSize
public int writeSize
public List<String> excludePatterns
public List<String> includePatterns
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 boolean ignoreSshFingerprint
public boolean applyLocalDocroot
public long multiSessionThreshold
public boolean removeEmptySourceDirectory
public boolean deleteBeforeTransfer
public Integer retransmissionRequestMaxSize
public HTTPFallback httpFallback
public String moveAfterTransferPath
public boolean preserveAccessTime
public boolean preserveModificationTime
public boolean preserveSourceAccessTime
public boolean preserveCreationTime
public boolean skipDuplicateCheck
public AclOption aclOption
public ExtendedAttributesOption extendedAttributesOption
public boolean reportSkippedFiles
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()
protected List<String> getExtendedParameters()
XferParams
.
This is for used only for developers with consistent experience with FaspManager. Refer to Aspera for support. Example
class ExtendedXferParams extends XferParams {
@Override
protected List<String> getExtendedParameters() {
return Arrays.asList(new String[] {"--no-read", "--no-write"});
}
}
XferParams p = new ExtendedXferParams();
p.tcpPort = 22;
p.udpPort = 33001;
public Version getVersion()
Copyright © 2017 Aspera Inc.. All rights reserved.