51Degrees Pipeline for .NET

FiftyOneExtensions Class Reference

Detailed Description

Class that holds the static extension methods that are added to various MVC classes.

Static Public Member Functions

static IApplicationBuilder UseFiftyOne (this IApplicationBuilder builder)
 Directs the MVC ApplicationBuilder to use the 51Degrees middleware component to provide Pipeline functionality.
static void AddFiftyOne< TBuilder > (this IServiceCollection services, IConfiguration configuration, Func< IConfiguration, IPipelineBuilderFromConfiguration, IPipeline > pipelineFactory=null)
 Configures the specified service collection with the services required by IPipeline.
static void AddFiftyOne< TBuilder > (this IServiceCollection services, IConfiguration configuration, Func< IServiceProvider, IConfiguration, IPipelineBuilderFromConfiguration, IPipeline > pipelineFactory)
static void AddFiftyOne (this IServiceCollection services, IConfiguration configuration, Func< IConfiguration, IPipelineBuilderFromConfiguration, IPipeline > pipelineFactory=null)
 Configures the specified service collection with the services required by IPipeline.
static void AddFiftyOne (this IServiceCollection services, IConfiguration configuration, Func< IServiceProvider, IConfiguration, IPipelineBuilderFromConfiguration, IPipeline > pipelineFactory)

Member Function Documentation

◆ AddFiftyOne()

void FiftyOneExtensions.AddFiftyOne ( this IServiceCollection services,
IConfiguration configuration,
Func< IConfiguration, IPipelineBuilderFromConfiguration, IPipeline > pipelineFactory = null )
static

Configures the specified service collection with the services required by IPipeline.

The FiftyOnePipelineBuilder is used to build the pipeline. To change this, use the generic override of this method.

Parameters
servicesThe DI container
configurationThe configuration object
pipelineFactoryThe function to use when building the pipeline. By default, this will use the configuration from PipelineOptions

◆ AddFiftyOne< TBuilder >() [1/2]

void FiftyOneExtensions.AddFiftyOne< TBuilder > ( this IServiceCollection services,
IConfiguration configuration,
Func< IConfiguration, IPipelineBuilderFromConfiguration, IPipeline > pipelineFactory = null )
static

Configures the specified service collection with the services required by IPipeline.

Template Parameters
TBuilderThe type of pipeline builder to use when building the pipeline.
Parameters
servicesThe DI container
configurationThe configuration object
pipelineFactoryThe function to use when building the pipeline. By default, this will use the configuration from PipelineOptions
Type Constraints
TBuilder :class 
TBuilder :IPipelineBuilderFromConfiguration 

◆ AddFiftyOne< TBuilder >() [2/2]

void FiftyOneExtensions.AddFiftyOne< TBuilder > ( this IServiceCollection services,
IConfiguration configuration,
Func< IServiceProvider, IConfiguration, IPipelineBuilderFromConfiguration, IPipeline > pipelineFactory )
static

Type Constraints
TBuilder :class 
TBuilder :IPipelineBuilderFromConfiguration 

◆ UseFiftyOne()

IApplicationBuilder FiftyOneExtensions.UseFiftyOne ( this IApplicationBuilder builder)
static

Directs the MVC ApplicationBuilder to use the 51Degrees middleware component to provide Pipeline functionality.

Note: if any of the ExceptionHandlerExtensions.UseExceptionHandler methods are used, they MUST be called before this method in order to correctly handle exception.

Parameters
builderThe IApplicationBuilder
Returns
The IApplicationBuilder