- generateManifest - Variable in class com.asperasoft.faspmanager.XferParams
-
Generate a manifest file to log the transfer.
- getBandwidthCapKbps() - Method in class com.asperasoft.faspmanager.SessionStats
-
Bandwidth cap
- getByteRange() - Method in class com.asperasoft.faspmanager.RemoteLocation
-
- getChannels(SelectHandler) - Method in class com.asperasoft.faspmanager.util.SelectThread
-
Find all channels associated with this handler
- getClient() - Method in class com.asperasoft.faspmanager.TransferOrder
-
Get the client, who initiated the transfer.
- getClientClusterId() - Method in class com.asperasoft.faspmanager.SessionStats
-
- getClientNodeId() - Method in class com.asperasoft.faspmanager.SessionStats
-
- getCommandLineOption() - Method in enum com.asperasoft.faspmanager.ContentProtection
-
Deprecated.
- getCommandLineOption() - Method in enum com.asperasoft.faspmanager.Manifest
-
- getCommandLineOption() - Method in enum com.asperasoft.faspmanager.Overwrite
-
- getCommandLineOption() - Method in enum com.asperasoft.faspmanager.Policy
-
- getContiguousBytes() - Method in class com.asperasoft.faspmanager.FileInfo
-
No of contiguous bytes of this file at the destination.
- getCookie() - Method in class com.asperasoft.faspmanager.SessionStats
-
The cookie
- getCustomerId() - Method in class com.asperasoft.faspmanager.License
-
- getDelayMs() - Method in class com.asperasoft.faspmanager.SessionStats
-
Network delay
- getDescription() - Method in enum com.asperasoft.faspmanager.Overwrite
-
- getDescription() - Method in enum com.asperasoft.faspmanager.Policy
-
- getDescription() - Method in enum com.asperasoft.faspmanager.Resume
-
- getDescription() - Method in enum com.asperasoft.faspmanager.SymLinkPolicy
-
- getDescription() - Method in enum com.asperasoft.faspmanager.TransferEvent
-
- getDestination() - Method in class com.asperasoft.faspmanager.TransferOrder
-
Get the destination location, where data is transferred to.
- getDestinationRoot() - Method in class com.asperasoft.faspmanager.XferParams
-
- getDestPath() - Method in class com.asperasoft.faspmanager.SessionStats
-
Destination Path
- getDirection() - Method in class com.asperasoft.faspmanager.SessionStats
-
Transfer direction
- getElapsedUSec() - Method in class com.asperasoft.faspmanager.SessionStats
-
Time elapsed since the start of transfer
- getEncryption() - Method in class com.asperasoft.faspmanager.SessionStats
-
Encryption parameter
- getEnd() - Method in class com.asperasoft.faspmanager.ByteRange
-
- getErrorCode() - Method in class com.asperasoft.faspmanager.SessionStats
-
Error Code
- getErrorDescription() - Method in class com.asperasoft.faspmanager.SessionStats
-
Error description
- getErrorOutput() - Method in class com.asperasoft.faspmanager.util.ErrorStreamHandler
-
- getExpirationDate() - Method in class com.asperasoft.faspmanager.License
-
- getFasp2AscpPath() - Static method in class com.asperasoft.faspmanager.Environment
-
Gets the path to the fasp2 ascp binary.
- getFaspVersion() - Static method in class com.asperasoft.faspmanager.Environment
-
Find the version of ascp being used by Fasp Manager.
- getFileChecksum() - Method in class com.asperasoft.faspmanager.FileInfo
-
The file checksum
- getFileChecksumType() - Method in class com.asperasoft.faspmanager.FileInfo
-
The type of file checksum algorithm.
- getFileChecksumType() - Method in class com.asperasoft.faspmanager.SessionStats
-
- getFilesComplete() - Method in class com.asperasoft.faspmanager.SessionStats
-
No of files completed transferring
- getFilesFailed() - Method in class com.asperasoft.faspmanager.SessionStats
-
No of files failed transferring
- getHost() - Method in class com.asperasoft.faspmanager.RemoteLocation
-
Get the host name or address.
- getHost() - Method in class com.asperasoft.faspmanager.SessionStats
-
Remote host name
- getId() - Method in class com.asperasoft.faspmanager.SessionStats
-
Unique identifier
- getIdentity() - Method in class com.asperasoft.faspmanager.RemoteLocation
-
Get the path to the SSH private key file
- getLicense() - Static method in class com.asperasoft.faspmanager.Environment
-
Retrieve the underlying license being used by ascp.
- getLicenseId() - Method in class com.asperasoft.faspmanager.License
-
- getLicenseReader() - Static method in class com.asperasoft.faspmanager.Environment
-
- getListenerCount() - Method in class com.asperasoft.faspmanager.FaspManager
-
- getLongOpt() - Method in enum com.asperasoft.faspmanager.AscpOption
-
- getManagementPort() - Static method in class com.asperasoft.faspmanager.Environment
-
Get the port at which fasp Manager is listening for connections from ascp processes.
- getManifestFilePath() - Method in class com.asperasoft.faspmanager.SessionStats
-
Manifest file path
- getMaximumBandwidth() - Method in class com.asperasoft.faspmanager.License
-
- getMeasuredLinkRateKbps() - Method in class com.asperasoft.faspmanager.SessionStats
-
Measured bandwidth
- getMgmtValue() - Method in enum com.asperasoft.faspmanager.Policy
-
- getMinRateKbps() - Method in class com.asperasoft.faspmanager.SessionStats
-
Minimum transfer rate
- getName() - Method in enum com.asperasoft.faspmanager.HashAlgorithm
-
- getNbAccounts() - Method in class com.asperasoft.faspmanager.License
-
- getNbUniqueConcurrentLogins() - Method in class com.asperasoft.faspmanager.License
-
- getOpt() - Method in enum com.asperasoft.faspmanager.AscpOption
-
- getOption() - Method in class com.asperasoft.faspmanager.AscpParameter
-
- getPassword() - Method in class com.asperasoft.faspmanager.RemoteLocation
-
Get the password for authentication.
- getPmtu() - Method in class com.asperasoft.faspmanager.SessionStats
-
- getPolicy() - Method in class com.asperasoft.faspmanager.SessionStats
-
Transfer policy
- getPortFilePath() - Static method in class com.asperasoft.faspmanager.Environment
-
Gets the path to the file containing the fasp management port.
- getPreCalcTotalBytes() - Method in class com.asperasoft.faspmanager.SessionStats
-
Aggregate file size
- getPreCalcTotalFiles() - Method in class com.asperasoft.faspmanager.SessionStats
-
Aggregate file count
- getProductId() - Method in class com.asperasoft.faspmanager.License
-
- getRawLicense() - Static method in class com.asperasoft.faspmanager.Environment
-
Retrieve the underlying license being used by ascp and returns it as is.
- getReleaseVersion() - Method in class com.asperasoft.faspmanager.FaspManager
-
Get the release version of the fasp Manager.
- getRetryTimeout() - Method in class com.asperasoft.faspmanager.SessionStats
-
- getServer() - Method in class com.asperasoft.faspmanager.TransferOrder
-
Get the server, who did not initiate the transfer.
- getServerClusterId() - Method in class com.asperasoft.faspmanager.SessionStats
-
- getServerNodeId() - Method in class com.asperasoft.faspmanager.SessionStats
-
- getSessionId() - Method in class com.asperasoft.faspmanager.SessionStats
-
Unique identifier
- getSessionIDList() - Method in class com.asperasoft.faspmanager.FaspManager
-
Retrieve a list of IDs for all active transfer sessions monitored by this fasp manager
- getSessionStats(String) - Method in class com.asperasoft.faspmanager.FaspManager
-
Get the statistics of a session by its id
- getSessionStatsByCookie(String) - Method in class com.asperasoft.faspmanager.FaspManager
-
Get the statistics of the session associated with the cookie.
- getSingleton() - Static method in class com.asperasoft.faspmanager.FaspManager
-
Returns the singleton FaspManager object.
- getSizeBytes() - Method in class com.asperasoft.faspmanager.FileInfo
-
Size of the file
- getSource() - Method in class com.asperasoft.faspmanager.TransferOrder
-
Get the source location, where data is transferred from.
- getSourcePaths() - Method in class com.asperasoft.faspmanager.SessionStats
-
Source paths
- getSourcePathsScanAttempted() - Method in class com.asperasoft.faspmanager.SessionStats
-
Gets the count of source path scans attempted for this session.
- getSourcePathsScanExcluded() - Method in class com.asperasoft.faspmanager.SessionStats
-
Gets the count of excludes source path scans for this session.
- getSourcePathsScanFailed() - Method in class com.asperasoft.faspmanager.SessionStats
-
Gets the count of failed source path scans for this session.
- getSourcePathsScanIrregular() - Method in class com.asperasoft.faspmanager.SessionStats
-
Gets the count of source path scans pointing to irregular files (i.e.
- getStandardOutput() - Method in class com.asperasoft.faspmanager.util.ErrorStreamHandler
-
- getStart() - Method in class com.asperasoft.faspmanager.ByteRange
-
- getStartByte() - Method in class com.asperasoft.faspmanager.FileInfo
-
Byte position where transfer is resumed
- getStartTime() - Method in class com.asperasoft.faspmanager.SessionStats
-
Transfer start time
- getState() - Method in class com.asperasoft.faspmanager.SessionStats
-
Transfer state
- getTags() - Method in class com.asperasoft.faspmanager.SessionStats
-
- getTargetRateKbps() - Method in class com.asperasoft.faspmanager.SessionStats
-
Target transfer rate
- getToken() - Method in class com.asperasoft.faspmanager.SessionStats
-
Token string
- getTotalLostBytes() - Method in class com.asperasoft.faspmanager.SessionStats
-
Total lost bytes
- getTotalTransferredBytes() - Method in class com.asperasoft.faspmanager.SessionStats
-
Bytes transferred
- getTotalWrittenBytes() - Method in class com.asperasoft.faspmanager.SessionStats
-
Bytes at the destination
- getTransfersAttempted() - Method in class com.asperasoft.faspmanager.SessionStats
-
Gets the count of file transfers initiated for this session.
- getTransfersFailed() - Method in class com.asperasoft.faspmanager.SessionStats
-
Gets the count of file transfers that failed for this session.
- getTransfersPassed() - Method in class com.asperasoft.faspmanager.SessionStats
-
Gets the count of successfully completed file transfers for this session.
- getTransfersSkipped() - Method in class com.asperasoft.faspmanager.SessionStats
-
The count of file transfers skipped (i.e.
- getUdpPort() - Method in class com.asperasoft.faspmanager.SessionStats
-
UDP port
- getUser() - Method in class com.asperasoft.faspmanager.RemoteLocation
-
Get the user for authentication.
- getUser() - Method in class com.asperasoft.faspmanager.SessionStats
-
Remote user name
- getValue() - Method in class com.asperasoft.faspmanager.AscpParameter
-
- getVersion() - Method in class com.asperasoft.faspmanager.License
-
- getVersion() - Method in class com.asperasoft.faspmanager.XferParams
-
- getWrittenBytes() - Method in class com.asperasoft.faspmanager.FileInfo
-
Bytes of this file written at the destination
- getXferId() - Method in class com.asperasoft.faspmanager.SessionStats
-
Xfer Id
- getXferParams() - Method in class com.asperasoft.faspmanager.TransferOrder
-
Get the transfer parameters.
- getXferRetry() - Method in class com.asperasoft.faspmanager.SessionStats
-
Xfer Retry
- readSize - Variable in class com.asperasoft.faspmanager.XferParams
-
Read block size in bytes.
- RemoteLocation - Class in com.asperasoft.faspmanager
-
A RemoteLocation represents the remote point for a fasp transfer.
- RemoteLocation(String, String, String) - Constructor for class com.asperasoft.faspmanager.RemoteLocation
-
Create a remote location that uses password authentication.
- RemoteLocation(String, String, String, String) - Constructor for class com.asperasoft.faspmanager.RemoteLocation
-
Create a remote file location that uses SSH public key authentication.
- remoteLogDir - Variable in class com.asperasoft.faspmanager.XferParams
-
Specify a directory to write the log file in for the local host, instead of using the default directory.
- removeByteRange() - Method in class com.asperasoft.faspmanager.RemoteLocation
-
Remove any byte range setting
- removeEmptyDirectories - Variable in class com.asperasoft.faspmanager.XferParams
-
Remove source empty directories after transferring.
- removeFileAfterTransfer - Variable in class com.asperasoft.faspmanager.XferParams
-
Remove source files after transferring.
- removeListener(TransferListener) - Method in class com.asperasoft.faspmanager.FaspManager
-
Unregister a TransferListener, to stop receiving notifications.
- removeSessionListener(String, TransferListener) - Method in class com.asperasoft.faspmanager.FaspManager
-
Unregister a session level TransferListener
- Resume - Enum in com.asperasoft.faspmanager
-
These are the resume options for transferred files, if a file is found with the same name at the destination.
- resumeCheck - Variable in class com.asperasoft.faspmanager.XferParams
-
Resume policy for partially transferred files.
- retransmissionRequestMaxSize - Variable in class com.asperasoft.faspmanager.XferParams
-
- retryTimeoutS - Variable in class com.asperasoft.faspmanager.XferParams
-
Informs any monitoring applications how long you intend to retry.
- run() - Method in class com.asperasoft.faspmanager.util.SelectThread
-
- saveBeforeOverwriteEnabled - Variable in class com.asperasoft.faspmanager.XferParams
-
- selectAccepted(SocketChannel) - Method in interface com.asperasoft.faspmanager.util.SelectHandler
-
A connection was accepted, opening the given channel.
- selectClosed(SocketChannel) - Method in interface com.asperasoft.faspmanager.util.SelectHandler
-
- SelectHandler - Interface in com.asperasoft.faspmanager.util
-
- selectRead(SocketChannel) - Method in interface com.asperasoft.faspmanager.util.SelectHandler
-
- SelectThread - Class in com.asperasoft.faspmanager.util
-
- SelectThread() - Constructor for class com.asperasoft.faspmanager.util.SelectThread
-
- SessionAuthorizer - Interface in com.asperasoft.faspmanager
-
It is possible to setup a custom authorizer that determines whether a transfer is to be allowed or not.
- SessionFactory - Interface in com.asperasoft.faspmanager
-
- SessionNotFoundException - Exception in com.asperasoft.faspmanager
-
Indicates that no matching session is found to perform the current operation
- SessionState - Enum in com.asperasoft.faspmanager
-
The different states a Session could be in.
- SessionStats - Class in com.asperasoft.faspmanager
-
Statistics of a FASP transfer session
- setAuthorizationEnabled(boolean) - Method in class com.asperasoft.faspmanager.FaspManager
-
Enable transfer authorization.
- setAuthorizer(SessionAuthorizer) - Method in class com.asperasoft.faspmanager.FaspManager
-
Set the SessionAuthorizer for all transfer sessions
- setByteRange(ByteRange) - Method in class com.asperasoft.faspmanager.RemoteLocation
-
Specify the range of bytes to be downloaded.
- setDestination(FileTransferLocation) - Method in class com.asperasoft.faspmanager.TransferOrder
-
Set the destination location.
- setFasp2ScpPath(String) - Static method in class com.asperasoft.faspmanager.Environment
-
Sets the path to the fasp2 ascp binary.
- setFaspDebug(boolean) - Method in class com.asperasoft.faspmanager.FaspManager
-
Enable debug logging from Aspera transfer engine.
- setManagementPort(int) - Static method in class com.asperasoft.faspmanager.Environment
-
Set the management port to a specific value.
- setPassword(String) - Method in class com.asperasoft.faspmanager.RemoteLocation
-
- setProcessErrorStream(InputStream) - Method in class com.asperasoft.faspmanager.util.ErrorStreamHandler
-
- setProcessInputStream(OutputStream) - Method in class com.asperasoft.faspmanager.util.ErrorStreamHandler
-
- setProcessOutputStream(InputStream) - Method in class com.asperasoft.faspmanager.util.ErrorStreamHandler
-
- setRate(String, int, int, Policy) - Method in class com.asperasoft.faspmanager.FaspManager
-
Change the rate and policy of an active transfer
- setSource(FileTransferLocation) - Method in class com.asperasoft.faspmanager.TransferOrder
-
Set the source location.
- setUnicodeSupportOn(boolean) - Static method in class com.asperasoft.faspmanager.Environment
-
Deprecated.
3.2 no longer has any affect, unicode always supported
- setUser(String) - Method in class com.asperasoft.faspmanager.RemoteLocation
-
- setXferParams(XferParams) - Method in class com.asperasoft.faspmanager.TransferOrder
-
Set the transfer parameters.
- skipSpecialFiles - Variable in class com.asperasoft.faspmanager.XferParams
-
Skip special files.
- sourceBase - Variable in class com.asperasoft.faspmanager.XferParams
-
Specify the prefix to be stripped off from each source object.
- start() - Method in class com.asperasoft.faspmanager.util.ErrorStreamHandler
-
- startServer(int, SelectHandler) - Method in class com.asperasoft.faspmanager.util.SelectThread
-
Start listening for connections on the given port.
- startServer(SelectHandler) - Method in class com.asperasoft.faspmanager.util.SelectThread
-
Start listening on a system-selected port.
- startTransfer(TransferOrder) - Method in class com.asperasoft.faspmanager.FaspManager
-
Start a transfer
- startTransfer(TransferOrder, TransferListener) - Method in class com.asperasoft.faspmanager.FaspManager
-
Start a transfer
- startTransfer(TransferOrder, UUID, int) - Method in class com.asperasoft.faspmanager.FaspManager
-
Start a transfer
- startTransfer(TransferOrder, UUID, int, TransferListener) - Method in class com.asperasoft.faspmanager.FaspManager
-
Start a transfer
- startTransfer(TransferOrder, int) - Method in class com.asperasoft.faspmanager.FaspManager
-
Start a multi-process/parallel transfer
- startTransfer(TransferOrder, int, TransferListener) - Method in class com.asperasoft.faspmanager.FaspManager
-
Start or restart a multi-process transfer
- startTransfer(TransferOrder, UUID, int, int, TransferListener) - Method in class com.asperasoft.faspmanager.FaspManager
-
Start or restart a multi-process transfer
- StateException - Exception in com.asperasoft.faspmanager
-
Indicates the session is a state where the current operation cannot be performed.
- stop() - Method in class com.asperasoft.faspmanager.util.ErrorStreamHandler
-
- stopTransfer(String) - Method in class com.asperasoft.faspmanager.FaspManager
-
Stop an active persistent transfer session.
- SymLinkPolicy - Enum in com.asperasoft.faspmanager
-
- symLinkPolicy - Variable in class com.asperasoft.faspmanager.XferParams
-
How symbolic links are handled.
- validate() - Method in class com.asperasoft.faspmanager.TransferOrder
-
Check the order for invalid parameters.
- validationError - Variable in class com.asperasoft.faspmanager.XferParams
-
Error string describing the error found in validation.
- ValidationException - Exception in com.asperasoft.faspmanager
-
Indicates the parameters submitted to Fasp Manager are invalid
- valueOf(String) - Static method in enum com.asperasoft.faspmanager.AscpOption
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.asperasoft.faspmanager.ContentProtection
-
Deprecated.
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.asperasoft.faspmanager.DeleteSource
-
Deprecated.
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.asperasoft.faspmanager.Encryption
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.asperasoft.faspmanager.FileCryptMode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.asperasoft.faspmanager.FileState
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.asperasoft.faspmanager.HashAlgorithm
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.asperasoft.faspmanager.Manifest
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.asperasoft.faspmanager.Mode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.asperasoft.faspmanager.Overwrite
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.asperasoft.faspmanager.Policy
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.asperasoft.faspmanager.Resume
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.asperasoft.faspmanager.SessionState
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.asperasoft.faspmanager.SymLinkPolicy
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.asperasoft.faspmanager.TransferEvent
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.asperasoft.faspmanager.Version
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum com.asperasoft.faspmanager.AscpOption
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.asperasoft.faspmanager.ContentProtection
-
Deprecated.
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.asperasoft.faspmanager.DeleteSource
-
Deprecated.
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.asperasoft.faspmanager.Encryption
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.asperasoft.faspmanager.FileCryptMode
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.asperasoft.faspmanager.FileState
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.asperasoft.faspmanager.HashAlgorithm
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.asperasoft.faspmanager.Manifest
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.asperasoft.faspmanager.Mode
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.asperasoft.faspmanager.Overwrite
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.asperasoft.faspmanager.Policy
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.asperasoft.faspmanager.Resume
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.asperasoft.faspmanager.SessionState
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.asperasoft.faspmanager.SymLinkPolicy
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.asperasoft.faspmanager.TransferEvent
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.asperasoft.faspmanager.Version
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- Version - Enum in com.asperasoft.faspmanager
-
Used to specify the version of fasp to use to transfer files.