OpenJDK 27 · com.sun.net.httpserver.BasicAuthenticator

Modifier and Type	Field and Description
private final Charset	charset
private final boolean	isUTF8
protected final String	realm The HTTP Basic authentication realm.

Constructor Summary

Access	Constructor and Description
public	BasicAuthenticator(String the HTTP Basic authentication realm realm) Creates a `BasicAuthenticator` for the given HTTP realm.
public	BasicAuthenticator(String the HTTP Basic authentication realm realm, Charset the `Charset` to decode incoming credentials from the client charset) Creates a `BasicAuthenticator` for the given HTTP realm and using the given `Charset` to decode the Basic authentication credentials (username and password).

Method Summary

Modifier and Type	Method and Description
public Authenticator.Result	authenticate(HttpExchange t) Implements abstract com.sun.net.httpserver.Authenticator.authenticate. Called to authenticate each incoming request.
public abstract boolean	Returns: `true` if the credentials are valid, `false` otherwise checkCredentials(String the username from the request username, String the password from the request password) Called for each incoming request to verify the given name and password in the context of this authenticator's realm.
public String	Returns: the authenticator's realm string getRealm() Returns the realm this `BasicAuthenticator` was created with.
private void	setAuthHeader(HttpExchange t)

Field Detail

charset	back to summary
private final Charset charset

isUTF8	back to summary
private final boolean isUTF8

realm	back to summary
protected final String realm The HTTP Basic authentication realm.

Constructor Detail

BasicAuthenticator back to summary

BasicAuthenticator	back to summary
public BasicAuthenticator(String realm) Creates a `BasicAuthenticator` for the given HTTP realm. The Basic authentication credentials (username and password) are decoded using the platform's `default character set`. API Note The value of the `realm` parameter will be embedded in a quoted string. Parameters realm:String the HTTP Basic authentication realm Exceptions NullPointerException: if realm is `null` IllegalArgumentException: if realm is an empty string or is not correctly quoted, as specified in RFC 7230 section-3.2. Note, any `\` character used for quoting must itself be quoted in source code.

public BasicAuthenticator(String realm)

Creates a BasicAuthenticator for the given HTTP realm. The Basic authentication credentials (username and password) are decoded using the platform's default character set.

API Note

The value of the realm parameter will be embedded in a quoted string.

Parameters

realm:String: the HTTP Basic authentication realm

Exceptions

NullPointerException:: if realm is null
IllegalArgumentException:: if realm is an empty string or is not correctly quoted, as specified in RFC 7230 section-3.2. Note, any \ character used for quoting must itself be quoted in source code.

BasicAuthenticator back to summary

BasicAuthenticator	back to summary
public BasicAuthenticator(String realm, Charset charset) Creates a `BasicAuthenticator` for the given HTTP realm and using the given `Charset` to decode the Basic authentication credentials (username and password). API Note `UTF-8` is the recommended charset because its usage is communicated to the client, and therefore more likely to be used also by the client. The value of the `realm` parameter will be embedded in a quoted string. Parameters realm:String the HTTP Basic authentication realm charset:Charset the `Charset` to decode incoming credentials from the client Exceptions NullPointerException: if realm or charset are `null` IllegalArgumentException: if realm is an empty string or is not correctly quoted, as specified in RFC 7230 section-3.2. Note, any `\` character used for quoting must itself be quoted in source code. Since 14

public BasicAuthenticator(String realm, Charset charset)

Creates a BasicAuthenticator for the given HTTP realm and using the given Charset to decode the Basic authentication credentials (username and password).

API Note

UTF-8 is the recommended charset because its usage is communicated to the client, and therefore more likely to be used also by the client.

The value of the realm parameter will be embedded in a quoted string.

Parameters

realm:String: the HTTP Basic authentication realm
charset:Charset: the Charset to decode incoming credentials from the client

Exceptions

NullPointerException:: if realm or charset are null
IllegalArgumentException:: if realm is an empty string or is not correctly quoted, as specified in RFC 7230 section-3.2. Note, any \ character used for quoting must itself be quoted in source code.

Since

Method Detail

authenticate back to summary

authenticate	back to summary
public Authenticator.Result authenticate(HttpExchange t) Implements abstract com.sun.net.httpserver.Authenticator.authenticate. Doc from com.sun.net.httpserver.Authenticator.authenticate. Called to authenticate each incoming request. The implementation must return a `Failure`, `Success` or `Retry` object as appropriate: `Failure` means the authentication has completed, but has failed due to invalid credentials. `Success` means that the authentication has succeeded, and a `Principal` object representing the user can be retrieved by calling `Success#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.

public Authenticator.Result authenticate(HttpExchange t)

Implements abstract com.sun.net.httpserver.Authenticator.authenticate.

Doc from com.sun.net.httpserver.Authenticator.authenticate.

Called to authenticate each incoming request. The implementation must return a Failure, Success or Retry object as appropriate:

Failure means the authentication has completed, but has failed due to invalid credentials.
Success means that the authentication has succeeded, and a Principal object representing the user can be retrieved by calling Success#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.

checkCredentials back to summary

checkCredentials	back to summary
public abstract boolean checkCredentials(String username, String password) Called for each incoming request to verify the given name and password in the context of this authenticator's realm. Any caching of credentials must be done by the implementation of this method. Parameters username:String the username from the request password:String the password from the request Returns:boolean `true` if the credentials are valid, `false` otherwise

public abstract boolean checkCredentials(String username, String password)

Called for each incoming request to verify the given name and password in the context of this authenticator's realm. Any caching of credentials must be done by the implementation of this method.

Parameters

username:String: the username from the request
password:String: the password from the request

Returns:boolean

true if the credentials are valid, false otherwise

getRealm back to summary

getRealm	back to summary
public String getRealm() Returns the realm this `BasicAuthenticator` was created with. Returns:String the authenticator's realm string

public String getRealm()

Returns the realm this BasicAuthenticator was created with.

Returns:String: the authenticator's realm string

setAuthHeader	back to summary
private void setAuthHeader(HttpExchange t)

public abstract Class BasicAuthenticator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail