Class EntityCommandEndpointBase<TKey, TListModel, TReadModel, TCreateModel, TUpdateModel>

Namespace

Arbiter.CommandQuery.Endpoints

Assembly

Arbiter.CommandQuery.Endpoints.dll

Provides a base class for defining RESTful command endpoints for an entity, including create, update, upsert, patch, and delete operations.

public abstract class EntityCommandEndpointBase<TKey, TListModel, TReadModel, TCreateModel, TUpdateModel> : EntityQueryEndpointBase<TKey, TListModel, TReadModel>, IEndpointRoute

Type Parameters

TKey

The type of the entity key.

TListModel

The type of the list model returned by queries.

TReadModel

The type of the read model returned by single-entity queries and commands.

TCreateModel

The type of the model used to create a new entity.

TUpdateModel

The type of the model used to update or patch an entity.

Inheritance

object

EntityQueryEndpointBase<TKey, TListModel, TReadModel>

EntityCommandEndpointBase<TKey, TListModel, TReadModel, TCreateModel, TUpdateModel>

Implements

IEndpointRoute

Inherited Members

EntityQueryEndpointBase<TKey, TListModel, TReadModel>.EntityName

EntityQueryEndpointBase<TKey, TListModel, TReadModel>.RoutePrefix

EntityQueryEndpointBase<TKey, TListModel, TReadModel>.Logger

EntityQueryEndpointBase<TKey, TListModel, TReadModel>.AddRoutes(IEndpointRouteBuilder)

EntityQueryEndpointBase<TKey, TListModel, TReadModel>.MapGroup(RouteGroupBuilder)

EntityQueryEndpointBase<TKey, TListModel, TReadModel>.GetQuery(IMediator, TKey, ClaimsPrincipal, CancellationToken)

EntityQueryEndpointBase<TKey, TListModel, TReadModel>.GetPagedQuery(IMediator, string, string, int?, int?, ClaimsPrincipal, CancellationToken)

EntityQueryEndpointBase<TKey, TListModel, TReadModel>.PostPagedQuery(IMediator, EntityQuery, ClaimsPrincipal, CancellationToken)

EntityQueryEndpointBase<TKey, TListModel, TReadModel>.GetSelectQuery(IMediator, string, string, ClaimsPrincipal, CancellationToken)

EntityQueryEndpointBase<TKey, TListModel, TReadModel>.PostSelectQuery(IMediator, EntitySelect, ClaimsPrincipal, CancellationToken)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

This class extends EntityQueryEndpointBase<TKey, TListModel, TReadModel> to provide endpoints for entity command operations. It is intended for use in applications to standardize CRUD API patterns.

Constructors

EntityCommandEndpointBase(ILoggerFactory, string, string?)

Initializes a new instance of the EntityCommandEndpointBase<TKey, TListModel, TReadModel, TCreateModel, TUpdateModel> class.

protected EntityCommandEndpointBase(ILoggerFactory loggerFactory, string entityName, string? routePrefix = null)

Parameters

loggerFactory ILoggerFactory

The logger factory to create an ILogger for this endpoint.

entityName string

The name of the entity for this endpoint.

routePrefix string

The route prefix for this endpoint. If not set, entityName is used.

Methods

CreateCommand(IMediator, TCreateModel, ClaimsPrincipal?, CancellationToken)

Creates a new entity using the provided create model and the mediator service.

protected virtual Task<Results<Ok<TReadModel>, ProblemHttpResult>> CreateCommand(IMediator mediator, TCreateModel createModel, ClaimsPrincipal? user = null, CancellationToken cancellationToken = default)

Parameters

mediator IMediator

The IMediator to send the request to.

createModel TCreateModel

The model containing data for the new entity.

user ClaimsPrincipal

The current security claims principal.

cancellationToken CancellationToken

The request cancellation token.

Returns

Task<Results<Ok<TReadModel>, ProblemHttpResult>>

An awaitable task returning either Ok<TValue> with the created entity or ProblemHttpResult on error.

DeleteCommand(IMediator, TKey, ClaimsPrincipal?, CancellationToken)

Deletes an existing entity by its identifier using the mediator service.

protected virtual Task<Results<Ok<TReadModel>, ProblemHttpResult>> DeleteCommand(IMediator mediator, TKey id, ClaimsPrincipal? user = null, CancellationToken cancellationToken = default)

Parameters

mediator IMediator

The IMediator to send the request to.

id TKey

The identifier of the entity to delete.

user ClaimsPrincipal

The current security claims principal.

cancellationToken CancellationToken

The request cancellation token.

Returns

Task<Results<Ok<TReadModel>, ProblemHttpResult>>

An awaitable task returning either Ok<TValue> with the deleted entity or ProblemHttpResult on error.

GetUpdateQuery(IMediator, TKey, ClaimsPrincipal?, CancellationToken)

Retrieves an entity for update by its identifier using the mediator service.

protected virtual Task<Results<Ok<TUpdateModel>, ProblemHttpResult>> GetUpdateQuery(IMediator mediator, TKey id, ClaimsPrincipal? user = null, CancellationToken cancellationToken = default)

Parameters

mediator IMediator

The IMediator to send the request to.

id TKey

The identifier of the entity to retrieve.

user ClaimsPrincipal

The current security claims principal.

cancellationToken CancellationToken

The request cancellation token.

Returns

Task<Results<Ok<TUpdateModel>, ProblemHttpResult>>

An awaitable task returning either Ok<TValue> with the update model or ProblemHttpResult on error.

MapGroup(RouteGroupBuilder)

Maps the command endpoints for the entity, including create, update, upsert, patch, and delete operations.

protected override void MapGroup(RouteGroupBuilder group)

Parameters

group RouteGroupBuilder

The RouteGroupBuilder used to define the endpoint group.

Remarks

This method adds endpoints for:

• GET {id}/update - Retrieve an entity for update
• POST - Create a new entity
• POST {id} - Upsert (create or update) an entity
• PUT {id} - Update an entity
• PATCH {id} - Patch an entity using a JSON patch document
• DELETE {id} - Delete an entity

PatchCommand(IMediator, TKey, JsonPatchDocument, ClaimsPrincipal?, CancellationToken)

Applies a JSON patch document to an existing entity using the mediator service.

protected virtual Task<Results<Ok<TReadModel>, ProblemHttpResult>> PatchCommand(IMediator mediator, TKey id, JsonPatchDocument jsonPatch, ClaimsPrincipal? user = null, CancellationToken cancellationToken = default)

Parameters

mediator IMediator

The IMediator to send the request to.

id TKey

The identifier of the entity to patch.

jsonPatch JsonPatchDocument

The JSON patch document describing the changes.

user ClaimsPrincipal

The current security claims principal.

cancellationToken CancellationToken

The request cancellation token.

Returns

Task<Results<Ok<TReadModel>, ProblemHttpResult>>

An awaitable task returning either Ok<TValue> with the patched entity or ProblemHttpResult on error.

UpdateCommand(IMediator, TKey, TUpdateModel, ClaimsPrincipal?, CancellationToken)

Updates an existing entity using the provided update model and the mediator service.

protected virtual Task<Results<Ok<TReadModel>, ProblemHttpResult>> UpdateCommand(IMediator mediator, TKey id, TUpdateModel updateModel, ClaimsPrincipal? user = null, CancellationToken cancellationToken = default)

Parameters

mediator IMediator

The IMediator to send the request to.

id TKey

The identifier of the entity to update.

updateModel TUpdateModel

The model containing updated data for the entity.

user ClaimsPrincipal

The current security claims principal.

cancellationToken CancellationToken

The request cancellation token.

Returns

Task<Results<Ok<TReadModel>, ProblemHttpResult>>

An awaitable task returning either Ok<TValue> with the updated entity or ProblemHttpResult on error.

UpsertCommand(IMediator, TKey, TUpdateModel, ClaimsPrincipal?, CancellationToken)

Creates or updates an entity using the provided update model and the mediator service.

protected virtual Task<Results<Ok<TReadModel>, ProblemHttpResult>> UpsertCommand(IMediator mediator, TKey id, TUpdateModel updateModel, ClaimsPrincipal? user = null, CancellationToken cancellationToken = default)

Parameters

mediator IMediator

The IMediator to send the request to.

id TKey

The identifier of the entity to upsert.

updateModel TUpdateModel

The model containing data for the entity.

user ClaimsPrincipal

The current security claims principal.

cancellationToken CancellationToken

The request cancellation token.

Returns

Task<Results<Ok<TReadModel>, ProblemHttpResult>>

An awaitable task returning either Ok<TValue> with the upserted entity or ProblemHttpResult on error.