| File: AcceptedAtRoute.cs | Web Access |
| Project: src\aspnetcore\src\Http\Http.Results\src\Microsoft.AspNetCore.Http.Results.csproj (Microsoft.AspNetCore.Http.Results) |
// Licensed to the .NET Foundation under one or more agreements. // The .NET Foundation licenses this file to you under the MIT license. using System.Diagnostics.CodeAnalysis; using System.Reflection; using Microsoft.AspNetCore.Builder; using Microsoft.AspNetCore.Http.Metadata; using Microsoft.AspNetCore.Internal; using Microsoft.AspNetCore.Routing; using Microsoft.Extensions.DependencyInjection; using Microsoft.Extensions.Logging; namespace Microsoft.AspNetCore.Http.HttpResults; /// <summary> /// An <see cref="IResult"/> that on execution will write an object to the response /// with status code Accepted (202) and Location header. /// Targets a registered route. /// </summary> public sealed class AcceptedAtRoute : IResult, IEndpointMetadataProvider, IStatusCodeHttpResult { /// <summary> /// Initializes a new instance of the <see cref="AcceptedAtRoute"/> class with the values /// provided. /// </summary> /// <param name="routeValues">The route data to use for generating the URL.</param> [RequiresUnreferencedCode(RouteValueDictionaryTrimmerWarning.Warning)] internal AcceptedAtRoute(object? routeValues) : this(routeName: null, routeValues: routeValues) { } /// <summary> /// Initializes a new instance of the <see cref="AcceptedAtRoute"/> class with the values /// provided. /// </summary> /// <param name="routeName">The name of the route to use for generating the URL.</param> /// <param name="routeValues">The route data to use for generating the URL.</param> [RequiresUnreferencedCode(RouteValueDictionaryTrimmerWarning.Warning)] internal AcceptedAtRoute(string? routeName, object? routeValues) : this(routeName, new RouteValueDictionary(routeValues)) { } /// <summary> /// Initializes a new instance of the <see cref="AcceptedAtRoute"/> class with the values /// provided. /// </summary> /// <param name="routeName">The name of the route to use for generating the URL.</param> /// <param name="routeValues">The route data to use for generating the URL.</param> internal AcceptedAtRoute( string? routeName, RouteValueDictionary? routeValues) { RouteName = routeName; RouteValues = routeValues ?? new RouteValueDictionary(); } /// <summary> /// Gets the name of the route to use for generating the URL. /// </summary> public string? RouteName { get; } /// <summary> /// Gets the route data to use for generating the URL. /// </summary> public RouteValueDictionary RouteValues { get; } /// <summary> /// Gets the HTTP status code: <see cref="StatusCodes.Status202Accepted"/> /// </summary> public int StatusCode => StatusCodes.Status202Accepted; int? IStatusCodeHttpResult.StatusCode => StatusCode; /// <inheritdoc/> public Task ExecuteAsync(HttpContext httpContext) { ArgumentNullException.ThrowIfNull(httpContext); var linkGenerator = httpContext.RequestServices.GetRequiredService<LinkGenerator>(); var url = linkGenerator.GetUriByRouteValues( httpContext, RouteName, RouteValues, fragment: FragmentString.Empty); if (string.IsNullOrEmpty(url)) { throw new InvalidOperationException("No route matches the supplied values."); } // Creating the logger with a string to preserve the category after the refactoring. var loggerFactory = httpContext.RequestServices.GetRequiredService<ILoggerFactory>(); var logger = loggerFactory.CreateLogger("Microsoft.AspNetCore.Http.Result.AcceptedAtRouteResult"); httpContext.Response.Headers.Location = url; HttpResultsHelper.Log.WritingResultAsStatusCode(logger, StatusCode); httpContext.Response.StatusCode = StatusCode; return Task.CompletedTask; } /// <inheritdoc/> static void IEndpointMetadataProvider.PopulateMetadata(MethodInfo method, EndpointBuilder builder) { ArgumentNullException.ThrowIfNull(method); ArgumentNullException.ThrowIfNull(builder); builder.Metadata.Add(new ProducesResponseTypeMetadata(StatusCodes.Status202Accepted, typeof(void))); builder.Metadata.Add(DisableCookieRedirectMetadata.Instance); } }