Package io.micronaut.security.token.reader

Interface TokenReader

  • All Superinterfaces:
    io.micronaut.core.order.Ordered
    All Known Implementing Classes:
    HttpHeaderTokenReader
    Functional Interface:
    This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
    @FunctionalInterface
public interface TokenReader
extends io.micronaut.core.order.Ordered
    Responsible for reading the token data from a request.
    Since:
    1.0

    • Field Summary

      • Fields inherited from interface io.micronaut.core.order.Ordered

        HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.Optional<java.lang.String> findToken​(io.micronaut.http.HttpRequest<?> request)
      Attempts to retrieve a token in a request.

      • Methods inherited from interface io.micronaut.core.order.Ordered

        getOrder

    • Method Detail

      • findToken

        java.util.Optional<java.lang.String> findToken​(io.micronaut.http.HttpRequest<?> request)
        Attempts to retrieve a token in a request.
        Parameters:
        request - The request to look for the token in
        Returns:
        An optional token string