Interface Authenticator
-
- All Superinterfaces:
AutoCloseable
,Closeable
public interface Authenticator extends Closeable
Authentication mechanism.- Author:
- Sebastian Ćaskawiec
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description CompletionStage<org.infinispan.rest.framework.RestResponse>
challenge(org.infinispan.rest.framework.RestRequest request, io.netty.channel.ChannelHandlerContext ctx)
Challenges specificRestRequest
for authentication.default void
close()
default void
init(RestServer restServer)
Invoked by theRestServer
on startup.default boolean
isReadyForHttpChallenge()
Returns whether the realm backing this authenticator is ready to authenticate users
-
-
-
Method Detail
-
challenge
CompletionStage<org.infinispan.rest.framework.RestResponse> challenge(org.infinispan.rest.framework.RestRequest request, io.netty.channel.ChannelHandlerContext ctx)
Challenges specificRestRequest
for authentication.- Parameters:
request
- Request to be challenged.- Returns:
- a
RestResponse
wrapped in aCompletionStage
-
init
default void init(RestServer restServer)
Invoked by theRestServer
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
-
-