Class BaseStartup

Namespace

Whipstaff.AspNetCore

Assembly

Whipstaff.AspNetCore.dll

Core Initialization logic.

public abstract class BaseStartup : IWhipstaffWebAppStartup

Inheritance

object

BaseStartup

Implements

IWhipstaffWebAppStartup

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

BaseStartup()

protected BaseStartup()

Methods

ConfigureAspireServiceDefaults(IHostApplicationBuilder)

Allows the application to configure the Aspire service defaults.

public abstract void ConfigureAspireServiceDefaults(IHostApplicationBuilder builder)

Parameters

builder IHostApplicationBuilder

Host Application builder to modify.

ConfigureAuthorization(AuthorizationOptions)

Configures Authorization policies.

protected abstract void ConfigureAuthorization(AuthorizationOptions authorizationOptions)

Parameters

authorizationOptions AuthorizationOptions

Authorization options instance to modify.

ConfigureLogging(ILoggingBuilder, ConfigurationManager, IWebHostEnvironment)

Configures logging for the application.

public abstract void ConfigureLogging(ILoggingBuilder loggingBuilder, ConfigurationManager configuration, IWebHostEnvironment environment)

Parameters

loggingBuilder ILoggingBuilder

Logging Builder to configure.

configuration ConfigurationManager

Application configuration.

environment IWebHostEnvironment

Web Host environment.

ConfigureServices(IServiceCollection, ConfigurationManager, IWebHostEnvironment)

Configures services for the application.

public void ConfigureServices(IServiceCollection services, ConfigurationManager configuration, IWebHostEnvironment environment)

Parameters

services IServiceCollection

The service collection to configure.

configuration ConfigurationManager

Application configuration.

environment IWebHostEnvironment

Web Host environment.

ConfigureWebApplication(WebApplication)

Configures the web application.

public void ConfigureWebApplication(WebApplication applicationBuilder)

Parameters

applicationBuilder WebApplication

The application builder to configure.

GetAuditDataProvider()

Gets the data provider to use for audit logging.

protected abstract AuditDataProvider? GetAuditDataProvider()

Returns

AuditDataProvider

Audit Data Provider to use, if any.

GetConfigureAuthenticationDetails()

Gets the default schema and an action to use when configuring authentication. If null, no authentication will be configured.

protected abstract (string DefaultScheme, Action<AuthenticationBuilder, IConfiguration, IWebHostEnvironment> BuilderAction)? GetConfigureAuthenticationDetails()

Returns

(string DefaultScheme, Action<AuthenticationBuilder, IConfiguration, IWebHostEnvironment> BuilderAction)?

The default schema and an action to use when running the configuration of authentication, or null.

GetControllerAssemblies()

Gets the assemblies that contain controllers.

protected abstract Assembly[] GetControllerAssemblies()

Returns

Assembly[]

Array of assemblies.

GetMediatrRegistration()

Gets a mediatr registration object. This is used to avoid reflection.

protected abstract IMediatrRegistration GetMediatrRegistration()

Returns

IMediatrRegistration

Array of assemblies.

GetMvcServiceMode()

Gets the mode to configure MVC services with.

protected abstract MvcServiceMode GetMvcServiceMode()

Returns

MvcServiceMode

MVC Service Mode to use.

GetOnUseEndpointsAction()

Gets the action to use when configuring the controllers.

protected abstract Action<IEndpointRouteBuilder>? GetOnUseEndpointsAction()

Returns

Action<IEndpointRouteBuilder>

Action to execute, or null if no endpoints to be registered.

GetSwaggerEndpoints()

Gets the swagger endpoints to register on the UI.

protected abstract IEnumerable<(string Url, string Name)>? GetSwaggerEndpoints()

Returns

IEnumerable<(string Url, string Name)>

Collection of Swagger endpoints.

OnConfigure(IApplicationBuilder, IWebHostEnvironment, ILoggerFactory)

Carry out application specific configuration.

protected abstract void OnConfigure(IApplicationBuilder app, IWebHostEnvironment env, ILoggerFactory loggerFactory)

Parameters

app IApplicationBuilder

Application instance.

env IWebHostEnvironment

Web Host Environment instance.

loggerFactory ILoggerFactory

Logger factory instance.

OnConfigureServices(IServiceCollection)

Configure app specific services.

protected abstract void OnConfigureServices(IServiceCollection serviceCollection)

Parameters

serviceCollection IServiceCollection

Service Collection to modify.