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

コンストラクタの概要

NTLoginModule()

メソッドの概要

boolean	abort() LoginContext の認証全体が失敗した場合 (関連する REQUIRED、REQUISITE、SUFFICIENT、および OPTIONAL の各 LoginModule が失敗した場合) に呼び出されます。
boolean	commit() LoginContext の認証全体が成功した場合 (関連する REQUIRED、REQUISITE、SUFFICIENT、および OPTIONAL の各 LoginModule が成功した場合) に呼び出されます。
void	initialize(Subject subject, CallbackHandler callbackHandler, Map sharedState, Map 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 sharedState,
                       Map options)

この LoginModule を初期化します。

定義:

インタフェース LoginModule 内の initialize

パラメータ:

subject - 認証を受ける Subject

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

sharedState - 共有 LoginModule の状態

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

login

public boolean login()
              throws LoginException

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

定義:

インタフェース LoginModule 内の login

戻り値:

この 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 自体のログインとコミットの試みが成功した場合は true、そうでない場合は false

例外:

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

abort

public boolean abort()
              throws LoginException

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

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

定義:

インタフェース LoginModule 内の abort

戻り値:

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

例外:

LoginException - 中止に失敗した場合

logout

public boolean logout()
               throws LoginException

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

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

定義:

インタフェース LoginModule 内の logout

戻り値:

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

例外:

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