Interface Authenticator

All Superinterfaces:
AutoCloseable, Closeable

public interface Authenticator extends Closeable
Authentication mechanism.
Author:
Sebastian Ɓaskawiec
  • Method Summary

    Modifier and Type
    Method
    Description
    CompletionStage<org.infinispan.rest.framework.RestResponse>
    challenge(org.infinispan.rest.framework.RestRequest request, io.netty.channel.ChannelHandlerContext ctx)
    Challenges specific RestRequest for authentication.
    default void
     
    default void
    init(RestServer restServer)
    Invoked by the RestServer on startup.
    default boolean
    Returns whether the realm backing this authenticator is ready to authenticate users
  • Method Details

    • challenge

      CompletionStage<org.infinispan.rest.framework.RestResponse> challenge(org.infinispan.rest.framework.RestRequest request, io.netty.channel.ChannelHandlerContext ctx)
      Challenges specific RestRequest for authentication.
      Parameters:
      request - Request to be challenged.
      Returns:
      a RestResponse wrapped in a CompletionStage
    • init

      default void init(RestServer restServer)
      Invoked by the RestServer on startup. Can perform additional configuration
      Parameters:
      restServer -
    • isReadyForHttpChallenge

      default boolean isReadyForHttpChallenge()
      Returns whether the realm backing this authenticator is ready to authenticate users
      Returns:
      a boolean indicating whether the real is empty (i.e. has no users)
    • close

      default void close() throws IOException
      Throws:
      IOException