モジュール jdk.security.auth

パッケージ 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()	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()

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 - ログアウトに失敗した場合。