Class FileSystemRepositoryManager

Namespace

CMS.ContinuousIntegration

Assembly

CMS.ContinuousIntegration.dll

Manages file system repository for continuous integration - stores and restores supported objects to and from the repository. Ensures mutual exclusion of the repository access across processes.

public class FileSystemRepositoryManager

Inheritance

object

FileSystemRepositoryManager

Extension Methods

DataExtensions.With<T>(T, Action<T>)

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Remarks

This class is responsible for the synchronization of objects de/serialization to the repository.

Members of this class are thread-safe.

Constructors

FileSystemRepositoryManager()

Private constructor ensures uniqueness of singleton class.

protected FileSystemRepositoryManager()

Exceptions

RepositoryConfigurationException

Thrown when loading of repository configuration fails.

Methods

Delete(BaseInfo)

Deletes given object from the file system repository, if this object's serialization is enabled by the repository configuration.

public static bool Delete(BaseInfo info)

Parameters

info BaseInfo

Returns

bool

Returns true if the object has been removed from the repository, false otherwise (i.e. object type is not to be included in the repository).

Exceptions

ArgumentNullException

Thrown when info is null.

InvalidOperationException

Thrown when RestoreAllInternal(Action<LogItem>, CancellationToken?) is running (in current or any other process), thus preventing the repository access.

RepositoryConfigurationException

Thrown when loading of repository configuration fails.

Dispose()

Releases all resources used by the current instance of the FileSystemRepositoryManager class.

public void Dispose()

Dispose(bool)

When overridden in a derived class, releases the unmanaged resources used by the FileSystemRepositoryManager, and optionally releases the managed resources.

protected virtual void Dispose(bool disposing)

Parameters

disposing bool

True to release both managed and unmanaged resources; false to release only unmanaged resources.

Remarks

The FileSystemRepositoryManager uses only managed resources. If unmanaged resources are used in inherited class, make sure its destructor contains call to Dispose(false) (i.e. this class does not have any destructor implemented).

RestoreAll(Action<LogItem>, CancellationToken?)

Restores all supported objects from the file system repository.

public static RepositoryActionResult RestoreAll(Action<LogItem> messageHandler = null, CancellationToken? cancellationToken = null)

Parameters

messageHandler Action<LogItem>

Handler with messages from restore process.

cancellationToken CancellationToken?

Operation can be canceled at any time using given cancellation token. This method's operation terminates as soon as cancellation request is detected.

Returns

RepositoryActionResult

Returns result object of the restoring process. Successful restoring is indicating by Success flag.

Remarks

Storing of all and storing of individual objects (Store(BaseInfo), Delete(BaseInfo)) is disabled when restoring of all objects is running.

Exceptions

RepositoryConfigurationException

Thrown when loading of repository configuration fails.

Store(BaseInfo)

Stores given object to the file system repository, if this object's serialization is enabled by the repository configuration.

public static bool Store(BaseInfo info)

Parameters

info BaseInfo

Returns

bool

Returns true if the object has been stored, false otherwise (i.e. object type is not to be included in the repository).

Exceptions

ArgumentNullException

Thrown when info is null.

InvalidOperationException

Thrown when RestoreAll(Action<LogItem>, CancellationToken?) is running (in current or any other process), thus preventing the repository access.

RepositoryConfigurationException

Thrown when loading of repository configuration fails.

StoreAll(Action<LogItem>, CancellationToken?)

Stores all supported objects to the file system repository.

public static RepositoryActionResult StoreAll(Action<LogItem> messageHandler = null, CancellationToken? cancellationToken = null)

Parameters

messageHandler Action<LogItem>

Handler with messages from store process.

cancellationToken CancellationToken?

Operation can be canceled at any time using given cancellation token. This method's operation terminates as soon as cancellation request is detected.

Returns

RepositoryActionResult

Returns result object of the restoring process. Successful restoring is indicating by Success flag.

Remarks

Target location on the file system will be cleaned up before storing.

Restoring of all is disabled when storing of all objects is running.

Exceptions

RepositoryConfigurationException

Thrown when loading of repository configuration fails.