javax.mail
クラス Authenticator

java.lang.Object
  上位を拡張 javax.mail.Authenticator

public abstract class Authenticator
extends Object

Authenticator クラスは、ネットワーク接続に必要な認証を取得する為のオブジェク トを表します。通常は、ユーザに情報の入力を求める事により、認証を行います。

アプリケーションでこのクラスを使うには、サブクラスを作成し、その時のセッショ ンを使ってシステムにサブクラスのインスタンスを登録します。認証が要求されると、 システムはサブクラスのメソッド (getPasswordAuthentication など) を呼び出しま す。サブクラスのメソッドは、多数の継承されたメソッド (getRequesting で始まる メソッド) を使って、要求された認証について照会を行う事ができます。その後で、 ユーザに表示する適切なメッセージを形成できます。

認証を要求するメソッドは全て、失敗に終わるデフォルト実装を持っています。

関連項目:
Authenticator, Session.getInstance(java.util.Properties, javax.mail.Authenticator), Session.getDefaultInstance(java.util.Properties, javax.mail.Authenticator), Session.requestPasswordAuthentication(java.net.InetAddress, int, java.lang.String, java.lang.String, java.lang.String), PasswordAuthentication

コンストラクタの概要
Authenticator()
           
 
メソッドの概要
protected  String getDefaultUserName()
           
protected  PasswordAuthentication getPasswordAuthentication()
          パスワード認証が必要な場合に呼び出されます。
protected  int getRequestingPort()
           
protected  String getRequestingPrompt()
           
protected  String getRequestingProtocol()
          接続を要求しているプロトコルを与えます。
protected  InetAddress getRequestingSite()
           
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

Authenticator

public Authenticator()
メソッドの詳細

getRequestingSite

protected final InetAddress getRequestingSite()
戻り値:
認証を要求しているサイトの InetAddress。 InetAddress が使用できない場合は null

getRequestingPort

protected final int getRequestingPort()
戻り値:
要求された接続に使うポート番号

getRequestingProtocol

protected final String getRequestingProtocol()
接続を要求しているプロトコルを与えます。 多くの場合は URLName に基づきます。

戻り値:
プロトコル
関連項目:
URLName.getProtocol()

getRequestingPrompt

protected final String getRequestingPrompt()
戻り値:
要求者が指定したプロンプト文字列

getDefaultUserName

protected final String getDefaultUserName()
戻り値:
要求者が指定したデフォルトのユーザ名

getPasswordAuthentication

protected PasswordAuthentication getPasswordAuthentication()
パスワード認証が必要な場合に呼び出されます。 サブクラスでは、デフォルトの実装をオーバーライドする必要があります。 デフォルトの実装では null が返されます。

このメソッドがダイアログを使用してユーザによる情報入力を求める場合、 情報が入力されるまでダイアログをブロックする必要があります。 このメソッドはダイアログの表示後単純に戻ることはできません。

戻り値:
ユーザから収集した PasswordAuthentication。ない場合には null