Authenticator (Infinispan JavaDoc All 10.1.0.Beta1 API)

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable
```
public interface Authenticator
extends java.io.Closeable
```
Authentication mechanism.

Author:

Sebastian Łaskawiec

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`java.util.concurrent.CompletionStage<RestResponse>`	`challenge(RestRequest request, io.netty.channel.ChannelHandlerContext ctx)`	Challenges specific `RestRequest` for authentication.
`default void`	`close()`
`default void`	`init(RestServer restServer)`	Invoked by the `RestServer` on startup.
`default boolean`	`isReadyForHttpChallenge()`	Returns whether the realm backing this authenticator is ready to authenticate users

- Method Detail
  - challenge
```
java.util.concurrent.CompletionStage<RestResponse> challenge(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 java.io.IOException
```
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Specified by:
    
    close in interface java.io.Closeable
    
    Throws:
    
    java.io.IOException