AbstractFileSystemJob Class

Abstract class incorporating usual properties and basic methods for inter-job usage.

Inheritance Hierarchy

System.Object
  CMS.ContinuousIntegration.Internal.AbstractFileSystemJob
    CMS.ContinuousIntegration.Internal.AbstractFileSystemProgressLoggingJob
    CMS.ContinuousIntegration.Internal.AbstractSingleObjectJob

Namespace: CMS.ContinuousIntegration.Internal
Assembly: CMS.ContinuousIntegration (in CMS.ContinuousIntegration.dll) Version: 12.0.0

Syntax

public abstract class AbstractFileSystemJob

The AbstractFileSystemJob type exposes the following members.

Constructors

	Name	Description
Protected method	AbstractFileSystemJob	Constructor required for creation of a new instance of derived class.

Properties

	Name	Description
Protected property	ContentStagingTaskCollection	Object for collecting content staging tasks during CI restore.
Protected property	RepositoryConfiguration	Gets the current instance of repository configuration
Protected property	RepositoryPathHelper	Object for working with file paths in file system repository.
Protected property	TranslationHelper	Provides object translation. Used in serialization to optimize database calls.
Protected property	UseFileMetadata	Indicates whether objects' file meta-data are used or not (see FileMetadataInfo).

Methods

	Name	Description
Protected method	CancellableForEach<T>(CancellationToken, IEnumerable<T>, Action<T>)	Enumerates through collection checking cancellationToken before each iteration and performing action on each item in the collection.
Protected method	CancellableForEach<T>(CancellationToken, IEnumerable<T>, Action<T, Int32>)	Enumerates through collection checking cancellationToken before each iteration and performing action on each item in the collection.
Protected method	CheckContinuousIntegrationLicense	Check license requirement for Continuous Integration and throws LicenseException if they are not met.
Protected method	GetNewJobWithSharedResources<TJob>	Gets new job of TJob using factoryJobGetter and initializes it with all properties used in InitializeWith``1(UMP, FileSystemJobConfiguration) of the job calling this method.
Protected method	InitializeCancellationToken	If provided cancellationToken is not null, the token is used; otherwise, new CancellationToken is created so as the derived class does not need to null-checked each token's use.
Protected method	RegisterTranslationRecord	Registers a new translation record into TranslationHelper.

Remarks

This class is not intended for inheritance. Non-abstract jobs are supposed to be used for behavioral amendments.