Package io.micronaut.http.filter

Interface GenericHttpFilter

All Known Subinterfaces:
GenericHttpFilter.Terminal
All Known Implementing Classes:
GenericHttpFilter.AroundLegacy, GenericHttpFilter.Async, GenericHttpFilter.TerminalReactive
public sealed interface GenericHttpFilter permits GenericHttpFilter.AroundLegacy, GenericHttpFilter.Async, GenericHttpFilter.Terminal (not exhaustive)
Base interface for different filter types. Note that while the base interface is exposed, so you can pass around instances of these filters, the different implementations are internal only. Only the framework should construct or call instances of this interface. The exception is the terminal filter.
Since:
4.0.0
Author:
Jonas Konrad

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final record 
    GenericHttpFilter.AroundLegacy
    "Legacy" filter, i.e.
    static final record 
    GenericHttpFilter.Async
    Wrapper around a filter that signifies the filter should be run asynchronously on the given executor.
    static interface 
    GenericHttpFilter.Terminal
    Last item in a filter chain, called when all other filters are done.
    static final class 
    GenericHttpFilter.TerminalReactive
    Terminal filter that accepts a reactive type.

  • Method Summary

    Modifier and Type
    Method
    Description
    default boolean
    isFiltersException()
     
    default boolean
    isSuspended()
    When the filter is using the continuation it needs to be suspended and wait for the response.

  • Method Details

    • isSuspended

      default boolean isSuspended()
      When the filter is using the continuation it needs to be suspended and wait for the response.
      Returns:
      true if suspended

    • isFiltersException

      default boolean isFiltersException()
      Returns:
      true if the filter can receive the processing exception.