<PackageReference Include="Relativity.Server.Transfer.SDK" Version="24000.0.1" />

---

API Differences between 24000.0.1 and 25000.0.6

477 Additions 0 Removals

Aspera.Transfer

• public enum AclOption
  • METAFILE = 2
  • NATIVE = 1
  • NONE = 0
• public enum Cipher
  • AES_128 = 1
  • AES_192 = 2
  • AES_256 = 3
  • NONE = 0
• public enum DeleteSource
  • EMPTY_DIRECTORIES = 3
  • FILES_AND_DIRECTORIES = 2
  • FILES_ONLY = 1
  • NONE = 0
• public class Environment
  • public Environment()
  • public static string getFaspScpPath()
  • public static Version getFaspVersion()
  • public static int getManagementPort()
  • public static string getPortFilePath()
  • public static void setFaspScpPath(string faspScpPath)
  • public static void setManagementPort(int mgmtPort)
• public enum ExtendedAttributesOption
  • METAFILE = 2
  • NATIVE = 1
  • NONE = 0
• public class FaspManager
  • public bool AutoRemoveCompletedTransferReferences { get; set; }
  • public static void destroy()
  • public static FaspManager getInstance()
  • public void addJobListener(string jobId, FileTransferListener listener)
  • public void addListener(TransferListener listener)
  • public void addSource(string jobId, string sourcePath, string destPath, long startByte, long endByte)
  • public void addSource(string id, string sourcePath, string destPath)
  • public void cancelTransfer(string jobId)
  • public void enableFaspDebug(bool enabled)
  • public Version getReleaseVersion()
  • public ICollection getSessionIDList()
  • public SessionStats getSessionStats(string jobId)
  • public SessionStats getSessionStatsByCookie(string cookie)
  • public TraceSource getTraceSource()
  • public bool isListeningForServerSessions()
  • public bool isRunning()
  • public void listenForServerSessions(bool On)
  • public void lockPersistentSession(string jobId)
  • public void removeJobListener(string jobId, FileTransferListener listener)
  • public void removeListener(TransferListener listener)
  • public bool removeTransferReference(string sessionId)
  • public void setRate(string jobId, int targetRateKbps, int minRateKbps, Policy policy)
  • public string startTransfer(JobOrder order, FileTransferListener listener = null)
  • public string startTransfer(JobOrder order, Guid xferId, int xferRetry = 0, FileTransferListener listener = null)
  • public List<string> startTransfer(JobOrder order, int nbProcesses, FileTransferListener listener = null)
  • public List<string> startTransfer(JobOrder order, Guid xferId, int xferRetry = 0, int nbProcesses = 1, FileTransferListener listener = null)
  • public void stopTransfer(string jobId)
  • public void terminateTransfer(string jobId)
• public class FaspManagerException : Exception
• public enum FileChecksum
  • MD5 = 1
  • NONE = 2
  • SHA1 = 0
• public class FileLocation
  • public bool IsValidPairs { get; }
  • public string TempFileName { get; }
  • public FileLocation()
  • public void addPath(string filePath)
  • public void addPath(string inSrc, string inDest)
  • public string getFirstPath()
• public enum FileManifestFormat
  • NONE = 0
  • TEXT = 1
• public enum FileState
  • FAILED = 0
  • FINISHED = 1
  • SKIPPED = 3
  • TRANSFERRING = 2
• public class FileStats
  • public long contiguousBytes
  • public long endByte
  • public int errCode
  • public string errDescription
  • public string fileChecksum
  • public string fileChecksumType
  • public string name
  • public long sizeBytes
  • public long startByte
  • public FileState state
  • public long writtenBytes
  • public FileStats()
• public interface FileTransferListener : TransferListener
  • void fileSessionEvent(TransferEvent evnt, SessionStats sessionStats, FileStats fileStats)
• public class FileTransferSession : Session
  • public FileTransferSession(bool debugEnabled)
  • public FileTransferSession(JobOrder order, FileTransferListener listener, string jobId, bool debugEnabled)
  • public static string EscapeArguments(string[] args)
  • public string getCurrentFile()
  • public FileStats getCurrentFileStats()
  • public string getDestinationPath()
  • public SessionStats getSessionStats()
  • public string getSourcePath()
  • protected virtual void invokeListener(TransferEvent evnt)
• public class HTTPFallback
  • public HTTPFallback()
  • public HTTPFallback(int httpPort, bool encodeAllAsJPEG, string httpsKeyFileName, string httpsCertFileName, EndPoint httpProxyAddress)
• public class JobOrder
  • public JobOrder(FileLocation source, FileLocation destination, XferParams xferParams)
  • public FileLocation getDestination()
  • public FileLocation getSource()
  • public XferParams getXferParams()
  • public bool isUpload()
• public class LocalFileLocation : FileLocation
  • public LocalFileLocation()
• public enum OverwritePolicy
  • ALWAYS = 1
  • DIFFERENT = 0
  • DIFFERENT_AND_OLDER = 2
  • NEVER = 3
  • OLDER = 4
• public enum Policy
  • FAIR = 0
  • FIXED = 1
  • HIGH = 2
  • LOW = 3
• public class RemoteFileLocation : FileLocation
  • protected string host
  • protected string identity
  • protected string password
  • protected string user
  • public RemoteFileLocation(string host, string user, string password)
  • public RemoteFileLocation(string host, string user, string identity, string passphrase)
  • public string getHost()
  • public string getIdentity()
  • public string getPassword()
  • public string getUser()
  • public bool IsHostIPv6()
  • public bool IsPartialFileTransfer()
  • public void setByteRange(long start, long end)
• public enum Resume
  • FILE_ATTRIBUTES = 0
  • FULL_CHECKSUM = 1
  • OFF = 2
  • SPARSE_CHECKSUM = 3
• public abstract class Session
  • protected bool debugEnabled
  • protected bool firstTime
  • protected string msgBuffer
  • protected bool persistent
  • protected bool persistentSessionLocked
  • protected int pmtu
  • protected int sourcePathsScanAttempted
  • protected int sourcePathsScanExcluded
  • protected int sourcePathsScanFailed
  • protected int sourcePathsScanIrregular
  • protected JObject tags
  • protected int transfersAttempted
  • protected int transfersFailed
  • protected int transfersPassed
  • protected int transfersSkipped
  • protected Session(JobOrder order, string jobId, bool debug)
  • protected Session(bool debug)
  • public void addListener(TransferListener listener)
  • public void addSource(string sourcePath, string destPath, long startByte, long endByte)
  • public virtual void cancel()
  • public void close()
  • public ulong getBandwidthCapKbps()
  • public string getCookie()
  • public int getErrCode()
  • public string getErrDescription()
  • public string getHost()
  • public string getId()
  • public ulong getMinumumRateKbps()
  • public int getNbProcesses()
  • public bool getPersistentSessionLocked()
  • public Policy getPolicy()
  • public int getProcessIndex()
  • public int getRttMs()
  • public string getSessionId()
  • public int getStartTime()
  • public SessionState getState()
  • public ulong getTargetRateKbps()
  • public string getToken()
  • public long getTotalElapsedMs()
  • public ulong getTotalLostBytes()
  • public long getTotalTransferredBytes()
  • public ulong getTotalWrittenBytes()
  • public uint getUdpPort()
  • public string getUser()
  • public Guid getXferId()
  • public int getXferRetry()
  • public abstract void handleAscpCrash()
  • public bool isFinished()
  • public bool isRemote()
  • public bool isUpload()
  • public void removeListener(TransferListener listener)
  • protected virtual bool sendMgmtMessage(string msg)
  • public void setCookie(string userCookie)
  • public void setPersistent(bool persistent)
  • public virtual void setRate(int targetRate, int minimumRate, Policy policy)
  • public void setUserStr(string userStr)
  • public virtual void stop()
  • public virtual void stopWhenIdle()
  • public virtual void terminate()
• public enum SessionState
  • AUTHENTICATING = 1
  • CONNECTING = 2
  • FAILED = 3
  • FINISHED = 4
  • STARTED = 5
  • SUBMITTED = 0
  • TRANSFERRING = 6
• public class SessionStats
  • public ulong BandwidthCapKbps
  • public string ClientClusterId
  • public string ClientNodeId
  • public string Cookie
  • public uint DelayMs
  • public string DestPath
  • public string Direction
  • public ulong ElapsedUSec
  • public bool Encryption
  • public int ErrorCode
  • public string ErrorDescription
  • public ulong FilesComplete
  • public ulong FilesFailed
  • public ulong FilesSkipped
  • public string Host
  • public string Id
  • public string ManifestFilePath
  • public ulong MeasuredLinkRateKbps
  • public ulong MinRateKbps
  • public bool OtherInitiated
  • public int Pmtu
  • public Policy Policy
  • public ulong PreCalcTotalBytes
  • public ulong PreCalcTotalFiles
  • public bool Remote
  • public int RetryTimeout
  • public string ServerClusterId
  • public string ServerNodeId
  • public string SessionId
  • public string SourcePaths
  • public int SourcePathsScanAttempted
  • public int SourcePathsScanExcluded
  • public int SourcePathsScanFailed
  • public int SourcePathsScanIrregular
  • public DateTime StartTime
  • public SessionState State
  • public JObject Tags
  • public ulong TargetRateKbps
  • public uint TcpPort
  • public string Token
  • public ulong TotalLostBytes
  • public ulong TotalTransferredBytes
  • public ulong TotalWrittenBytes
  • public int TransfersAttempted
  • public int TransfersFailed
  • public int TransfersPassed
  • public int TransfersSkipped
  • public uint UdpPort
  • public string User
  • public Guid XferId
  • public int XferRetry
  • public SessionStats()
  • public SessionStats Clone()
• public enum SymLinkPolicy
  • COPY = 0
  • COPY_FORCE = 2
  • FOLLOW = 1
  • SKIP = 3
• public enum TransferEvent
  • CONNECTING = 9
  • FILE_ERROR = 0
  • FILE_SKIP = 3
  • FILE_START = 1
  • FILE_STOP = 2
  • PROGRESS = 8
  • RATE_MODIFICATION = 4
  • SESSION_ERROR = 5
  • SESSION_START = 6
  • SESSION_STOP = 7
• public interface TransferListener
• public class XferParams
  • public AclOption? aclOption
  • public string alternateConfigFile
  • public bool applyLocalDocroot
  • public bool autoDetectCapacity
  • public string checkSshFingerprint
  • public Cipher? cipher
  • public string contentProtectionPassphrase
  • public string cookie
  • public bool createDirs
  • public int datagramSize
  • public bool deleteBeforeTransfer
  • public DeleteSource deleteSource
  • public string destinationRoot
  • public bool encryption
  • public int? excludeNewerThan
  • public int? excludeOlderThan
  • public List<string> excludePatterns
  • public ExtendedAttributesOption? extendedAttributesOption
  • public FileChecksum fileChecksum
  • public FileManifestFormat fileManifestFormat
  • public string fileManifestPath
  • public HTTPFallback httpFallback
  • public bool ignoreSshFingerprint
  • public string localLogDir
  • public int minimumRateKbps
  • public string moveAfterTransferPath
  • public long multiSessionThreshold
  • public OverwritePolicy overwritePolicy
  • public string partialFileSuffix
  • public bool persist
  • public Policy policy
  • public bool preCalculateJobSize
  • public string prePostCommand
  • public bool preserveAccessTime
  • public bool preserveCreationTime
  • public bool preserveDates
  • public bool preserveFileOwnerGID
  • public bool preserveFileOwnerUID
  • public bool preserveModificationTime
  • public bool preserveSourceAccessTime
  • public int readSize
  • public AclOption? remoteAclOption
  • public ExtendedAttributesOption? remoteExtendedAttributesOption
  • public string remoteLogDir
  • public bool removeEmptyDirectories
  • public bool removeEmptySourceDirectory
  • public bool removeFileAfterTransfer
  • public bool reportSkippedFiles
  • public Resume? resumeCheck
  • public int? retransmissionRequestMaxSize
  • public int retryTimeoutS
  • public bool saveBeforeOverwriteEnabled
  • public bool skipDuplicateCheck
  • public bool skipSpecialFiles
  • public string sourceBase
  • public string sourceRoot
  • public SymLinkPolicy? symLinkPolicy
  • public JObject tags
  • public int targetRateKbps
  • public int tcpPort
  • public string token
  • public int udpPort
  • public int writeSize
  • public XferParams()
  • protected virtual JObject appendToAsperaTags()
  • protected virtual List<string> getExtendedOptions()

Relativity.Transfer

• public static class TransferClientConstants
  • public const string AsperaClientDisplayName = "Aspera"
  • public const string AsperaClientId = "812A70A5-7311-46CC-BE53-07BB8C5F9A7D"
  • public const string AsperaClientName = "Aspera"
• public enum WellKnownTransferClient
  • Aspera = 3

Relativity.Transfer.Aspera

• public enum AscpVersion
  • Experimental = 2
  • Stable = 1
• public class AsperaClientConfiguration : ClientConfiguration
  • public const AscpVersion DefaultAscpVersion = 1
  • public const bool DefaultConnectionCheckAsperaCredentialCacheEnable = true
  • public const bool DefaultCreateDirectories = true
  • public const int DefaultDatagramSize = 0
  • public const int DefaultDocRootLevels = 1
  • public const string DefaultEncryptionCipher = "AES_256"
  • public const bool DefaultFaspDebugEnabled = false
  • public const int DefaultHealthCheckLogMaxLine = 100
  • public const int DefaultMaxNonFatalStatsRetryAttempts = 5
  • public const int DefaultMetaThreadCount = 0
  • public const string DefaultOverwritePolicy = "ALWAYS"
  • public const string DefaultPartialFileSuffix = ".partial"
  • public const string DefaultPolicy = "FAIR"
  • public const int DefaultReadThreadCount = 0
  • public const string DefaultResumeCheck = "OFF"
  • public const string DefaultResumeSuffix = ".aspx"
  • public const bool DefaultSaveBeforeOverwriteEnabled = false
  • public const int DefaultScanThreadCount = 0
  • public const int DefaultTcpPort = 33001
  • public const string DefaultTestConnectionDestinationPath = "/FTA/TestConnectionResults"
  • public const int DefaultUdpPortEndRange = 33050
  • public const int DefaultUdpPortStartRange = 33001
  • public const bool DefaultUseAscp4 = false
  • public const int DefaultWriteThreadCount = 0
  • public string AccountPassword { get; set; }
  • public string AccountUserName { get; set; }
  • public AscpVersion AscpClientVersion { get; set; }
  • public bool CreateDirectories { get; set; }
  • public int DatagramSize { get; set; }
  • public int DocRootLevels { get; set; }
  • public string EncryptionCipher { get; set; }
  • public bool FaspDebugEnabled { get; set; }
  • public int HealthCheckLogMaxLine { get; set; }
  • public Uri Host { get; set; }
  • public bool LegacyPortCheck { get; set; }
  • public int MetaThreadCount { get; set; }
  • public string OverwritePolicy { get; set; }
  • public string PartialFileSuffix { get; set; }
  • public string Policy { get; set; }
  • public int ReadThreadCount { get; set; }
  • public bool ReportNotOverriddenFiles { get; set; }
  • public string ResumeCheck { get; set; }
  • public string ResumeSuffix { get; set; }
  • public bool SaveBeforeOverwriteEnabled { get; set; }
  • public int ScanThreadCount { get; set; }
  • public string SecurityToken { get; set; }
  • public string SshPassphrase { get; set; }
  • public string SshPrivateKeyFile { get; set; }
  • public int TcpPort { get; set; }
  • public string TestConnectionDestinationPath { get; set; }
  • public int UdpPortEndRange { get; set; }
  • public int UdpPortStartRange { get; set; }
  • public bool UseAscp4 { get; set; }
  • public int WriteThreadCount { get; set; }
  • public AsperaClientConfiguration()
  • public AsperaClientConfiguration(IDictionary<string, object> properties)
  • public AsperaClientConfiguration(ClientConfiguration configuration)
  • protected AsperaClientConfiguration(SerializationInfo info, StreamingContext context)
• public static class AsperaClientConfigurationKeys
  • public const string AccountPassword = "aspera-account-password"
  • public const string AccountUserName = "aspera-account-username"
  • public const string CreateDirectories = "aspera-create-directories"
  • public const string DatagramSize = "aspera-datagram-size"
  • public const string DocRootLevels = "aspera-doc-root-levels"
  • public const string EncryptionCipher = "aspera-encryption-cipher"
  • public const string FaspDebugEnabled = "aspera-fasp-debug-enabled"
  • public const string HealthCheckLogMaxLine = "health-check-log-max-line"
  • public const string Host = "aspera-host"
  • public const string LegacyPortCheck = "aspera-legacy-port-check"
  • public const string MetaThreadCount = "aspera-meta-threadcount"
  • public const string OverwritePolicy = "aspera-overwrite-policy"
  • public const string PartialFileSuffix = "aspera-partialfile-suffix"
  • public const string Policy = "aspera-policy"
  • public const string ReadThreadCount = "aspera-read-threadcount"
  • public const string ReportNotOverriddenFiles = "aspera-report-skipped-files"
  • public const string ResumeCheck = "aspera-resume-check"
  • public const string ResumeSuffix = "aspera-resume-suffix"
  • public const string SaveBeforeOverwriteEnabled = "aspera-save-before-overwrite-enabled"
  • public const string ScanThreadCount = "aspera-scan-threadcount"
  • public const string SecurityToken = "aspera-security-token"
  • public const string SshPassphrase = "aspera-ssh-passphrase"
  • public const string SshPrivateKeyFile = "aspera-ssh-private-key-file"
  • public const string TcpPort = "aspera-tcp-port"
  • public const string TestConnectionDestinationPath = "aspera-testconnection-destination-path"
  • public const string UdpPortEndRange = "aspera-udp-port-end-range"
  • public const string UdpPortStartRange = "aspera-udp-port-start-range"
  • public const string WriteThreadCount = "aspera-write-threadcount"
• public class AsperaConfigurationDetail : IConfigurationDetail
  • public AsperaConfigurationDetail()
  • public IEnumerable<ConfigurationDocItem> GetDocs()
• public class AsperaConnectionService : ConnectionServiceBase
  • public AsperaConnectionService(RelativityConnectionInfo connectionInfo, ClientConfiguration configuration, IFileSystemService fileSystemService, ITransferLog log, DiagnosticsContext context)
• public static class AsperaHealthCheckKeys
  • public const string AsperaLog = "aspera-log"
  • public const string ClientId = "client-id"
  • public const string DownloadTestResult = "download-test-result"
  • public const string Error = "error-message"
  • public const string PortTestResult = "port-test-result"
  • public const string SupportCheck = "support-check"
  • public const string UploadTestResult = "upload-test-result"
• public class AsperaUncBcpPathResolver : RemotePathResolverBase
  • public string BcpUncPath { get; set; }
  • public string RootFolder { get; set; }
  • public AsperaUncBcpPathResolver(ITransferLog transferLog)
  • public AsperaUncBcpPathResolver(string bcpUncPath, string rootFolder, ITransferLog transferLog)
• public class AsperaUncPathResolver : RemotePathResolverBase
  • public int DocRootLevels { get; set; }
  • public string FileShareUncPath { get; set; }
  • public AsperaUncPathResolver(ITransferLog transferLog)
  • public AsperaUncPathResolver(string fileShareUncPath, int docRootLevels, ITransferLog transferLog)
• public static class XferParamsExtensions
  • public static string Dump(this XferParams xferParams)

Relativity.Transfer.Aspera.Enumeration.Filters

• public class AspxExtensionFilter : INodeFilter, IFilter<INode>
  • public string Message { get; }
  • public AspxExtensionFilter()
  • public bool IsMet(INode node)
• public class PathLengthFilter : INodeFilter, IFilter<INode>
  • public string Message { get; }
  • public PathLengthFilter()
  • public bool IsMet(INode node)

Relativity.Transfer.Aspera.Issues

• public static class IssuesDumper
  • public static string Dump(IReadOnlyCollection<ITransferIssue> issues)