AbstractFileSystemProgressLoggingJob Class

Abstract class incorporating logging of job's progress.

Inheritance Hierarchy

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

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

Syntax

public abstract class AbstractFileSystemProgressLoggingJob : AbstractFileSystemJob

The AbstractFileSystemProgressLoggingJob type exposes the following members.

Properties

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

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. (Inherited from AbstractFileSystemJob.)
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. (Inherited from AbstractFileSystemJob.)
Protected method Static member	GetLogObjectName(BaseInfo)	Gets display name or code name or GUID or ID of provided info.
Protected method Static member	GetLogObjectName(ObjectTypeInfo, BaseInfo)	Gets display name or code name or GUID or ID of provided info.
Protected method	GetNewJobWithSharedResources<TJob>	Gets new job of TJob using factoryJobGetter and initializes it with all properties used in InitializeWith``1(UMP, RepositoryPathHelper, ContinuousIntegrationTranslationHelper, FileSystemBindingsProcessor, IFileSystemWriter, ICachedFileSystemReader, SeparatedFieldProcessor, Nullable<Boolean>, Nullable<Boolean>) of the job calling this method. (Inherited from AbstractFileSystemJob.)
Protected method	GetNewJobWithSharedResourcesAndHandlers<TJob>	Gets new job of TJob using factoryJobGetter and initializes it with all properties used in InitializeWith``1(UMP, RepositoryPathHelper, ContinuousIntegrationTranslationHelper, FileSystemBindingsProcessor, IFileSystemWriter, ICachedFileSystemReader, SeparatedFieldProcessor, Nullable<Boolean>, Nullable<Boolean>) and registers all handlers using SetLogProgressHandler``1(UMP, EventHandler<LogProgressEventArgs>) of the job calling this method.
Protected method	CheckContinuousIntegrationLicense	Check license requirement for Continuous Integration and throws LicenseException if they are not met. (Inherited from AbstractFileSystemJob.)
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. (Inherited from AbstractFileSystemJob.)
Protected method	RaiseLogProgress(LogItem)	Logs message to progress log.
Protected method	RaiseLogProgress(String, LogItemTypeEnum, LogItemActionTypeEnum)	Logs message to progress log.
Protected method	RegisterTranslationRecord	Registers a new translation record into TranslationHelper. (Inherited from AbstractFileSystemJob.)

Remarks

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