StorageProviderBase<TParsedOptions, TInstanceOptions, TStoreOptions, TScopedStoreOptions>

Namespace: Proffer.Storage.Internal

A base provider to handle and build file stores pointing on a particular storage system location.

public abstract class StorageProviderBase<TParsedOptions, TInstanceOptions, TStoreOptions, TScopedStoreOptions> : Proffer.Storage.IStorageProvider

Type Parameters

TParsedOptions
The type of the parsed options.

TInstanceOptions
The type of the provider instance options.

TStoreOptions
The type of the store options.

TScopedStoreOptions
The type of the scoped store options.

Inheritance ObjectStorageProviderBase<TParsedOptions, TInstanceOptions, TStoreOptions, TScopedStoreOptions>
Implements IStorageProvider

Properties

Name

Gets the name of this provider.

public abstract string Name { get; }

Property Value

String

Constructors

StorageProviderBase(IOptions<TParsedOptions>)

Initializes a new instance of the StorageProviderBase<TParsedOptions, TInstanceOptions, TStoreOptions, TScopedStoreOptions> class.

public StorageProviderBase(IOptions<TParsedOptions> options)

Parameters

options IOptions<TParsedOptions>
The options.

Methods

BuildStore(String)

Builds a store from configured options.

public IStore BuildStore(string storeName)

Parameters

storeName String
The name of the store.

Returns

IStore

        A configured .

Exceptions

StoreNotFoundException

BuildStore(String, IStoreOptions)

Builds a store with specific options.

public IStore BuildStore(string storeName, IStoreOptions storeOptions)

Parameters

storeName String
The name of the store.

storeOptions IStoreOptions
The store options.

Returns

IStore

        A configured .

BuildScopedStore(String, Object[])

Builds a scoped store from configured options.

public IStore BuildScopedStore(string storeName, Object[] args)

Parameters

storeName String
The name of the store.

args Object[]
The arguments to apply to the scoped store name format.

Returns

IStore

        A configured .

Exceptions

StoreNotFoundException

BadScopedStoreConfiguration

BuildStoreInternal(String, TStoreOptions)

Provider-specific build of a store with specific options.

protected abstract IStore BuildStoreInternal(string storeName, TStoreOptions storeOptions)

Parameters

storeName String
The name of the store.

storeOptions TStoreOptions
The store options.

Returns

IStore

        A configured .