java.lang.Object
com.sun.net.httpserver.Authenticator
com.sun.net.httpserver.BasicAuthenticator
public abstract class BasicAuthenticator extends Authenticator
BasicAuthenticatorは、HTTP基本認証の実装を提供します。 これはabstractクラスであり、各着信要求を検証するために呼び出される
checkCredentials(String,String)
の実装を提供するには、拡張する必要があります。 -
ネストされたクラスのサマリー
クラス com.sun.net.httpserver.Authenticatorで宣言されたネストされたクラス/インタフェース
Authenticator.Failure, Authenticator.Result, Authenticator.Retry, Authenticator.Success
-
フィールドのサマリー
-
コンストラクタのサマリー
コンストラクタ説明BasicAuthenticator(String realm)
指定されたHTTPレルムのBasicAuthenticator
を作成します。BasicAuthenticator(String realm, Charset charset)
指定されたHTTPレルムのBasicAuthenticator
を作成し、指定されたCharset
を使用してBasic認証資格証明(ユーザー名とパスワード)をデコードします。 -
メソッドのサマリー
修飾子と型メソッド説明各着信リクエストを認証するために呼び出されます。abstract boolean
checkCredentials(String username, String password)
このオーセンティケータ・レルムのコンテキストで指定された名前とパスワードを検証するために、着信リクエストごとにコールされます。getRealm()
このBasicAuthenticator
が作成されたレルムを返します。
-
フィールド詳細
-
realm
protected final String realmHTTP Basic認証レルム。
-
-
コンストラクタの詳細
-
BasicAuthenticator
public BasicAuthenticator(String realm)指定されたHTTPレルムのBasicAuthenticator
を作成します。 Basic認証資格証明(ユーザー名とパスワード)は、プラットフォームdefault character set
を使用してデコードされます。- パラメータ:
realm
- HTTP Basic認証レルム- 例外:
NullPointerException
- レルムがnull
の場合IllegalArgumentException
- レルムが空の文字列の場合
-
BasicAuthenticator
指定されたHTTPレルムのBasicAuthenticator
を作成し、指定されたCharset
を使用してBasic認証資格証明(ユーザー名とパスワード)をデコードします。- APIのノート:
UTF-8
の使用量はクライアントに送信されるため、クライアントから使用される可能性が高くなるため、推奨の文字セットです。- パラメータ:
realm
- HTTP Basic認証レルムcharset
- クライアントからの受信資格証明をデコードするCharset
- 例外:
NullPointerException
- レルムまたは文字セットがnull
の場合IllegalArgumentException
- レルムが空の文字列の場合
-
-
メソッドの詳細
-
getRealm
public String getRealm()このBasicAuthenticator
が作成されたレルムを返します。- 戻り値:
- オーセンティケータのレルム文字列
-
authenticate
public Authenticator.Result authenticate(HttpExchange t)次のクラスからコピーされた説明:Authenticator
各着信リクエストを認証するために呼び出されます。 実装は、必要に応じてAuthenticator.Failure
、Authenticator.Success
またはAuthenticator.Retry
オブジェクトを返す必要があります:-
Failure
は、認証は完了したが、資格証明が無効なために失敗したことを意味します。 -
Success
は、認証が成功し、Authenticator.Success.getPrincipal()
をコールしてユーザーを表すPrincipal
オブジェクトを取得できることを意味します。 -
Retry
は、別のHTTP exchangeが必要であることを意味します。 クライアントに返送する必要があるレスポンス・ヘッダーは、指定されたHttpExchange
で設定されます。 返されるレスポンス・コードは、Retry
オブジェクトで指定する必要があります。Retry
が複数回発生する場合があります。
- 定義:
authenticate
、クラス:Authenticator
- パラメータ:
t
- 認証が呼び出されるHttpExchange
- 戻り値:
- 結果
-
-
checkCredentials
このオーセンティケータ・レルムのコンテキストで指定された名前とパスワードを検証するために、着信リクエストごとにコールされます。 資格のキャッシュは、このメソッドの実装によって行う必要があります。- パラメータ:
username
- 要求からのユーザー名password
- 要求からのパスワード- 戻り値:
- 資格が有効な場合は
true
、そうでない場合はfalse
-