Class ApizrRegistryBuilder

Namespace

Apizr.Configuring.Registry

Assembly

Apizr.dll

Registry builder options available for static registrations

public class ApizrRegistryBuilder : IApizrRegistryBuilder, IApizrRegistryBuilder<IApizrRegistry, IApizrRegistryBuilder, IApizrProperOptionsBuilder, IApizrCommonOptionsBuilder>, IApizrRegistryBuilderBase<IApizrRegistry, IApizrRegistryBuilder, IApizrProperOptionsBuilder, IApizrCommonOptionsBuilder>, IApizrRegistryBuilderBase

Inheritance

object

ApizrRegistryBuilder

Implements

IApizrRegistryBuilder

IApizrRegistryBuilder<IApizrRegistry, IApizrRegistryBuilder, IApizrProperOptionsBuilder, IApizrCommonOptionsBuilder>

IApizrRegistryBuilderBase<IApizrRegistry, IApizrRegistryBuilder, IApizrProperOptionsBuilder, IApizrCommonOptionsBuilder>

IApizrRegistryBuilderBase

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Extension Methods

FileTransferOptionsBuilderExtensions.AddDownloadManager(IApizrRegistryBuilder, Action<IApizrProperOptionsBuilder>)

FileTransferOptionsBuilderExtensions.AddDownloadManagerFor<TDownloadApi>(IApizrRegistryBuilder, Action<IApizrProperOptionsBuilder>)

FileTransferOptionsBuilderExtensions.AddDownloadManagerFor<TDownloadApi, TDownloadParams>(IApizrRegistryBuilder, Action<IApizrProperOptionsBuilder>)

FileTransferOptionsBuilderExtensions.AddDownloadManagerWith<TDownloadParams>(IApizrRegistryBuilder, Action<IApizrProperOptionsBuilder>)

FileTransferOptionsBuilderExtensions.AddTransferManager(IApizrRegistryBuilder, Action<IApizrProperOptionsBuilder>)

FileTransferOptionsBuilderExtensions.AddTransferManagerFor<TTransferApi>(IApizrRegistryBuilder, Action<IApizrProperOptionsBuilder>)

FileTransferOptionsBuilderExtensions.AddTransferManagerFor<TTransferApi, TDownloadParams>(IApizrRegistryBuilder, Action<IApizrProperOptionsBuilder>)

FileTransferOptionsBuilderExtensions.AddTransferManagerFor<TTransferApi, TDownloadParams, TUploadApiResultData>(IApizrRegistryBuilder, Action<IApizrProperOptionsBuilder>)

FileTransferOptionsBuilderExtensions.AddTransferManagerWith<TDownloadParams, TUploadApiResultData>(IApizrRegistryBuilder, Action<IApizrProperOptionsBuilder>)

FileTransferOptionsBuilderExtensions.AddUploadManager(IApizrRegistryBuilder, Action<IApizrProperOptionsBuilder>)

FileTransferOptionsBuilderExtensions.AddUploadManagerFor<TUploadApi>(IApizrRegistryBuilder, Action<IApizrProperOptionsBuilder>)

FileTransferOptionsBuilderExtensions.AddUploadManagerFor<TUploadApi, TUploadApiResultData>(IApizrRegistryBuilder, Action<IApizrProperOptionsBuilder>)

FileTransferOptionsBuilderExtensions.AddUploadManagerWith<TUploadApiResultData>(IApizrRegistryBuilder, Action<IApizrProperOptionsBuilder>)

Fields

CommonOptions

The common options

protected readonly IApizrCommonOptions CommonOptions

Field Value

IApizrCommonOptions

Registry

The registry

protected readonly ApizrRegistry Registry

Field Value

ApizrRegistry

Properties

ApizrRegistry

Apizr registry

public IApizrRegistry ApizrRegistry { get; }

Property Value

IApizrRegistry

Methods

AddCrudManagerFor<T>(Action<IApizrProperOptionsBuilder>)

Create a ApizrManager<TWebApi> instance for T object type (class), with key of type int and "ReadAll" query result of type IEnumerable<T> and ReadAll query parameters of type IDictionary{string,object}

public IApizrRegistryBuilder AddCrudManagerFor<T>(Action<IApizrProperOptionsBuilder> optionsBuilder = null) where T : class

Parameters

optionsBuilder Action<IApizrProperOptionsBuilder>

The builder defining some api proper options

Returns

IApizrRegistryBuilder

Type Parameters

T

The object type to manage with crud api calls (class)

AddCrudManagerFor<T, TKey>(Action<IApizrProperOptionsBuilder>)

Create a ApizrManager<TWebApi> instance for T object type (class), with key of type TKey (primitive) and "ReadAll" query result of type IEnumerable<T> and ReadAll query parameters of type IDictionary{string,object}

public IApizrRegistryBuilder AddCrudManagerFor<T, TKey>(Action<IApizrProperOptionsBuilder> properOptionsBuilder = null) where T : class

Parameters

properOptionsBuilder Action<IApizrProperOptionsBuilder>

Returns

IApizrRegistryBuilder

Type Parameters

T

The object type to manage with crud api calls (class)

TKey

The object key type (primitive)

AddCrudManagerFor<T, TKey, TReadAllResult>(Action<IApizrProperOptionsBuilder>)

Create a ApizrManager<TWebApi> instance for T object type (class), with key of type TKey (primitive) and "ReadAll" query result of type TReadAllResult and ReadAll query parameters of type IDictionary{string,object}

public IApizrRegistryBuilder AddCrudManagerFor<T, TKey, TReadAllResult>(Action<IApizrProperOptionsBuilder> properOptionsBuilder = null) where T : class

Parameters

properOptionsBuilder Action<IApizrProperOptionsBuilder>

Returns

IApizrRegistryBuilder

Type Parameters

T

The object type to manage with crud api calls (class)

TKey

The object key type (primitive)

TReadAllResult

"ReadAll" query result type (should inherit from IEnumerable<T> or be of class type)

AddCrudManagerFor<T, TKey, TReadAllResult, TReadAllParams>(Action<IApizrProperOptionsBuilder>)

Create a ApizrManager<TWebApi> instance for T object type (class), with key of type TKey (primitive) and "ReadAll" query result of type TReadAllResult and ReadAll query parameters type (inheriting from IDictionary{string,object} or be of class type)

public IApizrRegistryBuilder AddCrudManagerFor<T, TKey, TReadAllResult, TReadAllParams>(Action<IApizrProperOptionsBuilder> properOptionsBuilder = null) where T : class

Parameters

properOptionsBuilder Action<IApizrProperOptionsBuilder>

Returns

IApizrRegistryBuilder

Type Parameters

T

The object type to manage with crud api calls (class)

TKey

The object key type (primitive)

TReadAllResult

"ReadAll" query result type (should inherit from IEnumerable<T> or be of class type)

TReadAllParams

ReadAll query parameters

AddCrudManagerFor<T, TKey, TReadAllResult, TReadAllParams, TApizrManager>(Func<ILazyFactory<ICrudApi<T, TKey, TReadAllResult, TReadAllParams>>, IConnectivityHandler, ICacheHandler, IMappingHandler, ILazyFactory<ResiliencePipelineRegistry<string>>, IApizrManagerOptions<ICrudApi<T, TKey, TReadAllResult, TReadAllParams>>, TApizrManager>, Action<IApizrProperOptionsBuilder>)

Create a TApizrManager instance for a managed crud api for T object (class), with key of type TKey (primitive) and "ReadAll" query result of type TReadAllResult and ReadAll query parameters type (inheriting from IDictionary{string,object} or be of class type)

public IApizrRegistryBuilder AddCrudManagerFor<T, TKey, TReadAllResult, TReadAllParams, TApizrManager>(Func<ILazyFactory<ICrudApi<T, TKey, TReadAllResult, TReadAllParams>>, IConnectivityHandler, ICacheHandler, IMappingHandler, ILazyFactory<ResiliencePipelineRegistry<string>>, IApizrManagerOptions<ICrudApi<T, TKey, TReadAllResult, TReadAllParams>>, TApizrManager> apizrManagerFactory, Action<IApizrProperOptionsBuilder> properOptionsBuilder = null) where T : class where TApizrManager : IApizrManager<ICrudApi<T, TKey, TReadAllResult, TReadAllParams>>

Parameters

apizrManagerFactory Func<ILazyFactory<ICrudApi<T, TKey, TReadAllResult, TReadAllParams>>, IConnectivityHandler, ICacheHandler, IMappingHandler, ILazyFactory<ResiliencePipelineRegistry<string>>, IApizrManagerOptions<ICrudApi<T, TKey, TReadAllResult, TReadAllParams>>, TApizrManager>

The custom manager implementation instance factory

properOptionsBuilder Action<IApizrProperOptionsBuilder>

The builder defining some api proper options

Returns

IApizrRegistryBuilder

Type Parameters

T

The object type to manage with crud api calls (class)

TKey

The object key type (primitive)

TReadAllResult

"ReadAll" query result type (should inherit from IEnumerable<T> or be of class type)

TReadAllParams

ReadAll query parameters

TApizrManager

A custom IApizrManager<TWebApi> implementation

AddGroup(Action<IApizrRegistryBuilder>, Action<IApizrCommonOptionsBuilder>)

Group registrations sharing specific common options

public IApizrRegistryBuilder AddGroup(Action<IApizrRegistryBuilder> registryGroupBuilder, Action<IApizrCommonOptionsBuilder> commonOptionsBuilder = null)

Parameters

registryGroupBuilder Action<IApizrRegistryBuilder>

The registry group

commonOptionsBuilder Action<IApizrCommonOptionsBuilder>

The group common options

Returns

IApizrRegistryBuilder

AddManagerFor<TWebApi>(Action<IApizrProperOptionsBuilder>)

Create a ApizrManager<TWebApi> instance

public IApizrRegistryBuilder AddManagerFor<TWebApi>(Action<IApizrProperOptionsBuilder> properOptionsBuilder = null)

Parameters

properOptionsBuilder Action<IApizrProperOptionsBuilder>

Returns

IApizrRegistryBuilder

Type Parameters

TWebApi

The web api interface to manage

AddManagerFor<TWebApi, TApizrManager>(Func<ILazyFactory<TWebApi>, IConnectivityHandler, ICacheHandler, IMappingHandler, ILazyFactory<ResiliencePipelineRegistry<string>>, IApizrManagerOptions<TWebApi>, TApizrManager>, Action<IApizrProperOptionsBuilder>)

Create a TApizrManager instance for a managed TWebApi

public IApizrRegistryBuilder AddManagerFor<TWebApi, TApizrManager>(Func<ILazyFactory<TWebApi>, IConnectivityHandler, ICacheHandler, IMappingHandler, ILazyFactory<ResiliencePipelineRegistry<string>>, IApizrManagerOptions<TWebApi>, TApizrManager> apizrManagerFactory, Action<IApizrProperOptionsBuilder> properOptionsBuilder = null) where TApizrManager : IApizrManager<TWebApi>

Parameters

apizrManagerFactory Func<ILazyFactory<TWebApi>, IConnectivityHandler, ICacheHandler, IMappingHandler, ILazyFactory<ResiliencePipelineRegistry<string>>, IApizrManagerOptions<TWebApi>, TApizrManager>

The custom manager implementation instance factory

properOptionsBuilder Action<IApizrProperOptionsBuilder>

The builder defining some api proper options

Returns

IApizrRegistryBuilder

Type Parameters

TWebApi

The web api interface to manage

TApizrManager

A custom IApizrManager<TWebApi> implementation