Relativity.Transfer.Client 6.3.7

API Differences between 6.3.7 and 5.0.2

143 Additions 40 Removals

Relativity.Transfer

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 const bool DefaultPreCalculateJobSize = false
- public bool PreCalculateJobSize { get; set; }
- public bool SavingMemoryMode { get; set; }
public static class ClientConfigurationKeys
- public const string AscpVersion = "ascp-version"
- public const string PreCalculateJobSize = "pre-calculate-jobsize"
- public const string SavingMemoryMode = "saving-memory-mode"
- public const string UseAscp4 = "use-ascp4"
public class ClientLimits
- public int? MaxClientSupportedPathLength { get; set; }
- public int? TransferFileNameLength { get; set; }
- public int MaxSupportedPathLength { get; set; }
- public int TransferFileNameLength { get; set; }
public class EnumeratedPathsResult
- public IEnumerable<string> ErrorPaths { get; }
- public IEnumerable<ErrorPath> ErrorPaths { get; }
- public EnumeratedPathsResult(IEnumerable<string> searchPaths, IEnumerable<TransferPath> paths, IEnumerable<string> errorPaths, long totalDirectories, bool localPaths, TimeSpan elapsed)
- public EnumeratedPathsResult(IEnumerable<string> searchPaths, IEnumerable<TransferPath> paths, IEnumerable<ErrorPath> errorPaths, long totalDirectories, bool localPaths, TimeSpan elapsed)
public class ErrorPath
- public string Path { get; set; }
- public string Reason { get; set; }
- public ErrorPath(string path, string reason)
public class GlobalSettings : IGlobalSettings
- public const int DefaultMaxAllowedTargetDataRateMbps = 600
- public int MaxAllowedTargetDataRateMbps { get; set; }
public interface IAuthenticationTokenProvider
- string GenerateToken()
public interface IBatchSerializer
- void AddTransferPath(TransferPath path)
- Task<SerializedPathsResult> CreateBatchAsync()
public interface IHttpCredential
- void RefreshCredentials()
public class IntegratedSecurityCredential : IHttpCredential
- public void RefreshCredentials()
public interface IPathValidationFactory
- IPathValidationProvider CreatePathValidationProvider()
public interface IPathValidationProvider : IPathValidator
- void Register(IPathValidator pathValidator)
public interface IPathValidator
- PathValidationResult Validate(TransferPath transferPath)
- void Validate(IEnumerable<string> searchPaths, string targetPath)
public interface IRelativityServiceFactory
- IPathValidationProvider PathValidationProvider { get; }
- ITargetRateThrottler CreateTargetRateThrottler()
- ITargetRateValidator CreateTargetRateValidator()
public interface ITargetRateThrottler
- void ThrottleToMaxAllowedValue(ClientConfiguration configuration)
- int ThrottleToMaxAllowedValue(int targetRateMbps)
public interface ITargetRateValidator
- void Validate(int minRateMbps, int targetRateMbps)
- void Validate(ClientConfiguration configuration)
public interface ITransferClient : IDisposable
- ClientLimits ClientLimits { get; }
- IBatchSerializer CreateBatchSerializer(string batchDirectory, TransferDirection direction, PathEnumeratorContext context)
public interface ITransferIssue : IEquatable<ITransferIssue>
- bool IsRetryable { get; }
public interface ITransferIssueBuilder
- ITransferIssue Build()
- ITransferIssueBuilder FromJobPath(JobTransferPath jobPath)
- ITransferIssueBuilder FromPath(TransferPath jobPath)
- ITransferIssueBuilder WithAttributes(IssueAttributes attributes)
- ITransferIssueBuilder WithIndex(int index)
- ITransferIssueBuilder WithMaxRetryAttempts(int maxRetryAttempts)
- ITransferIssueBuilder WithMessage(string message)
- ITransferIssueBuilder WithRetryable(bool retrayable)
- ITransferIssueBuilder WithRetryAttempt(int retryAttempt)
public interface ITransferJob : IDisposable
- void ChangeDataRate(int minRateMbps, int targetRateMbps)
- void ChangeDataRate(int minRateMbps, int targetRateMbps, CancellationToken token)
- Task ChangeDataRateAsync(int minRateMbps, int targetRateMbps)
- Task ChangeDataRateAsync(int minRateMbps, int targetRateMbps, CancellationToken token)
- int ChangeDataRate(int minRateMbps, int targetRateMbps)
- int ChangeDataRate(int minRateMbps, int targetRateMbps, CancellationToken token)
- Task<int> ChangeDataRateAsync(int minRateMbps, int targetRateMbps)
- Task<int> ChangeDataRateAsync(int minRateMbps, int targetRateMbps, CancellationToken token)
- void ValidatePath(TransferPath path)
- PathValidationResult ValidatePath(TransferPath path)
public interface ITransferJobService
- void Initialize()
- bool IsCompleted(TransferPathStatus status)
- bool IsRetrayable(TransferPathStatus status)
public class LargeFileProgress : IProgress<LargeFileProgressEventArgs>
- public double LargeFileProgressRateSeconds { get; }
- public LargeFileProgress(Action<LargeFileProgressEventArgs> handler, double largeFileProgressRateSeconds, JobTransferPath jobTransferPath)
- public LargeFileProgress(Action<LargeFileProgressEventArgs> handler, double largeFileProgressRateSeconds)
- public void Report(LargeFileProgressEventArgs value)
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 abstract class PathEnumeratorBase : IPathEnumerator
- protected ClientLimits ClientLimits { get; }
- protected PathEnumeratorBase(ITransferLog log, ClientLimits limits, IFileSystemService fileSystemService)
public static class PathHelper
- public static string GetTargetFilePath(string sourcePath, string targetPath, string targetFileName)
public class PathValidationProvider : IPathValidationProvider, IPathValidator
- public PathValidationProvider()
- public void Register(IPathValidator pathValidator)
- public PathValidationResult Validate(TransferPath transferPath)
- public void Validate(IEnumerable<string> searchPaths, string targetPath)
public class PathValidationResult
- public string ErrorMessage { get; }
- public bool IsOk { get; }
- public PathValidationStatus Status { get; }
- public TransferPath ValidatedPath { get; }
- public static PathValidationResult Error(TransferPath validatedPath, PathValidationStatus status, string errorMessage)
- public static PathValidationResult Ok(TransferPath transferPath)
- public ErrorPath CreatesErrorPath()
public enum PathValidationStatus
- Ok = 0
- SourcePathTooLong = 1
- TargetPathToLong = 2
- WrongFileType = 3
public sealed class SerializedPathsResult
- public IEnumerable<string> ErrorPaths { get; }
- public IEnumerable<ErrorPath> ErrorPaths { get; }
- public SerializedPathsResult(IEnumerable<string> searchPaths, IEnumerable<SerializedBatch> batches, IEnumerable<string> errorPaths, bool localPaths, TimeSpan elapsed)
- public SerializedPathsResult(IEnumerable<string> searchPaths, IEnumerable<SerializedBatch> batches, IEnumerable<ErrorPath> errorPaths, bool localPaths, TimeSpan elapsed)
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, IFileSystemService fileSystemService, Guid id, WellKnownTransferClient client, string name, string displayName)
- 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)
- public IBatchSerializer CreateBatchSerializer(string batchDirectory, TransferDirection direction, PathEnumeratorContext context)
public sealed class TransferContext
- public event EventHandler<TransferPathIssueEventArgs> TransferJobIssue
- public void PublishTransferJobIssue(ITransferRequest request, ITransferIssue issue)
public class TransferIssue : ITransferIssue, IEquatable<ITransferIssue>
- public bool IsRetryable { get; set; }
public abstract class TransferJobBase : ITransferJob, IDisposable
- public int? ClientMaxSupportedPathLength { get; set; }
- public int? ClientTransferFileNameLength { get; set; }
- public void ChangeDataRate(int minRateMbps, int targetRateMbps)
- public void ChangeDataRate(int minRateMbps, int targetRateMbps, CancellationToken token)
- public Task ChangeDataRateAsync(int minRateMbps, int targetRateMbps)
- public Task ChangeDataRateAsync(int minRateMbps, int targetRateMbps, CancellationToken token)
- public int ChangeDataRate(int minRateMbps, int targetRateMbps)
- public int ChangeDataRate(int minRateMbps, int targetRateMbps, CancellationToken token)
- public Task<int> ChangeDataRateAsync(int minRateMbps, int targetRateMbps)
- public Task<int> ChangeDataRateAsync(int minRateMbps, int targetRateMbps, CancellationToken token)
- protected void LogErrorPath(string path)
- public void ValidatePath(TransferPath path)
- protected void ValidateSourcePathLength(TransferPath path)
- public PathValidationResult ValidatePath(TransferPath path)
- protected virtual void ValidateTargetPathLength(TransferPath path)
public class TransferJobService : ITransferJobService
- public IPathStatusChecker RetryablePathChecker { get; set; }
- public void Initialize()
- public bool IsCompleted(TransferPathStatus status)
- public bool IsRetrayable(TransferPathStatus status)
public abstract class TransferPathCommandBase : ITransferPathCommand
- protected void PublishTransferJobIssue(ITransferIssue issue)
- protected bool ShouldPublishLargeFileProgress(int chunkNumber, int totalChunks, DateTime timestamp)
public class TransferPathIssueEventArgs : EventArgs
- public bool IsRetryable { get; }
public class TransferPathProgressEventArgs : EventArgs
- public bool Completed { get; }
- 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 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 class TransferPathResult
- public bool Completed { get; set; }
- public string TargetFile { get; }

Relativity.Transfer.Aspera

public enum AscpVersion
- Experimental = 2
- Stable = 1
public class AsperaClientConfiguration : ClientConfiguration
- public const AscpVersion DefaultAscpVersion = 1
- public const int DefaultDatagramSize = 0
- public const string DefaultResumeSuffix = ".aspx"
- public const bool DefaultUseAscp4 = false
- public AscpVersion AscpClientVersion { get; set; }
- public int DatagramSize { get; set; }
- public string ResumeSuffix { get; set; }
- public bool UseAscp4 { get; set; }
public static class AsperaClientConfigurationKeys
- public const string DatagramSize = "aspera-datagram-size"
- public const string ResumeSuffix = "aspera-resume-suffix"

Relativity.Transfer.Paths

public interface IPathStatusChecker
- bool IsCompleted(TransferPathStatus status)
- bool IsRetrayable(TransferPathStatus status)

Relativity.Transfer.Resources

public class CoreStrings
- public static string CantChangeDataRateOnDisposedError { get; }
- public static string LocalDriveInformation { get; }
- public static string MinDataRateArgumentExceptionMessage { get; }
- public static string MinDataRateBelowZeroExceptionMessage { get; }
- public static string MinDataRateOverMaxAllowedValueExceptionMessage { get; }
- public static string SourcePathDoesNotContainAFilenameMessage { get; }
- public static string TargetDataRateArgumentExceptionMessage { get; }
- public static string TargetDataRateBelowZeroExceptionMessage { get; }
- public static string TargetDataRateOverMaxAllowedValueExceptionMessage { get; }
- public static string TransferJobErrorMessage { get; }
- public static string UnsupportedFileExtensionError { get; }
- public static string UnsupportedFileExtensionMessage { get; }
- public static string UnsupportedValidationResult { get; }