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 を作成できない

例外:

エラーのため - SaslClient を作成できない場合、SaslException をスローする

SaslException

getMechanismNames

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

指定された機構選択ポリシーに一致する機構名の配列を返します。

パラメータ:

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

戻り値:

IANA に登録済みの SASL 機構名を含む null 以外の配列