com.sun.security.auth.module

クラス NTLoginModule

java.lang.Object

com.sun.security.auth.module.NTLoginModule

すべての実装されたインタフェース:

LoginModule

public class NTLoginModule
extends Object
implements LoginModule

この LoginModule は、ユーザーの NT セキュリティー情報をいくつかの Principal としてレンダリングし、それらを Subject に関連付けます。

この LoginModule ではデバッグオプションを利用できます。ログイン Configuration で true に設定した場合は、デバッグメッセージが出力ストリーム System.out に出力されます。

この LoginModule では debugNative オプションも利用できます。ログイン Configuration で true に設定した場合は、モジュールのネイティブコンポーネントからのデバッグメッセージが出力ストリーム System.out に出力されます。

関連項目:

LoginModule

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

コンストラクタ

コンストラクタと説明
NTLoginModule()

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
boolean	abort() このメソッドは、LoginContext の全体の認証に失敗した場合に呼び出されます。
boolean	commit() LoginContext の認証全体が成功した場合 (関連する REQUIRED、REQUISITE、SUFFICIENT、および OPTIONAL の各 LoginModule が成功した場合) に呼び出されます。
void	initialize(Subject subject, CallbackHandler callbackHandler, Map<String,?> sharedState, Map<String,?> options) この LoginModule を初期化します。
boolean	login() 対象の NT システム識別情報をインポートします。
boolean	logout() ユーザーをログアウトさせます。

クラス java.lang.Object から継承されたメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

NTLoginModule

public NTLoginModule()

メソッドの詳細

initialize

public void initialize(Subject subject,
              CallbackHandler callbackHandler,
              Map<String,?> sharedState,
              Map<String,?> options)

この LoginModule を初期化します。

定義:

initialize 、インタフェース: LoginModule

パラメータ:

subject - 認証対象の Subject。

callbackHandler - エンドユーザーとの通信 (ユーザー名とパスワードの入力など) に使用される CallbackHandler。この LoginModule は対象とする NT システム情報だけを抽出するため、このパラメータは無視される。

sharedState - 共有 LoginModule の状態。

options - この LoginModule 用にログイン Configuration で指定されたオプション。

login

public boolean login()
              throws LoginException

対象の NT システム識別情報をインポートします。

定義:

login 、インタフェース: LoginModule

戻り値:

この LoginModule を無視してはならないため、常に true。

例外:

FailedLoginException - 認証に失敗した場合。

LoginException - この LoginModule で認証が実行できない場合。

commit

public boolean commit()
               throws LoginException

LoginContext の認証全体が成功した場合 (関連する REQUIRED、REQUISITE、SUFFICIENT、および OPTIONAL の各 LoginModule が成功した場合) に呼び出されます。

この LoginModule 自体の認証が成功 (login メソッドによって保存された、非公開状態を取得することでチェックされる) した場合は、さまざまな Principal が LoginModuleContext 内の Subject と関連付けられます。この LoginModule 自体の認証が失敗した場合は、当初保存された状態を削除します。

定義:

commit 、インタフェース: LoginModule

戻り値:

この LoginModule 自体のログインとコミットの試みが成功した場合は true、そうでない場合は false。

例外:

LoginException - コミットに失敗した場合。

abort

public boolean abort()
              throws LoginException

このメソッドは、LoginContext の全体の認証に失敗した場合に呼び出されます。(関連する REQUIRED、REQUISITE、SUFFICIENT、および OPTIONAL の各 LoginModule が失敗した場合)。

この LoginModule 自体の認証が成功した場合は (login メソッドと commit メソッドによって保存された非公開状態を取得して調べる)、当初保存された状態を整理します。

定義:

abort 、インタフェース: LoginModule

戻り値:

この LoginModule 自体のログインやコミットの試みが失敗した場合は false、そうでない場合は true。

例外:

LoginException - 中止に失敗した場合。

logout

public boolean logout()
               throws LoginException

ユーザーをログアウトさせます。

このメソッドは、commit メソッドによって追加された可能性がある NTUserPrincipal、NTDomainPrincipal、NTSidUserPrincipal、NTSidDomainPrincipal、NTSidGroupPrincipal、および NTSidPrimaryGroupPrincipal を削除します。

定義:

logout 、インタフェース: LoginModule

戻り値:

この LoginModule を無視してはならないため、常に true。

例外:

LoginException - ログアウトに失敗した場合。