Relativity.DataExchange.Transfer.TapiBridgeBase2

TapiBridgeBase2

public abstract class TapiBridgeBase2 : ITapiBridge, IDisposable

Represents a class object to provide a bridge from the Transfer API to existing Import/Export code.

Documentation

public TapiClient Client { get; }

public Guid ClientId { get; }

Gets the current transfer client unique identifier.

public Guid InstanceId { get; }

public TapiTotals JobTotals { get; }

protected ILog Logger { get; }

Gets the Relativity logging instance.

public TapiBridgeParameters2 Parameters { get; }

protected bool RaisedPermissionIssue { get; }

Gets a value indicating whether any permission related transfer issue has been raised.

protected string RaisedPermissionIssueMessage { get; }

Gets the permission related transfer issue message.

public string TargetPath { get; set; }

Gets or sets the target path.

protected ITransferJob TransferJob { get; }

Gets the current transfer job.

protected ITransferLog TransferLog { get; }

Gets the ITransferLog instance.

public bool TransfersPending { get; }

Gets a value indicating whether there are transfers pending.

public int WorkspaceId { get; }

Gets the workspace artifact unique identifier.

public event EventHandler<TapiClientEventArgs> TapiClientChanged

public event EventHandler<TapiMessageEventArgs> TapiErrorMessage

public event EventHandler<TapiMessageEventArgs> TapiFatalError

public event EventHandler<TapiLargeFileProgressEventArgs> TapiLargeFileProgress

public event EventHandler<TapiProgressEventArgs> TapiProgress

public event EventHandler<TapiStatisticsEventArgs> TapiStatistics

public event EventHandler<TapiMessageEventArgs> TapiStatusMessage

public event EventHandler<TapiMessageEventArgs> TapiWarningMessage

protected static TransferContext CreateDefaultTransferContext(TapiBridgeParameters2 parameters)

Creates the default transfer context object.

public string AddPath(TransferPath path)

protected virtual ClientConfiguration CreateClientConfiguration()

Creates client configuration.

public virtual void CreateTransferClient()

protected abstract TransferRequest CreateTransferRequestForJob(TransferContext context)

Creates transfer request for job.

public void Dispose()

public virtual void LogTransferParameters()

Logs all transfer bridge parameters.

protected abstract void SetupRemotePathResolvers(ITransferRequest request)

Setup the customer resolvers for both source and target paths.

protected abstract string TransferFileFatalMessage()

Specifies the fatal error message.

public TapiTotals WaitForTransfers(string waitMessage, string successMessage, string errorMessage, bool keepJobAlive)