クラスBasicAuthenticator

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)の実装を提供するには、拡張する必要があります。
導入されたバージョン:
1.6

  • ネストされたクラスのサマリー

    Authenticatorクラスで宣言されたネストされたクラス/インタフェース

    Authenticator.Failure, Authenticator.Result, Authenticator.Retry, Authenticator.Success
    修飾子と型
    クラス
    説明
    static class 
    Authenticator.Failure
    認証の失敗を示します。
    static class 
    Authenticator.Result
    Authenticator.authenticate(HttpExchange)メソッドからの戻り型のベース・クラス。
    static class 
    Authenticator.Retry
    認証を再試行する必要があることを示します。
    static class 
    Authenticator.Success
    認証が成功し、Authenticator.Success.getPrincipal()をコールして認証済ユーザーprincipalを取得できることを示します。

  • フィールドのサマリー

    フィールド
    修飾子と型
    フィールド
    説明
    protected final String
    realm
    HTTP Basic認証レルム。

  • コンストラクタのサマリー

    コンストラクタ
    コンストラクタ
    説明
    BasicAuthenticator(String realm)
    指定されたHTTPレルムのBasicAuthenticatorを作成します。
    BasicAuthenticator(String realm, Charset charset)
    指定されたHTTPレルムのBasicAuthenticatorを作成し、指定されたCharsetを使用してBasic認証資格証明(ユーザー名とパスワード)をデコードします。

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    Authenticator.Result
    authenticate(HttpExchange t)
    各着信リクエストを認証するために呼び出されます。
    abstract boolean
    checkCredentials(String username, String password)
    このオーセンティケータ・レルムのコンテキストで指定された名前とパスワードを検証するために、着信リクエストごとにコールされます。
    String
    getRealm()
    このBasicAuthenticatorが作成されたレルムを返します。

    クラスオブジェクトで宣言されたメソッド

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    修飾子と型
    メソッド
    説明
    protected Object
    clone()
    このオブジェクトのコピーを作成して、返します。
    boolean
    equals(Object obj)
    このオブジェクトと他のオブジェクトが等しいかどうかを示します。
    protected void
    finalize()
    削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
    最終決定は非推奨であり、将来のリリースで削除される可能性があります。
    final Class<?>
    getClass()
    このObjectの実行時クラスを返します。
    int
    hashCode()
    このオブジェクトに対するハッシュ・コード値を返します。
    final void
    notify()
    このオブジェクトのモニターで待機中のスレッドを1つ再開します。
    final void
    notifyAll()
    このオブジェクトのモニターで待機中のすべてのスレッドを再開します。
    String
    toString()
    オブジェクトの文字列表現を返します。
    final void
    wait()
    現在のスレッドが目覚めるまで待機します。通常、notifiedまたはinterruptedです。
    final void
    wait(long timeoutMillis)
    現在のスレッドは、通常、notifiedまたはinterruptedであるか、一定のリアルタイムが経過するまで、目覚めるまで待機します。
    final void
    wait(long timeoutMillis, int nanos)
    現在のスレッドは、通常、notifiedまたはinterruptedであるか、一定のリアルタイムが経過するまで、目覚めるまで待機します。

  • フィールド詳細

    • realm

      protected final String realm
      HTTP Basic認証レルム。

  • コンストラクタの詳細

    • BasicAuthenticator

      public BasicAuthenticator(String realm)
      指定されたHTTPレルムのBasicAuthenticatorを作成します。 Basic認証資格証明(ユーザー名とパスワード)は、プラットフォームdefault character setを使用してデコードされます。
      APIのノート:
      realmパラメータの値は、引用符で囲まれた文字列に埋め込まれます。
      パラメータ:
      realm - HTTP Basic認証レルム
      スロー:
      NullPointerException - レルムがnullの場合
      IllegalArgumentException - 「RFC 7230セクション-3.2」に指定されているように、レルムが空文字列であるか、正しく引用符で囲まれていない場合。 見積に使用される\文字はすべて、ソース・コードで引用符で囲む必要があります。

    • BasicAuthenticator

      public BasicAuthenticator(String realm, Charset charset)
      指定されたHTTPレルムのBasicAuthenticatorを作成し、指定されたCharsetを使用してBasic認証資格証明(ユーザー名とパスワード)をデコードします。
      APIのノート:
      UTF-8の使用量はクライアントに送信されるため、クライアントから使用される可能性が高くなるため、推奨の文字セットです。

      realmパラメータの値は、引用符で囲まれた文字列に埋め込まれます。

      パラメータ:
      realm - HTTP Basic認証レルム
      charset - クライアントからの受信資格証明をデコードするCharset
      スロー:
      NullPointerException - レルムまたは文字セットがnullの場合
      IllegalArgumentException - 「RFC 7230セクション-3.2」に指定されているように、レルムが空文字列であるか、正しく引用符で囲まれていない場合。 見積に使用される\文字はすべて、ソース・コードで引用符で囲む必要があります。
      導入されたバージョン:
      14

  • メソッドの詳細

    • 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

      public abstract boolean checkCredentials(String username, String password)
      このオーセンティケータ・レルムのコンテキストで指定された名前とパスワードを検証するために、着信リクエストごとにコールされます。 資格のキャッシュは、このメソッドの実装によって行う必要があります。
      パラメータ:
      username - 要求からのユーザー名
      password - 要求からのパスワード
      戻り値:
      資格が有効な場合はtrue、そうでない場合はfalse