Class BaseFileDownloadController<TGetRequestDto, TQueryDto>

Namespace

Whipstaff.AspNetCore.FileTransfer

Assembly

Whipstaff.AspNetCore.dll

Base class for a controller that serves a file with a mime\type.

public abstract class BaseFileDownloadController<TGetRequestDto, TQueryDto> : Controller, IActionFilter, IAsyncActionFilter, IFilterMetadata, IDisposable where TQueryDto : IAuditableRequest<TGetRequestDto, FileNameAndStreamModel?>

Type Parameters

TGetRequestDto

The type for the api request dto.

TQueryDto

The type for the CQRS query dto.

Inheritance

object

ControllerBase

Controller

BaseFileDownloadController<TGetRequestDto, TQueryDto>

Implements

IActionFilter

IAsyncActionFilter

IFilterMetadata

IDisposable

Inherited Members

Controller.View()

Controller.View(string)

Controller.View(object)

Controller.View(string, object)

Controller.PartialView()

Controller.PartialView(string)

Controller.PartialView(object)

Controller.PartialView(string, object)

Controller.ViewComponent(string)

Controller.ViewComponent(Type)

Controller.ViewComponent(string, object)

Controller.ViewComponent(Type, object)

Controller.Json(object)

Controller.Json(object, object)

Controller.OnActionExecuting(ActionExecutingContext)

Controller.OnActionExecuted(ActionExecutedContext)

Controller.OnActionExecutionAsync(ActionExecutingContext, ActionExecutionDelegate)

Controller.Dispose()

Controller.Dispose(bool)

Controller.ViewData

Controller.TempData

Controller.ViewBag

ControllerBase.StatusCode(int)

ControllerBase.StatusCode(int, object)

ControllerBase.Content(string)

ControllerBase.Content(string, string)

ControllerBase.Content(string, string, Encoding)

ControllerBase.Content(string, MediaTypeHeaderValue)

ControllerBase.NoContent()

ControllerBase.Ok()

ControllerBase.Ok(object)

ControllerBase.Redirect(string)

ControllerBase.RedirectPermanent(string)

ControllerBase.RedirectPreserveMethod(string)

ControllerBase.RedirectPermanentPreserveMethod(string)

ControllerBase.LocalRedirect(string)

ControllerBase.LocalRedirectPermanent(string)

ControllerBase.LocalRedirectPreserveMethod(string)

ControllerBase.LocalRedirectPermanentPreserveMethod(string)

ControllerBase.RedirectToAction()

ControllerBase.RedirectToAction(string)

ControllerBase.RedirectToAction(string, object)

ControllerBase.RedirectToAction(string, string)

ControllerBase.RedirectToAction(string, string, object)

ControllerBase.RedirectToAction(string, string, string)

ControllerBase.RedirectToAction(string, string, object, string)

ControllerBase.RedirectToActionPreserveMethod(string, string, object, string)

ControllerBase.RedirectToActionPermanent(string)

ControllerBase.RedirectToActionPermanent(string, object)

ControllerBase.RedirectToActionPermanent(string, string)

ControllerBase.RedirectToActionPermanent(string, string, string)

ControllerBase.RedirectToActionPermanent(string, string, object)

ControllerBase.RedirectToActionPermanent(string, string, object, string)

ControllerBase.RedirectToActionPermanentPreserveMethod(string, string, object, string)

ControllerBase.RedirectToRoute(string)

ControllerBase.RedirectToRoute(object)

ControllerBase.RedirectToRoute(string, object)

ControllerBase.RedirectToRoute(string, string)

ControllerBase.RedirectToRoute(string, object, string)

ControllerBase.RedirectToRoutePreserveMethod(string, object, string)

ControllerBase.RedirectToRoutePermanent(string)

ControllerBase.RedirectToRoutePermanent(object)

ControllerBase.RedirectToRoutePermanent(string, object)

ControllerBase.RedirectToRoutePermanent(string, string)

ControllerBase.RedirectToRoutePermanent(string, object, string)

ControllerBase.RedirectToRoutePermanentPreserveMethod(string, object, string)

ControllerBase.RedirectToPage(string)

ControllerBase.RedirectToPage(string, object)

ControllerBase.RedirectToPage(string, string)

ControllerBase.RedirectToPage(string, string, object)

ControllerBase.RedirectToPage(string, string, string)

ControllerBase.RedirectToPage(string, string, object, string)

ControllerBase.RedirectToPagePermanent(string)

ControllerBase.RedirectToPagePermanent(string, object)

ControllerBase.RedirectToPagePermanent(string, string)

ControllerBase.RedirectToPagePermanent(string, string, string)

ControllerBase.RedirectToPagePermanent(string, string, object, string)

ControllerBase.RedirectToPagePreserveMethod(string, string, object, string)

ControllerBase.RedirectToPagePermanentPreserveMethod(string, string, object, string)

ControllerBase.File(byte[], string)

ControllerBase.File(byte[], string, bool)

ControllerBase.File(byte[], string, string)

ControllerBase.File(byte[], string, string, bool)

ControllerBase.File(byte[], string, DateTimeOffset?, EntityTagHeaderValue)

ControllerBase.File(byte[], string, DateTimeOffset?, EntityTagHeaderValue, bool)

ControllerBase.File(byte[], string, string, DateTimeOffset?, EntityTagHeaderValue)

ControllerBase.File(byte[], string, string, DateTimeOffset?, EntityTagHeaderValue, bool)

ControllerBase.File(Stream, string)

ControllerBase.File(Stream, string, bool)

ControllerBase.File(Stream, string, string)

ControllerBase.File(Stream, string, string, bool)

ControllerBase.File(Stream, string, DateTimeOffset?, EntityTagHeaderValue)

ControllerBase.File(Stream, string, DateTimeOffset?, EntityTagHeaderValue, bool)

ControllerBase.File(Stream, string, string, DateTimeOffset?, EntityTagHeaderValue)

ControllerBase.File(Stream, string, string, DateTimeOffset?, EntityTagHeaderValue, bool)

ControllerBase.File(string, string)

ControllerBase.File(string, string, bool)

ControllerBase.File(string, string, string)

ControllerBase.File(string, string, string, bool)

ControllerBase.File(string, string, DateTimeOffset?, EntityTagHeaderValue)

ControllerBase.File(string, string, DateTimeOffset?, EntityTagHeaderValue, bool)

ControllerBase.File(string, string, string, DateTimeOffset?, EntityTagHeaderValue)

ControllerBase.File(string, string, string, DateTimeOffset?, EntityTagHeaderValue, bool)

ControllerBase.PhysicalFile(string, string)

ControllerBase.PhysicalFile(string, string, bool)

ControllerBase.PhysicalFile(string, string, string)

ControllerBase.PhysicalFile(string, string, string, bool)

ControllerBase.PhysicalFile(string, string, DateTimeOffset?, EntityTagHeaderValue)

ControllerBase.PhysicalFile(string, string, DateTimeOffset?, EntityTagHeaderValue, bool)

ControllerBase.PhysicalFile(string, string, string, DateTimeOffset?, EntityTagHeaderValue)

ControllerBase.PhysicalFile(string, string, string, DateTimeOffset?, EntityTagHeaderValue, bool)

ControllerBase.Unauthorized()

ControllerBase.Unauthorized(object)

ControllerBase.NotFound()

ControllerBase.NotFound(object)

ControllerBase.BadRequest()

ControllerBase.BadRequest(object)

ControllerBase.BadRequest(ModelStateDictionary)

ControllerBase.UnprocessableEntity()

ControllerBase.UnprocessableEntity(object)

ControllerBase.UnprocessableEntity(ModelStateDictionary)

ControllerBase.Conflict()

ControllerBase.Conflict(object)

ControllerBase.Conflict(ModelStateDictionary)

ControllerBase.Problem(string, string, int?, string, string)

ControllerBase.ValidationProblem(ValidationProblemDetails)

ControllerBase.ValidationProblem(ModelStateDictionary)

ControllerBase.ValidationProblem()

ControllerBase.ValidationProblem(string, string, int?, string, string, ModelStateDictionary)

ControllerBase.Created()

ControllerBase.Created(string, object)

ControllerBase.Created(Uri, object)

ControllerBase.CreatedAtAction(string, object)

ControllerBase.CreatedAtAction(string, object, object)

ControllerBase.CreatedAtAction(string, string, object, object)

ControllerBase.CreatedAtRoute(string, object)

ControllerBase.CreatedAtRoute(object, object)

ControllerBase.CreatedAtRoute(string, object, object)

ControllerBase.Accepted()

ControllerBase.Accepted(object)

ControllerBase.Accepted(Uri)

ControllerBase.Accepted(string)

ControllerBase.Accepted(string, object)

ControllerBase.Accepted(Uri, object)

ControllerBase.AcceptedAtAction(string)

ControllerBase.AcceptedAtAction(string, string)

ControllerBase.AcceptedAtAction(string, object)

ControllerBase.AcceptedAtAction(string, string, object)

ControllerBase.AcceptedAtAction(string, object, object)

ControllerBase.AcceptedAtAction(string, string, object, object)

ControllerBase.AcceptedAtRoute(object)

ControllerBase.AcceptedAtRoute(string)

ControllerBase.AcceptedAtRoute(string, object)

ControllerBase.AcceptedAtRoute(object, object)

ControllerBase.AcceptedAtRoute(string, object, object)

ControllerBase.Challenge()

ControllerBase.Challenge(params string[])

ControllerBase.Challenge(AuthenticationProperties)

ControllerBase.Challenge(AuthenticationProperties, params string[])

ControllerBase.Forbid()

ControllerBase.Forbid(params string[])

ControllerBase.Forbid(AuthenticationProperties)

ControllerBase.Forbid(AuthenticationProperties, params string[])

ControllerBase.SignIn(ClaimsPrincipal)

ControllerBase.SignIn(ClaimsPrincipal, string)

ControllerBase.SignIn(ClaimsPrincipal, AuthenticationProperties)

ControllerBase.SignIn(ClaimsPrincipal, AuthenticationProperties, string)

ControllerBase.SignOut()

ControllerBase.SignOut(AuthenticationProperties)

ControllerBase.SignOut(params string[])

ControllerBase.SignOut(AuthenticationProperties, params string[])

ControllerBase.TryUpdateModelAsync<TModel>(TModel)

ControllerBase.TryUpdateModelAsync<TModel>(TModel, string)

ControllerBase.TryUpdateModelAsync<TModel>(TModel, string, IValueProvider)

ControllerBase.TryUpdateModelAsync<TModel>(TModel, string, params Expression<Func<TModel, object>>[])

ControllerBase.TryUpdateModelAsync<TModel>(TModel, string, Func<ModelMetadata, bool>)

ControllerBase.TryUpdateModelAsync<TModel>(TModel, string, IValueProvider, params Expression<Func<TModel, object>>[])

ControllerBase.TryUpdateModelAsync<TModel>(TModel, string, IValueProvider, Func<ModelMetadata, bool>)

ControllerBase.TryUpdateModelAsync(object, Type, string)

ControllerBase.TryUpdateModelAsync(object, Type, string, IValueProvider, Func<ModelMetadata, bool>)

ControllerBase.TryValidateModel(object)

ControllerBase.TryValidateModel(object, string)

ControllerBase.HttpContext

ControllerBase.Request

ControllerBase.Response

ControllerBase.RouteData

ControllerBase.ModelState

ControllerBase.ControllerContext

ControllerBase.MetadataProvider

ControllerBase.ModelBinderFactory

ControllerBase.Url

ControllerBase.ObjectValidator

ControllerBase.ProblemDetailsFactory

ControllerBase.User

ControllerBase.Empty

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

ControllerBaseExtensions.GetListActionAsync<TListRequestDto, TListResponseDto, TListQuery>(Controller, ILogger, IMediator, IAuthorizationService, TListRequestDto, Action<ILogger, string, Exception?>, string, Func<TListResponseDto, Task<IActionResult>>, Func<TListRequestDto, ClaimsPrincipal, CancellationToken, Task<TListQuery>>, CancellationToken)

ControllerBaseExtensions.GetListActionFlexibleAsync<TListRequestDto, TListResponseDto, TListQuery>(Controller, ILogger, IMediator, IAuthorizationService, TListRequestDto, Action<ILogger, string, Exception?>, string, Func<TListResponseDto, Task<IActionResult>>, Func<TListRequestDto, ClaimsPrincipal, CancellationToken, Task<TListQuery>>, CancellationToken)

ControllerBaseExtensions.GetAddActionAsync<TAddRequestDto, TAddResponseDto, TAddCommand>(ControllerBase, ILogger, IMediator, IAuthorizationService, TAddRequestDto, Action<ILogger, string, Exception?>, string, Func<TAddResponseDto, Task<ActionResult<TAddResponseDto>>>, Func<TAddRequestDto, ClaimsPrincipal, CancellationToken, Task<TAddCommand>>, CancellationToken)

ControllerBaseExtensions.GetApiListActionAsync<TListRequestDto, TListResponseDto, TListQuery>(ControllerBase, ILogger, IMediator, IAuthorizationService, TListRequestDto, Action<ILogger, string, Exception?>, string, Func<TListResponseDto, Task<ActionResult<TListResponseDto>>>, Func<TListRequestDto, ClaimsPrincipal, CancellationToken, Task<TListQuery>>, CancellationToken)

ControllerBaseExtensions.GetApiListActionFlexibleAsync<TListRequestDto, TListResponseDto, TListQuery>(ControllerBase, ILogger, IMediator, IAuthorizationService, TListRequestDto, Action<ILogger, string, Exception?>, string, Func<TListResponseDto, Task<ActionResult<TListResponseDto>>>, Func<TListRequestDto, ClaimsPrincipal, CancellationToken, Task<TListQuery>>, CancellationToken)

ControllerBaseExtensions.GetApiViewActionAsync<TViewRequestDto, TViewResponseDto, TViewQuery>(ControllerBase, ILogger, IMediator, IAuthorizationService, TViewRequestDto, Action<ILogger, string, Exception?>, string, Func<TViewResponseDto, Task<ActionResult<TViewResponseDto>>>, Func<TViewRequestDto, ClaimsPrincipal, CancellationToken, Task<TViewQuery>>, CancellationToken)

ControllerBaseExtensions.GetDeleteActionAsync<TDeleteResponseDto, TDeleteCommand>(ControllerBase, ILogger, IMediator, IAuthorizationService, long, Action<ILogger, string, Exception?>, string, Func<TDeleteResponseDto, Task<ActionResult<TDeleteResponseDto>>>, Func<long, ClaimsPrincipal, CancellationToken, Task<TDeleteCommand>>, CancellationToken)

ControllerBaseExtensions.GetUpdateActionAsync<TUpdateRequestDto, TUpdateResponseDto, TUpdateCommand>(ControllerBase, ILogger, IMediator, IAuthorizationService, long, TUpdateRequestDto, Action<ILogger, string, Exception?>, string, Func<TUpdateResponseDto, Task<ActionResult<TUpdateResponseDto>>>, Func<TUpdateRequestDto, ClaimsPrincipal, CancellationToken, Task<TUpdateCommand>>, CancellationToken)

ControllerBaseExtensions.GetViewActionAsync<TViewRequestDto, TViewResponseDto, TViewQuery>(ControllerBase, ILogger, IMediator, IAuthorizationService, TViewRequestDto, Action<ILogger, string, Exception?>, string, Func<TViewResponseDto, Task<IActionResult>>, Func<TViewRequestDto, ClaimsPrincipal, CancellationToken, Task<TViewQuery>>, CancellationToken)

Constructors

BaseFileDownloadController(IAuthorizationService, ILogger<BaseFileDownloadController<TGetRequestDto, TQueryDto>>, IMediator, Action<ILogger, string, Exception?>)

Initializes a new instance of the BaseFileDownloadController<TGetRequestDto, TQueryDto> class.

protected BaseFileDownloadController(IAuthorizationService authorizationService, ILogger<BaseFileDownloadController<TGetRequestDto, TQueryDto>> logger, IMediator mediator, Action<ILogger, string, Exception?> viewLogAction)

Parameters

authorizationService IAuthorizationService

Authorization service instance for verifying requests.

logger ILogger<BaseFileDownloadController<TGetRequestDto, TQueryDto>>

Logging framework instance.

mediator IMediator

CQRS handler.

viewLogAction Action<ILogger, string, Exception>

Log Message Action for the View event.

Methods

GetAsync(TGetRequestDto, CancellationToken)

Allows for retrieval of a file.

public Task<IActionResult> GetAsync(TGetRequestDto request, CancellationToken cancellationToken)

Parameters

request TGetRequestDto

The request dto.

cancellationToken CancellationToken

Cancellation token for the process.

Returns

Task<IActionResult>

A Task<TResult> representing the result of the asynchronous operation.

GetMediaTypeHeaderString()

Gets the MIME type for the file.

protected abstract string GetMediaTypeHeaderString()

Returns

string

The mime type.

GetViewPolicyName()

Gets the policy name for authorizing viewing of the file.

protected abstract string GetViewPolicyName()

Returns

string

Policy name.

ViewCommandFactoryAsync(TGetRequestDto, ClaimsPrincipal, CancellationToken)

Gets the Command Factory for the View Command.

protected abstract Task<TQueryDto> ViewCommandFactoryAsync(TGetRequestDto request, ClaimsPrincipal claimsPrincipal, CancellationToken cancellationToken)

Parameters

request TGetRequestDto

The request dto for the api.

claimsPrincipal ClaimsPrincipal

Authentication principal associated with the request.

cancellationToken CancellationToken

Cancellation token for the process.

Returns

Task<TQueryDto>

A Task<TResult> representing the result of the asynchronous operation.