Class CopyFileWorker

A worker that copies a file, including between different file system volumes.

Also see the .Net classes Directory, Path and File.

Inheritance
Object
WorkerParent
WorkerBase
WorkerBase<CopyFileWorker>
CopyFileWorker
Implements
Inherited Members
Namespace: actionETL
Assembly: actionETL.dll
Syntax
public class CopyFileWorker : WorkerBase<CopyFileWorker>, IDisposeOnFinished

Constructors

CopyFileWorker(WorkerParent, String, Func<Boolean>, String, String)

Initializes a new instance of the CopyFileWorker worker. It copies a file, including between different file system volumes.

Overwrite defaults to false.

Declaration
public CopyFileWorker(WorkerParent workerParent, string workerName, Func<bool> isStartableFunc, string sourceFileName, string targetFileName)
Parameters
Type Name Description
WorkerParent workerParent

The parent worker or worker system that the new child worker will be added to. Cannot be null.
String workerName

Name of the worker.

Set to a prefix plus a trailing "/" (e.g. "MyPrefix-/") to generate a unique name from the prefix plus an increasing number starting at 1.

While less useful, set to null, whitespace or "/" to generate a unique name from the worker type plus an increasing number starting at 1.

The name cannot otherwise contain "/", and cannot start with double underscore "__".

Func<Boolean> isStartableFunc

Function to calculate the worker start constraint; it should return true for startable and false for not startable. Defaults to startable if null.
String sourceFileName

Name of the source file.
String targetFileName

Name of the target file.
Exceptions
Type Condition
ArgumentException

workerName:

  • Workers with the same parent must have unique names.
  • Worker and worker system names cannot contain '/' or start with double underscore '__'.
ArgumentNullException

workerParent - All workers must have a parent. The top level workers have the worker system as parent.
InvalidOperationException
  • Cannot add child worker to parent which has completed. Are you adding it to the correct parent?
  • Cannot add worker to parent, since its children have been started. Are you adding it to the correct parent?

CopyFileWorker(WorkerParent, String, Func<Boolean>, String, String, Boolean)

Initializes a new instance of the CopyFileWorker worker. It copies a file, including between different file system volumes.

Declaration
public CopyFileWorker(WorkerParent workerParent, string workerName, Func<bool> isStartableFunc, string sourceFileName, string targetFileName, bool overwrite)
Parameters
Type Name Description
WorkerParent workerParent

The parent worker or worker system that the new child worker will be added to. Cannot be null.
String workerName

Name of the worker.

Set to a prefix plus a trailing "/" (e.g. "MyPrefix-/") to generate a unique name from the prefix plus an increasing number starting at 1.

While less useful, set to null, whitespace or "/" to generate a unique name from the worker type plus an increasing number starting at 1.

The name cannot otherwise contain "/", and cannot start with double underscore "__".

Func<Boolean> isStartableFunc

Function to calculate the worker start constraint; it should return true for startable and false for not startable. Defaults to startable if null.
String sourceFileName

Name of the source file.
String targetFileName

Name of the target file.
Boolean overwrite

If set to true overwrite any existing file, otherwise fail the worker.
Exceptions
Type Condition
ArgumentException

workerName:

  • Workers with the same parent must have unique names.
  • Worker and worker system names cannot contain '/' or start with double underscore '__'.
ArgumentNullException

workerParent - All workers must have a parent. The top level workers have the worker system as parent.
InvalidOperationException
  • Cannot add child worker to parent which has completed. Are you adding it to the correct parent?
  • Cannot add worker to parent, since its children have been started. Are you adding it to the correct parent?

CopyFileWorker(WorkerParent, String, String, String)

Initializes a new instance of the CopyFileWorker worker. It copies a file, including between different file system volumes.

Overwrite defaults to false.

Declaration
public CopyFileWorker(WorkerParent workerParent, string workerName, string sourceFileName, string targetFileName)
Parameters
Type Name Description
WorkerParent workerParent

The parent worker or worker system that the new child worker will be added to. Cannot be null.
String workerName

Name of the worker.

Set to a prefix plus a trailing "/" (e.g. "MyPrefix-/") to generate a unique name from the prefix plus an increasing number starting at 1.

While less useful, set to null, whitespace or "/" to generate a unique name from the worker type plus an increasing number starting at 1.

The name cannot otherwise contain "/", and cannot start with double underscore "__".

String sourceFileName

Name of the source file.
String targetFileName

Name of the target file.
Exceptions
Type Condition
ArgumentException

workerName:

  • Workers with the same parent must have unique names.
  • Worker and worker system names cannot contain '/' or start with double underscore '__'.
ArgumentNullException

workerParent - All workers must have a parent. The top level workers have the worker system as parent.
InvalidOperationException
  • Cannot add child worker to parent which has completed. Are you adding it to the correct parent?
  • Cannot add worker to parent, since its children have been started. Are you adding it to the correct parent?

CopyFileWorker(WorkerParent, String, String, String, Boolean)

Initializes a new instance of the CopyFileWorker worker. It copies a file, including between different file system volumes.

Declaration
public CopyFileWorker(WorkerParent workerParent, string workerName, string sourceFileName, string targetFileName, bool overwrite)
Parameters
Type Name Description
WorkerParent workerParent

The parent worker or worker system that the new child worker will be added to. Cannot be null.
String workerName

Name of the worker.

Set to a prefix plus a trailing "/" (e.g. "MyPrefix-/") to generate a unique name from the prefix plus an increasing number starting at 1.

While less useful, set to null, whitespace or "/" to generate a unique name from the worker type plus an increasing number starting at 1.

The name cannot otherwise contain "/", and cannot start with double underscore "__".

String sourceFileName

Name of the source file.
String targetFileName

Name of the target file.
Boolean overwrite

If set to true overwrite any existing file, otherwise fail the worker.
Exceptions
Type Condition
ArgumentException

workerName:

  • Workers with the same parent must have unique names.
  • Worker and worker system names cannot contain '/' or start with double underscore '__'.
ArgumentNullException

workerParent - All workers must have a parent. The top level workers have the worker system as parent.
InvalidOperationException
  • Cannot add child worker to parent which has completed. Are you adding it to the correct parent?
  • Cannot add worker to parent, since its children have been started. Are you adding it to the correct parent?

Properties

SourceFileName

Gets or sets the name of the source file. Cannot be set after the worker has started running.

Note: This property is thread-safe.

Declaration
public string SourceFileName { get; set; }
Property Value
Type Description
String
Exceptions
Type Condition
InvalidOperationException

Cannot set the value after the worker has started running.

TargetFileName

Gets or sets the name of the target file. Cannot be set after the worker has started running.

Note: This property is thread-safe.

Declaration
public string TargetFileName { get; set; }
Property Value
Type Description
String
Exceptions
Type Condition
InvalidOperationException

Cannot set the value after the worker has started running.

Methods

RunAsync()

This method can be overridden to add custom functionality to the derived worker that runs before and after the file processing. In this case, the base class base.RunAsync() must be called for the worker to function correctly.

Typically, this worker is used without overriding this method.

Declaration
protected override Task<OutcomeStatus> RunAsync()
Returns
Type Description
Task<OutcomeStatus>

A Task describing the success or failure of the worker. An asynchronous async implementation would e.g. return OutcomeStatus.Succeeded on success, while a synchronous implementation would return OutcomeStatus.SucceededTask.
Overrides

Implements

See Also