com.ibm.cloud.objectstorage.services.aspera.transfer

Class AsperaTransferManager

java.lang.Object

com.ibm.cloud.objectstorage.services.aspera.transfer.AsperaTransferManager

public class AsperaTransferManager
extends Object

Aspera transfer Manager class to handle multiple functions to the Aspera service using the Aspera SDK as the underlying library to handle the transfer. This Class also instantiates the token provider AsperaDelegateTokenProvider to retrieve a delegate token for the Aspera Service

Field Summary

Fields

Modifier and Type	Field and Description
protected static InternalLogApi	log

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AsperaTransferManager(AmazonS3 s3Client, TokenManager tokenManager, AsperaConfig asperaConfig, AsperaTransferManagerConfig asperaTransferManagerConfig)

Method Summary

Modifier and Type	Method and Description
protected void	checkAscpThreshold() Check if ascp count has hit limit If it has throw an exception
void	checkMultiSessionAllGlobalConfig(TransferSpecs transferSpecs) Modify the retrieved TransferSpec and apply an '-all' suffix to the subdomain on the remote)host field
Future<AsperaTransaction>	download(String bucket, File localFileName, String remoteFileName) Downloads a file via Aspera FASP
Future<AsperaTransaction>	download(String bucket, File localFileName, String remoteFileName, AsperaConfig sessionDetails, ProgressListener listenerChain)
Future<AsperaTransaction>	downloadDirectory(String bucketName, String virtualDirectoryKeyPrefix, File directory)
Future<AsperaTransaction>	downloadDirectory(String bucketName, String virtualDirectoryKeyPrefix, File directory, AsperaConfig sessionDetails, ProgressListener progressListener)
void	excludeSubdirectories(File directory, TransferSpecs transferSpecs) List all files within the folder to exclude all subdirectories & modify the transfer spec to pass onto Aspera SDK
protected void	finalize() Releasing all resources created by TransferManager before it is being garbage collected.
FASPConnectionInfo	getFaspConnectionInfo(String bucketName) Check the LRU cache to see if the Aspera Key has already been retrieved for this bucket.
TransferSpecs	getTransferSpec(FASPConnectionInfo faspConnectionInfo, String localFileName, String remoteFileName, String direction)
void	modifyTransferSpec(AsperaConfig sessionDetails, TransferSpecs transferSpecs) Modify the retrieved TransferSpec with the customised AsperaConfig object created by the user
AsperaTransaction	processTransfer(String transferSpecStr, String bucketName, String key, String fileName, ProgressListener progressListener) Process the transfer spec to call the underlying Aspera libraries to begin the transfer
void	shutdownThreadPools() Shutdown without interrupting the threads involved, so that, for example, any upload in progress can complete without throwing AbortedException.
Future<AsperaTransaction>	upload(String bucket, File localFileName, String remoteFileName) Uploads a file via Aspera FASP
Future<AsperaTransaction>	upload(String bucket, File localFileName, String remoteFileName, AsperaConfig sessionDetails, ProgressListener progressListener)
Future<AsperaTransaction>	uploadDirectory(String bucketName, String virtualDirectoryKeyPrefix, File directory, boolean includeSubdirectories) Subdirectories are included in the upload by default, to exclude ensure you pass through 'false' for includeSubdirectories param
Future<AsperaTransaction>	uploadDirectory(String bucketName, String virtualDirectoryKeyPrefix, File directory, boolean includeSubdirectories, AsperaConfig sessionDetails, ProgressListener progressListener) Subdirectories are included in the upload by default, to exclude ensure you pass through 'false' for includeSubdirectories param
protected AsperaTransferManager	withAsperaTransferManagerConfig(AsperaTransferManagerConfig asperaTransferManagerConfig) Allows a user to overwrite the AsperaTransferManager with their own customised properties.
protected AsperaTransferManager	withTokenManager(TokenManager tokenManager) Allows a user to overwrite the TokenManager with their own.

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static final InternalLogApi log

Constructor Detail

AsperaTransferManager

protected AsperaTransferManager(AmazonS3 s3Client,
                                TokenManager tokenManager,
                                AsperaConfig asperaConfig,
                                AsperaTransferManagerConfig asperaTransferManagerConfig)

Method Detail

upload

public Future<AsperaTransaction> upload(String bucket,
                                        File localFileName,
                                        String remoteFileName)

Uploads a file via Aspera FASP

Parameters:

bucket - - The bucket to upload the object to

localFileName - - File path & name of the file to upload

remoteFileName - - The remote file name to save the object as on cloud storage

upload

public Future<AsperaTransaction> upload(String bucket,
                                        File localFileName,
                                        String remoteFileName,
                                        AsperaConfig sessionDetails,
                                        ProgressListener progressListener)

download

public Future<AsperaTransaction> download(String bucket,
                                          File localFileName,
                                          String remoteFileName)

Downloads a file via Aspera FASP

Parameters:

bucket - - The bucket to download the object from

localFileName - - File path & name to save the downloaed file to

remoteFileName - - The remote file name to download

download

public Future<AsperaTransaction> download(String bucket,
                                          File localFileName,
                                          String remoteFileName,
                                          AsperaConfig sessionDetails,
                                          ProgressListener listenerChain)

downloadDirectory

public Future<AsperaTransaction> downloadDirectory(String bucketName,
                                                   String virtualDirectoryKeyPrefix,
                                                   File directory)

downloadDirectory

public Future<AsperaTransaction> downloadDirectory(String bucketName,
                                                   String virtualDirectoryKeyPrefix,
                                                   File directory,
                                                   AsperaConfig sessionDetails,
                                                   ProgressListener progressListener)

uploadDirectory

public Future<AsperaTransaction> uploadDirectory(String bucketName,
                                                 String virtualDirectoryKeyPrefix,
                                                 File directory,
                                                 boolean includeSubdirectories)

Subdirectories are included in the upload by default, to exclude ensure you pass through 'false' for includeSubdirectories param

Parameters:

bucketName -

virtualDirectoryKeyPrefix -

directory -

includeSubdirectories -

Returns:

uploadDirectory

public Future<AsperaTransaction> uploadDirectory(String bucketName,
                                                 String virtualDirectoryKeyPrefix,
                                                 File directory,
                                                 boolean includeSubdirectories,
                                                 AsperaConfig sessionDetails,
                                                 ProgressListener progressListener)

Subdirectories are included in the upload by default, to exclude ensure you pass through 'false' for includeSubdirectories param

Parameters:

bucketName -

virtualDirectoryKeyPrefix -

directory -

includeSubdirectories -

sessionDetails -

Returns:

processTransfer

public AsperaTransaction processTransfer(String transferSpecStr,
                                         String bucketName,
                                         String key,
                                         String fileName,
                                         ProgressListener progressListener)

Process the transfer spec to call the underlying Aspera libraries to begin the transfer

Parameters:

transferSpecStr -

bucketName -

key -

fileName -

Returns:

getFaspConnectionInfo

public FASPConnectionInfo getFaspConnectionInfo(String bucketName)

Check the LRU cache to see if the Aspera Key has already been retrieved for this bucket. If it has, return it, else call onto the s3Client to get the FASPConnectionInfo for the bucket name

Parameters:

bucketName -

Returns:

getTransferSpec

public TransferSpecs getTransferSpec(FASPConnectionInfo faspConnectionInfo,
                                     String localFileName,
                                     String remoteFileName,
                                     String direction)
                              throws SdkClientException,
                                     AmazonServiceException

Throws:

SdkClientException

AmazonServiceException

checkMultiSessionAllGlobalConfig

public void checkMultiSessionAllGlobalConfig(TransferSpecs transferSpecs)

Modify the retrieved TransferSpec and apply an '-all' suffix to the subdomain on the remote)host field

Parameters:

sessionDetails -

transferSpecs -

modifyTransferSpec

public void modifyTransferSpec(AsperaConfig sessionDetails,
                               TransferSpecs transferSpecs)

Modify the retrieved TransferSpec with the customised AsperaConfig object created by the user

Parameters:

sessionDetails -

transferSpecs -

excludeSubdirectories

public void excludeSubdirectories(File directory,
                                  TransferSpecs transferSpecs)

List all files within the folder to exclude all subdirectories & modify the transfer spec to pass onto Aspera SDK

Parameters:

directory -

transferSpecs -

withTokenManager

protected AsperaTransferManager withTokenManager(TokenManager tokenManager)

Allows a user to overwrite the TokenManager with their own. This will mainly be utilised for dev/test environments. This method is to be used within AsperaTransferManagerBuilder

Parameters:

tokenManager -

Returns:

withAsperaTransferManagerConfig

protected AsperaTransferManager withAsperaTransferManagerConfig(AsperaTransferManagerConfig asperaTransferManagerConfig)

Allows a user to overwrite the AsperaTransferManager with their own customised properties. This method is to be used within AsperaTransferManagerBuilder

Parameters:

asperaTransferManagerConfig -

Returns:

shutdownThreadPools

public void shutdownThreadPools()

Shutdown without interrupting the threads involved, so that, for example, any upload in progress can complete without throwing AbortedException.

finalize

protected void finalize()
                 throws Throwable

Releasing all resources created by TransferManager before it is being garbage collected.

Overrides:

finalize in class Object

Throws:

Throwable

checkAscpThreshold

protected void checkAscpThreshold()

Check if ascp count has hit limit If it has throw an exception