Package io.micronaut.http.server

Class RequestLifecycle

java.lang.Object
io.micronaut.http.server.RequestLifecycle
public class RequestLifecycle extends Object
This class handles the full route processing lifecycle for a request.
Since:
4.0.0

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    RequestLifecycle(RouteExecutor routeExecutor, io.micronaut.http.HttpRequest<?> request)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected @Nullable FileCustomizableResponseType
    findFile()
    Try to find a static file for this request.
    protected io.micronaut.core.execution.ExecutionFlow<io.micronaut.web.router.RouteMatch<?>>
    fulfillArguments(io.micronaut.web.router.RouteMatch<?> routeMatch)
    Fulfill the arguments of the given route with data from the request.
    protected final void
    multipartEnabled(boolean multipartEnabled)
     
    protected final io.micronaut.core.execution.ExecutionFlow<io.micronaut.http.MutableHttpResponse<?>>
    normalFlow()
    Execute this request normally.
    protected final io.micronaut.core.execution.ExecutionFlow<io.micronaut.http.MutableHttpResponse<?>>
    onError(Throwable t)
    Handle an error in this request.
    protected final io.micronaut.core.execution.ExecutionFlow<io.micronaut.http.MutableHttpResponse<?>>
    onStatusError(io.micronaut.http.MutableHttpResponse<?> defaultResponse, String message)
    Build a status response.
    protected final io.micronaut.http.HttpRequest<?>
    request()
    The request for this lifecycle.
    protected final io.micronaut.core.execution.ExecutionFlow<io.micronaut.http.MutableHttpResponse<?>>
    runWithFilters(Supplier<io.micronaut.core.execution.ExecutionFlow<io.micronaut.http.MutableHttpResponse<?>>> downstream)
    Run the filters for this request, and then run the given flow.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • RequestLifecycle

      protected RequestLifecycle(RouteExecutor routeExecutor, io.micronaut.http.HttpRequest<?> request)
      Parameters:
      routeExecutor - The route executor to use for route resolution
      request - The request to process

  • Method Details

    • request

      protected final io.micronaut.http.HttpRequest<?> request()
      The request for this lifecycle. This may be changed by filters.
      Returns:
      The current request

    • multipartEnabled

      protected final void multipartEnabled(boolean multipartEnabled)

    • normalFlow

      protected final io.micronaut.core.execution.ExecutionFlow<io.micronaut.http.MutableHttpResponse<?>> normalFlow()
      Execute this request normally.
      Returns:
      The response to the request.

    • onError

      protected final io.micronaut.core.execution.ExecutionFlow<io.micronaut.http.MutableHttpResponse<?>> onError(Throwable t)
      Handle an error in this request. Also runs filters for the error handling.
      Parameters:
      t - The error
      Returns:
      The response for the error

    • runWithFilters

      protected final io.micronaut.core.execution.ExecutionFlow<io.micronaut.http.MutableHttpResponse<?>> runWithFilters(Supplier<io.micronaut.core.execution.ExecutionFlow<io.micronaut.http.MutableHttpResponse<?>>> downstream)
      Run the filters for this request, and then run the given flow.
      Parameters:
      downstream - Downstream flow, runs inside the filters
      Returns:
      Execution flow that completes after the all the filters and the downstream flow

    • onStatusError

      protected final io.micronaut.core.execution.ExecutionFlow<io.micronaut.http.MutableHttpResponse<?>> onStatusError(io.micronaut.http.MutableHttpResponse<?> defaultResponse, String message)
      Build a status response. Calls any status routes, if available.
      Parameters:
      defaultResponse - The default response if there is no status route
      message - The error message
      Returns:
      The computed response flow

    • findFile

      @Nullable protected @Nullable FileCustomizableResponseType findFile()
      Try to find a static file for this request. If there is a file, filters will still run, but only after the call to this method.
      Returns:
      The file at this path, or null if none is found

    • fulfillArguments

      protected io.micronaut.core.execution.ExecutionFlow<io.micronaut.web.router.RouteMatch<?>> fulfillArguments(io.micronaut.web.router.RouteMatch<?> routeMatch)
      Fulfill the arguments of the given route with data from the request. If necessary, this also waits for body data to be available, if there are arguments that need immediate binding.
      Note that in some cases some arguments may still be unsatisfied after this, if they are missing and are Optional. They are satisfied with Optional.empty() later.
      Parameters:
      routeMatch - The route match to fulfill
      Returns:
      The fulfilled route match, after all necessary data is available