パッケージ jakarta.mail
クラス Authenticator
- java.lang.ObjectSE
-
- jakarta.mail.Authenticator
public abstract class Authenticator extends ObjectSE
クラス Authenticator は、ネットワーク接続の認証を取得する方法を知っているオブジェクトを表します。通常、これはユーザーに情報を要求することによって行われます。アプリケーションは、サブクラスを作成し、そのサブクラスのインスタンスをセッションの作成時に登録することで、このクラスを使用します。認証が必要な場合、システムはサブクラスのメソッド (getPasswordAuthentication など) を呼び出します。サブクラスのメソッドは、継承されたメソッド (getRequestingXXX()) を使用してリクエストされている認証について照会し、ユーザーに適切なメッセージを作成できます。
認証をリクエストするすべてのメソッドには、失敗するデフォルトの実装があります。
- 作成者:
- Bill Foote, Bill Shannon
- 関連事項:
AuthenticatorSE,Session.getInstance(java.util.Properties, jakarta.mail.Authenticator),Session.getDefaultInstance(java.util.Properties, jakarta.mail.Authenticator),Session.requestPasswordAuthentication(java.net.InetAddress, int, java.lang.String, java.lang.String, java.lang.String),PasswordAuthentication
コンストラクターの概要
コンストラクター コンストラクター 説明 Authenticator()デフォルトのAuthenticatorを作成します。
メソッドのサマリー
すべてのメソッド インスタンスメソッド 具象メソッド 修飾子と型 メソッド 説明 protected StringSEgetDefaultUserName()protected PasswordAuthenticationgetPasswordAuthentication()パスワード認証が必要なときに呼び出されます。protected intgetRequestingPort()protected StringSEgetRequestingPrompt()protected StringSEgetRequestingProtocol()接続をリクエストしているプロトコルを指定します。protected InetAddressSEgetRequestingSite()
メソッドの詳細
getRequestingSite
protected final InetAddressSE getRequestingSite()
- 戻り値:
- 認可をリクエストしているサイトの InetAddress。利用できない場合は null
getRequestingPort
protected final int getRequestingPort()
- 戻り値:
- リクエストされた接続のポート
getRequestingProtocol
protected final StringSE getRequestingProtocol()
接続をリクエストしているプロトコルを指定します。多くの場合、これは URLName に基づいています。- 戻り値:
- プロトコル
- 関連事項:
URLName.getProtocol()
getRequestingPrompt
protected final StringSE getRequestingPrompt()
- 戻り値:
- リクエスタが指定したプロンプト文字列
getDefaultUserName
protected final StringSE getDefaultUserName()
- 戻り値:
- リクエスタが指定したデフォルトのユーザー名
getPasswordAuthentication
protected PasswordAuthentication getPasswordAuthentication()
パスワード認証が必要なときに呼び出されます。サブクラスは、null を返すデフォルトの実装をオーバーライドする必要があります。このメソッドがダイアログを使用してユーザーにこの情報を要求する場合、ユーザーが情報を提供するまでダイアログはブロックする必要があることに注意してください。このメソッドは、ダイアログを表示した後に単に戻ることはできません。
- 戻り値:
- ユーザーから収集された PasswordAuthentication。提供されていない場合は null。