@Exported public abstract class Authenticator extends Object
Modifier and Type | Class | Description |
---|---|---|
static class |
Authenticator.Failure |
Indicates an authentication failure.
|
static class |
Authenticator.Result |
Base class for return type from authenticate() method
|
static class |
Authenticator.Retry |
Indicates an authentication must be retried.
|
static class |
Authenticator.Success |
Indicates an authentication has succeeded and the
authenticated user principal can be acquired by calling
getPrincipal().
|
Constructor | Description |
---|---|
Authenticator() |
Modifier and Type | Method | Description |
---|---|---|
abstract Authenticator.Result |
authenticate(HttpExchange exch) |
called to authenticate each incoming request.
|
public abstract Authenticator.Result authenticate(HttpExchange exch)
Failure means the authentication has completed, but has failed due to invalid credentials.
Sucess means that the authentication has succeeded, and a Principal object representing the user can be retrieved by calling Sucess.getPrincipal() .
Retry means that another HTTP exchange is required. Any response headers needing to be sent back to the client are set in the given HttpExchange. The response code to be returned must be provided in the Retry object. Retry may occur multiple times.
Copyright © 2005, 2025, Oracle and/or its affiliates. All rights reserved.