Relativity.Transfer.Client 6.0.16

API Differences between 6.0.16 and 7.0.8

362 Additions 109 Removals

Relativity.Transfer

public class HttpClientConfiguration
public sealed class AsperaCredential : IEquatable<AsperaCredential>
- public const string AsperaNodeCredentialType = "AsperaNode"
public sealed class AsperaCredentials
- public AsperaCredential NodeCredential { get; }
- public AsperaCredential TransferCredential { get; }
- public AsperaCredentials(AsperaCredential transfer, AsperaCredential node)
public class AsperaNodeException : Exception
- public AsperaNodeException()
- public AsperaNodeException(string message)
- public AsperaNodeException(string message, Exception innerException)
- protected AsperaNodeException(SerializationInfo info, StreamingContext context)
public class BasicAuthenticationCredential : IHttpCredential
- public void RefreshCredentials()
public class BearerTokenCredential : IHttpCredential
- public BearerTokenCredential()
- public BearerTokenCredential(string token, IAuthenticationTokenProvider authTokenProvider)
- public void RefreshCredentials()
public class ClientConfiguration : Dictionary<string, object>
- public bool SavingMemoryMode { get; set; }
public static class ClientConfigurationKeys
- public const string SavingMemoryMode = "saving-memory-mode"
public sealed class ClientLimits
- public int MaxSupportedPathLength { get; set; }
- public int TransferFileNameLength { get; set; }
- public int? MaxClientSupportedPathLength { get; set; }
- public int? TransferFileNameLength { get; set; }
public sealed class FileShareResourceServer
- public AsperaCredential AsperaCredential { get; }
- public AsperaCredentials AsperaCredentials { get; }
- public FileShareResourceServer(int artifactId, AsperaCredential credential, string name, ResourceServerType serverType, string uncPath, bool cloudInstance)
- public FileShareResourceServer(int artifactId, AsperaCredential credential, string name, ResourceServerType serverType, string uncPath, bool cloudInstance, ResourcePool pool)
- public FileShareResourceServer(int artifactId, AsperaCredentials credentials, string name, ResourceServerType serverType, string uncPath, bool cloudInstance)
- public FileShareResourceServer(int artifactId, AsperaCredentials credentials, string name, ResourceServerType serverType, string uncPath, bool cloudInstance, ResourcePool pool)
public class GlobalSettings
- public const bool DefaultApmFireAndForgetEnabled = true
- public const bool DefaultLogPackageSourceFiles = true
- public const int DefaultMaxFilesPerBatch = 50000
- public const long DefaultMaxFilesPerBatch = 50000
- public bool ApmFireAndForgetEnabled { get; set; }
- public bool LogPackageSourceFiles { get; set; }
- public int MaxFilesPerBatch { get; set; }
- public long MaxFilesPerBatch { get; set; }
- public int NodePageSize { get; set; }
public interface IAuthenticationTokenProvider
public interface ICredentialService
- Task<AsperaCredential> GetResourceServerAsperaCredentialAsync(int resourceServerArtifactId, CancellationToken token)
- Task<AsperaCredentials> GetResourceServerAsperaCredentialsAsync(int resourceServerArtifactId, CancellationToken token)
public interface IFileShareService
public interface IHttpCredential
- void RefreshCredentials()
public class IntegratedSecurityCredential : IHttpCredential
- public void RefreshCredentials()
public interface IPackageLibrary : IDisposable
- string DisplayName { get; }
- Guid Id { get; }
- string Name { get; }
- WellKnownPackageLibrary PackageLibrary { get; }
- event EventHandler<PackageQueuedEventArgs> QueuePackageFile
- IPackageResult PackageFiles(ITransferRequest request, PackageContext context, CancellationToken token)
- IPackageResult PackageFiles(ITransferRequest request, IEnumerable<SerializedBatch> batches, PackageContext context, CancellationToken token)
public interface IPackageLibraryMetadata
- string Description { get; }
- string DisplayName { get; }
- string Id { get; }
- string Name { get; }
- WellKnownPackageLibrary PackageLibrary { get; }
- string Version { get; }
public interface IPackageResult
- long PackagedSourceFiles { get; }
- IList<string> PackageFileNames { get; }
- TimeSpan PackageTime { get; }
public interface IPackageTransferResult : ITransferResult, IPackageResult
public interface IPathValidationFactory
public interface IPathValidationProvider : IPathValidator
public interface IPathValidator
public interface IRelativityServiceFactory
- IPathValidationProvider PathValidationProvider { get; }
- IFileShareService CreateFileShareService(int fileShareId)
public interface ITransferClient : IDisposable
- ClientLimits ClientLimits { get; }
- Task<IPackageTransferResult> PackageTransferAsync(ITransferRequest request, PackageContext context)
- Task<IPackageTransferResult> PackageTransferAsync(ITransferRequest request, PackageContext context, CancellationToken token)
- Task<IPackageTransferResult> PackageTransferAsync(ITransferRequest request, IEnumerable<SerializedBatch> batches, PackageContext context, CancellationToken token)
public interface ITransferIssueBuilder
- ITransferIssueBuilder Create()
- ITransferIssueBuilder WithMessage(string message)
- ITransferIssueBuilder WithRetryable(bool retrayable)
public interface ITransferJob : IDisposable
- PathValidationResult ValidatePath(TransferPath path)
- void ValidatePath(TransferPath path)
public interface ITransferJobService
- bool IsCompleted(TransferPathStatus status)
- bool IsRetrayable(TransferPathStatus status)
- void Initialize()
public class LargeFileProgress : IProgress<LargeFileProgressEventArgs>
public static class LogExtensions
- public static void LogTransferDebug(this ITransferLog log, ITransferRequest request, string messageTemplate, object[] propertyValues)
- public static void LogTransferDebug(this ITransferLog log, Exception exception, ITransferRequest request, string messageTemplate, object[] propertyValues)
- public static void LogTransferError(this ITransferLog log, ITransferRequest request, string messageTemplate, object[] propertyValues)
- public static void LogTransferError(this ITransferLog log, Exception exception, ITransferRequest request, string messageTemplate, object[] propertyValues)
- public static void LogTransferInformation(this ITransferLog log, ITransferRequest request, string messageTemplate, object[] propertyValues)
- public static void LogTransferInformation(this ITransferLog log, Exception exception, ITransferRequest request, string messageTemplate, object[] propertyValues)
- public static void LogTransferStatistics(this ITransferLog log, ITransferRequest request, ITransferStatistics statistics)
- public static void LogTransferWarning(this ITransferLog log, ITransferRequest request, string messageTemplate, object[] propertyValues)
- public static void LogTransferWarning(this ITransferLog log, Exception exception, ITransferRequest request, string messageTemplate, object[] propertyValues)
public sealed class PackageConfiguration : Dictionary<string, object>
- public const bool DefaultCompression = false
- public const bool DefaultDeletePackageFiles = true
- public const string DefaultFileName = "tapi-package"
- public const long DefaultMultiFileMaxBytes = 1073741824
- public bool Compression { get; set; }
- public bool DeletePackageFiles { get; set; }
- public string FileName { get; set; }
- public long MultiFileMaxBytes { get; set; }
- public string Name { get; set; }
- public WellKnownPackageLibrary PackageLibrary { get; set; }
- public Guid PackageLibraryId { get; set; }
- public string Password { get; set; }
- public PackageConfiguration()
- public PackageConfiguration(IDictionary<string, object> dictionary)
- public void Copy(IDictionary<string, object> properties)
- public void Copy(IDictionary<string, object> properties, bool overwrite)
public sealed class PackageContext
- public PackageConfiguration Configuration { get; }
- public IDictionary<string, object> Metadata { get; }
- public event EventHandler<PackageEventArgs> PackageCreated
- public event EventHandler<PackageProgressEventArgs> PackageProgress
- public event EventHandler<PackagingFileMetadataEventArgs> PackagingFile
- public PackageContext(PackageConfiguration configuration)
- public PackageContext(PackageConfiguration configuration, IDictionary<string, object> metadata)
- public void PublishPackageCreated(ITransferRequest request, string file)
- public void PublishPackageProgress(ITransferRequest request, long packagedSourceFiles, long sourceFiles)
- public void PublishPackagingFile(ITransferRequest request, PackageFileMetadata sourceMetadata, string targetPackageFile)
public class PackageEventArgs : EventArgs
- public string File { get; }
- public ITransferRequest Request { get; }
- public PackageEventArgs(ITransferRequest request, string file)
public class PackageFileMetadata
- public DateTime? CreationTime { get; set; }
- public string ExtractDirectory { get; set; }
- public string File { get; set; }
- public string FileName { get; set; }
- public DateTime? LastAccessTime { get; set; }
- public DateTime? LastWriteTime { get; set; }
- public PackageFileMetadata(string file, string fileName)
public abstract class PackageLibraryBase : IPackageLibrary, IDisposable
- public string DisplayName { get; }
- protected IFileSystemService FileSystemService { get; }
- public Guid Id { get; }
- public string Name { get; }
- public WellKnownPackageLibrary PackageLibrary { get; }
- protected IList<string> QueuedPackageFiles { get; }
- protected string TempDirectory { get; }
- public event EventHandler<PackageQueuedEventArgs> QueuePackageFile
- protected PackageLibraryBase(ITransferLog log, IFileSystemService fileSystemService, Guid id, WellKnownPackageLibrary library, string name, string displayName)
- public void Dispose()
- protected virtual void Dispose(bool disposing)
- protected string GetTempFilePath(string fileName)
- protected abstract void OnEndPackaging(ITransferRequest request)
- protected abstract void OnPackageSourceFile(PackageFileMetadata metadata, CancellationToken token)
- protected abstract void OnStartPackaging(ITransferRequest request, PackageConfiguration configuration, IDictionary<string, object> metadata, CancellationToken token)
- protected void PackageCreated(ITransferRequest request, string file)
- public IPackageResult PackageFiles(ITransferRequest request, PackageContext context, CancellationToken token)
- public IPackageResult PackageFiles(ITransferRequest request, IEnumerable<SerializedBatch> batches, PackageContext context, CancellationToken token)
- protected void PublishQueuePackageFile(ITransferRequest request, string file)
- protected void PublishQueuePackageFile(ITransferRequest request, IEnumerable<string> files)
public sealed class PackageLibraryMetadataAttribute : ExportAttribute, IPackageLibraryMetadata
- public string Description { get; set; }
- public string DisplayName { get; set; }
- public string Id { get; set; }
- public string Name { get; set; }
- public WellKnownPackageLibrary PackageLibrary { get; set; }
- public string Version { get; set; }
- public PackageLibraryMetadataAttribute()
public class PackageProgressEventArgs : EventArgs
- public long PackagedSourceFiles { get; }
- public double Progress { get; }
- public ITransferRequest Request { get; }
- public long SourceFiles { get; }
- public PackageProgressEventArgs(ITransferRequest request, long packagedSourceFiles, long sourceFiles)
public class PackageQueuedEventArgs : EventArgs
- public IEnumerable<string> Files { get; }
- public ITransferRequest Request { get; }
- public PackageQueuedEventArgs(ITransferRequest request, IEnumerable<string> files)
public sealed class PackageResult : IPackageResult
- public long PackagedSourceFiles { get; set; }
- public IList<string> PackageFileNames { get; }
- public TimeSpan PackageTime { get; set; }
- public PackageResult()
- public void AddPackageFileName(string file)
public sealed class PackageTransferResult : IPackageTransferResult, ITransferResult, IPackageResult
- public ClientConfiguration Configuration { get; }
- public TimeSpan Elapsed { get; }
- public DateTime? EndTime { get; }
- public IReadOnlyList<ITransferIssue> Issues { get; }
- public int MinDataRateMbps { get; }
- public long PackagedSourceFiles { get; }
- public IList<string> PackageFileNames { get; }
- public TimeSpan PackageTime { get; }
- public ITransferRequest Request { get; }
- public int RetryCount { get; }
- public DateTime? StartTime { get; }
- public IReadOnlyList<ITransferStatistics> Statistics { get; }
- public TransferStatus Status { get; }
- public int TargetDataRateMbps { get; }
- public long TotalBadPathErrors { get; }
- public long TotalFailedFiles { get; }
- public long TotalFatalErrors { get; }
- public long TotalFilePermissionErrors { get; }
- public long TotalFilesNotFound { get; }
- public long TotalSkippedFiles { get; }
- public long TotalTransferredBytes { get; }
- public long TotalTransferredFiles { get; }
- public ITransferIssue TransferError { get; }
- public double TransferRateMbps { get; }
- public PackageTransferResult(ITransferResult result, IPackageResult packageResult)
public class PackagingFileMetadataEventArgs : EventArgs
- public ITransferRequest Request { get; }
- public PackageFileMetadata SourceFileMetadata { get; }
- public string TargetPackageFile { get; }
- public PackagingFileMetadataEventArgs(ITransferRequest request, PackageFileMetadata sourceFileMetadata, string targetPackageFile)
public abstract class PathEnumeratorBase : IPathEnumerator
- protected virtual void OnInitialize(PathEnumeratorContext context, CancellationToken token)
- protected abstract Task OnInitializeAsync(PathEnumeratorContext context, CancellationToken token)
public static class PathHelper
- public static string GetTargetFilePath(string sourcePath, string targetPath, string targetFileName)
public class PathValidationProvider : IPathValidationProvider, IPathValidator
public class PathValidationResult
public enum PathValidationStatus
public sealed class RelativityFileShare : RelativityFileShareBase
- public RelativityFileShare(int artifactId, string name, string path, AsperaCredential credentials, bool cloudInstance)
- public RelativityFileShare(int artifactId, string name, string path, ResourceServerType resourceServerType, AsperaCredential credential, bool cloudInstance)
- public RelativityFileShare(int artifactId, string name, string path, AsperaCredentials credentials, bool cloudInstance)
- public RelativityFileShare(int artifactId, string name, string path, ResourceServerType resourceServerType, AsperaCredentials credentials, bool cloudInstance)
public abstract class RelativityFileShareBase : FileStorageBase
- public AsperaCredential AsperaCredential { get; protected set; }
- public AsperaCredentials AsperaCredentials { get; protected set; }
- public AsperaCredential NodeCredential { get; }
- public AsperaCredential TransferCredential { get; }
public abstract class RemotePathResolverBase : IRemotePathResolver
- protected ITransferLog transferLog
- protected RemotePathResolverBase(ITransferLog transferLog)
- protected RemotePathResolverBase()
public sealed class SqlResourceServer
- public AsperaCredential AsperaCredential { get; }
- public AsperaCredentials AsperaCredentials { get; }
- public SqlResourceServer(int artifactId, AsperaCredential credential, string name, ResourceServerType serverType, string bcpPath, bool cloudInstance)
- public SqlResourceServer(int artifactId, AsperaCredentials credentials, string name, ResourceServerType serverType, string bcpPath, bool cloudInstance)
public abstract class TransferClientBase : ITransferClient, IDisposable
- public ClientLimits ClientLimits { get; set; }
- protected IPathValidationProvider PathValidationProvider { get; }
- protected TransferClientBase(RelativityConnectionInfo connectionInfo, ClientConfiguration configuration, IWorkspaceService workspaceService, ITransferLog log, Guid id, WellKnownTransferClient client, string name, string displayName, IPathValidationFactory pathValidationFactory)
- protected TransferClientBase(RelativityConnectionInfo connectionInfo, ClientConfiguration configuration, IWorkspaceService workspaceService, ITransferLog log, IFileSystemService fileSystemService, Guid id, WellKnownTransferClient client, string name, string displayName, IPathValidationFactory pathValidationFactory)
- protected TransferClientBase(RelativityConnectionInfo connectionInfo, ClientConfiguration configuration, IWorkspaceService workspaceService, ITransferLog log, IFileSystemService fileSystemService, Guid id, WellKnownTransferClient client, string name, string displayName)
- public Task<IPackageTransferResult> PackageTransferAsync(ITransferRequest request, PackageContext context)
- public Task<IPackageTransferResult> PackageTransferAsync(ITransferRequest request, PackageContext context, CancellationToken token)
- public Task<IPackageTransferResult> PackageTransferAsync(ITransferRequest request, IEnumerable<SerializedBatch> batches, PackageContext context, CancellationToken token)
public static class TransferClientConstants
- public const string AzureBlobClientDisplayName = "Azure Blob"
- public const string AzureBlobClientId = "962EE9FF-6E12-4EBF-A0C3-F2BB5B1547C4"
- public const string AzureBlobClientName = "Azure Blob"
- public const string AzureFilesClientDisplayName = "Azure Files"
- public const string AzureFilesClientId = "302B33BB-1CC5-4901-B1CD-78D755986E7A"
- public const string AzureFilesClientName = "Azure Files"
- public const string HttpClientDisplayName = "Web"
- public const string HttpClientDiplayName = "Web"
public sealed class TransferContext
- public event EventHandler<TransferPathIssueEventArgs> TransferJobIssue
- public void PublishTransferJobIssue(ITransferRequest request, ITransferIssue issue)
public abstract class TransferJobBase : ITransferJob, IDisposable
- public int? ClientMaxSupportedPathLength { get; set; }
- public int? ClientTransferFileNameLength { get; set; }
- protected void LogErrorPath(string path)
- public PathValidationResult ValidatePath(TransferPath path)
- public void ValidatePath(TransferPath path)
- protected void ValidateSourcePathLength(TransferPath path)
- protected virtual void ValidateTargetPathLength(TransferPath path)
public class TransferJobService : ITransferJobService
- public bool IsCompleted(TransferPathStatus status)
- public bool IsRetrayable(TransferPathStatus status)
- public void Initialize()
public abstract class TransferPathCommandBase : ITransferPathCommand
- protected void PublishTransferJobIssue(ITransferIssue issue)
- protected bool ShouldPublishLargeFileProgress(int chunkNumber, int totalChunks, DateTime timestamp)
public class TransferPathProgressEventArgs : EventArgs
- public bool Completed { get; }
- public string TargetFile { get; }
- public TransferPathProgressEventArgs(ITransferRequest request, TransferPath path, string targetFile, TransferPathStatus status, bool completed)
- public TransferPathProgressEventArgs(ITransferRequest request, TransferPath path, string targetFile, TransferPathStatus status, bool completed, DateTime? startTime, DateTime? endTime, long bytesTransferred)
- public TransferPathProgressEventArgs(ITransferRequest request, TransferPath path, string targetFile, TransferPathStatus status, bool completed, DateTime? startTime, DateTime? endTime, long bytesTransferred, string checksum)
- public TransferPathProgressEventArgs(ITransferRequest request, TransferPath path, TransferPathStatus status)
- public TransferPathProgressEventArgs(ITransferRequest request, TransferPath path, TransferPathStatus status, DateTime? startTime, DateTime? endTime, long bytesTransferred)
- public TransferPathProgressEventArgs(ITransferRequest request, TransferPath path, TransferPathStatus status, DateTime? startTime, DateTime? endTime, long bytesTransferred, string checksum)
public class TransferPathResult
- public bool Completed { get; set; }
- public string TargetFile { get; }
public static class UncPathToDocRootConverter
public enum WellKnownPackageLibrary
- Rcc = 1
- ThirdParty = 2
- Unassigned = 0
public enum WellKnownTransferClient
- AzureBlob = 1
- AzureFiles = 2

Relativity.Transfer.Aspera

public class AsperaClientConfiguration : ClientConfiguration
- public const int DefaultDatagramSize = 0
- public int DatagramSize { get; set; }
- public string NodeAccountPassword { get; set; }
- public string NodeAccountUserName { get; set; }
- public Uri NodeHost { get; set; }
public static class AsperaClientConfigurationKeys
- public const string DatagramSize = "aspera-datagram-size"
- public const string NodeAccountPassword = "node-aspera-account-password"
- public const string NodeAccountUserName = "node-aspera-account-username"
- public const string NodeHost = "node-aspera-host"
public class AsperaUncBcpPathResolver : RemotePathResolverBase
- public AsperaUncBcpPathResolver(ITransferLog transferLog)
- public AsperaUncBcpPathResolver(string bcpUncPath, string rootFolder, ITransferLog transferLog)
- public AsperaUncBcpPathResolver()
- public AsperaUncBcpPathResolver(string bcpUncPath, string rootFolder)
public class AsperaUncPathResolver : RemotePathResolverBase
- public AsperaUncPathResolver(ITransferLog transferLog)
- public AsperaUncPathResolver(string fileShareUncPath, int docRootLevels, ITransferLog transferLog)
- public AsperaUncPathResolver()
- public AsperaUncPathResolver(string fileShareUncPath, int docRootLevels)

API Differences between 6.0.16 and 7.0.8

Relativity.Transfer

Relativity.Transfer.Aspera

Relativity.Transfer.Aspera.Enumeration.Filters

Relativity.Transfer.Dto

Relativity.Transfer.Enumeration

Relativity.Transfer.Enumeration.Filters

Relativity.Transfer.Enumeration.Interfaces

Relativity.Transfer.Paths

Relativity.Transfer.Resources