Class CoreActuatorServiceCollectionExtensions

Inheritance

System.Object

CoreActuatorServiceCollectionExtensions

Namespace: Steeltoe.Management.Endpoint

Assembly: Steeltoe.Management.Endpoint.dll

Syntax

public static class CoreActuatorServiceCollectionExtensions : object

Methods

| Edit this page View Source

AddCoreActuatorServices<TEndpointOptions, TConfigureEndpointOptions, TMiddleware, TEndpointHandlerInterface, TEndpointHandler, TRequest, TResponse>(IServiceCollection, Boolean)

Registers endpoint options configuration, middleware, and handler as singleton services.

This low-level extension method is intended to be called when implementing custom actuator endpoints.

Declaration

public static IServiceCollection AddCoreActuatorServices<TEndpointOptions, TConfigureEndpointOptions, TMiddleware, TEndpointHandlerInterface, TEndpointHandler, TRequest, TResponse>(this IServiceCollection services, bool configureMiddleware)
    where TEndpointOptions : EndpointOptions where TConfigureEndpointOptions : class, IConfigureOptionsWithKey<TEndpointOptions> where TMiddleware : class, IEndpointMiddleware where TEndpointHandlerInterface : class, IEndpointHandler<TRequest, TResponse> where TEndpointHandler : class, TEndpointHandlerInterface

Parameters

Type	Name	Description
IServiceCollection	services	The to add services to.
System.Boolean	configureMiddleware	When `false`, skips configuration of the ASP.NET Core middleware pipeline. While this provides full control over the pipeline order, it requires manual addition of the appropriate middleware for actuators to work correctly.

Returns

Type	Description
IServiceCollection	The incoming `services` so that additional calls can be chained.

Type Parameters

Name	Description
TEndpointOptions	The actuator-specific EndpointOptions to configure.
TConfigureEndpointOptions	The actuator-specific EndpointOptions configurer.
TMiddleware	The actuator-specific IEndpointMiddleware.
TEndpointHandlerInterface	The actuator-specific IEndpointHandler<TRequest, TResponse> interface.
TEndpointHandler	The actuator-specific IEndpointHandler<TRequest, TResponse> implementation.
TRequest	The actuator-specific endpoint handler input type.
TResponse	The actuator-specific endpoint handler output type.

| Edit this page View Source

ConfigureActuatorEndpoints(IServiceCollection, Action<IEndpointConventionBuilder>)

Configures an to customize the mapped actuator endpoints.

Declaration

public static IServiceCollection ConfigureActuatorEndpoints(this IServiceCollection services, Action<IEndpointConventionBuilder> configureEndpoints)

Parameters

Type	Name	Description
IServiceCollection	services	The to add services to.
Action<IEndpointConventionBuilder>	configureEndpoints	Takes an to customize the mapped endpoints. Useful for tailoring auth requirements.

Returns

Type	Description
IServiceCollection	The incoming `services` so that additional calls can be chained.

| Edit this page View Source

ConfigureActuatorsCorsPolicy(IServiceCollection, Action<CorsPolicyBuilder>)

Configures an to customize the Cross-Origin Resource Sharing (CORS) policy that applies to all actuator endpoints.

Declaration

public static IServiceCollection ConfigureActuatorsCorsPolicy(this IServiceCollection services, Action<CorsPolicyBuilder> configureCorsPolicy)

Parameters

Type	Name	Description
IServiceCollection	services	The to add services to.
Action<CorsPolicyBuilder>	configureCorsPolicy	Takes an to customize the policy. Useful to restrict access.

Returns

Type	Description
IServiceCollection	The incoming `services` so that additional calls can be chained.