javax.security.sasl

インタフェース SaslClientFactory

public interface SaslClientFactory

SaslClient のインスタンスを作成するためのインタフェースです。このインタフェースは、スレッドセーフで、複数の要求を同時に処理できるクラスによって実装されます。このクラスは、引数をとらない public コンストラクタを持っている必要があります。

クライアントは、Sasl static メソッドを使用するため、通常、このインタフェースに直接アクセスすることはありません。ただし、新しい、または異なる SaslClientFactory が提供およびインストールされる環境もあります。

導入されたバージョン:

1.5

関連項目:

SaslClient、Sasl

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
SaslClient	createSaslClient(String[] mechanisms, String authorizationId, String protocol, String serverName, Map<String,?> props, CallbackHandler cbh) 指定のパラメータを使用して SaslClient を作成します。
String[]	getMechanismNames(Map<String,?> props) 指定されたメカニズム選択ポリシーに一致するメカニズム名の配列を返します。

メソッドの詳細

createSaslClient

SaslClient createSaslClient(String[] mechanisms,
                          String authorizationId,
                          String protocol,
                          String serverName,
                          Map<String,?> props,
                          CallbackHandler cbh)
                            throws SaslException

指定のパラメータを使用して SaslClient を作成します。

パラメータ:

mechanisms - 試行するメカニズム名のリスト。null 以外。それぞれは IANA に登録された SASL メカニズム名。GSSAPI や CRAM-MD5 などがある。

authorizationId - 承認に使用されるプロトコル依存の識別情報。null の場合もある。null または空の場合、サーバーはクライアントの認証資格から承認 ID を得る。SASL 認証に成功すると、指定されたエントリにアクセスが許可される。

protocol - 認証対象のプロトコルの文字列名。null 以外。ldap などがある。

serverName - 認証情報を要求するサーバーの完全指定のホスト名。null 以外。

props - SASL メカニズムの選択と、選択された SASL メカニズムの認証交換の設定を行うためのプロパティーのセット。null の場合もある。標準プロパティーのリストについては、Sasl クラスの説明を参照。メカニズム固有のプロパティーなど、標準以外のプロパティーも含めることができる。選択されたメカニズムと関連性のないプロパティー (String 形式でない鍵を持つマップエントリを含む) は無視される。

cbh - SASL メカニズムが、認証を完了するためにアプリケーションやライブラリからさらに詳しい情報を取得するとき使用するコールバックハンドラ。null の場合もある。たとえば、呼び出し側の認証 ID、パスワード、およびレルムを要求するような SASL メカニズムがある。認証 ID の要求には、NameCallback が使用される。パスワードの要求には、PasswordCallback が使用される。レルムの要求には、選択可能なレルムのリストが存在する場合は RealmChoiceCallback、レルムを指定する必要がある場合は RealmCallback が使用される。

戻り値:

指定されたパラメータを使用する SaslClient。null の場合もある。null の場合、このファクトリは、指定されたパラメータを使用して SaslClient を作成できない。

例外:

SaslException - エラーのために SaslClient を作成できない場合。

getMechanismNames

String[] getMechanismNames(Map<String,?> props)

指定されたメカニズム選択ポリシーに一致するメカニズム名の配列を返します。

パラメータ:

props - SASL メカニズムのセキュリティーポリシーの指定に使用されるプロパティーのセット。null の可能性もある。たとえば、props に含まれる Sasl.POLICY_NOPLAINTEXT プロパティーの値が "true" の場合、ファクトリは、単純な受動的攻撃を受けやすい SASL メカニズムを返してはいけない。ポリシープロパティーの完全なリストについては、Sasl クラスの説明を参照。props 内にポリシーと関連性のないプロパティー (String 以外のキーを持つマップエントリを含む) が存在する場合、無視される。

戻り値:

IANA に登録済みの SASL メカニズム名を含む null 以外の配列。