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 SecurityScheme
    scheme()
    How OpenAPI documents the credential and a 401 challenges for it; null for neither.

  • 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

    • scheme

      default SecurityScheme scheme()
      How OpenAPI documents the credential and a 401 challenges for it; null for neither.