Package dev.relism.flash.ext.security

Interface AuthenticationMechanism

public interface AuthenticationMechanism
Reads one kind of credential off a request. A mechanism never writes the response: an anonymous request is answered by the AuthenticationEntryPoint, a rejected one by the 401 its AuthenticationFailedException carries.

  • Method Summary

    Modifier and Type
    Method
    Description
    Principal
    authenticate(dev.relism.flash.models.Request req)
    The caller, or null when the request carries no credential of this kind.
    default List<SecurityScheme>
    schemes()
    How OpenAPI documents each credential this mechanism reads, and how a 401 challenges for it.

  • Method Details

    • authenticate

      Principal authenticate(dev.relism.flash.models.Request req)
      The caller, or null when the request carries no credential of this kind.
      Throws:
      AuthenticationFailedException - the request carries one, and it is invalid

    • schemes

      default List<SecurityScheme> schemes()
      How OpenAPI documents each credential this mechanism reads, and how a 401 challenges for it.