compact3

com.sun.security.auth.module

クラスUnixLoginModule

java.lang.Object

com.sun.security.auth.module.UnixLoginModule

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

LoginModule

@Exported
public class UnixLoginModule
extends Object
implements LoginModule

このLoginModuleは、ユーザーのUnix Principal情報(UnixPrincipal、UnixNumericUserPrincipal、およびUnixNumericGroupPrincipal)をインポートして、現在のSubjectと関連付けます。

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

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

コンストラクタ

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

メソッドのサマリー

修飾子と型	メソッドと説明
boolean	abort() 認証を中止します(第2フェーズ)。
boolean	commit() 認証をコミットします(第2フェーズ)。
void	initialize(Subject subject, CallbackHandler callbackHandler, Map<String,?> sharedState, Map<String,?> options) このLoginModuleを初期化します。
boolean	login() ユーザーを認証します(第1フェーズ)。
boolean	logout() ユーザーをログアウトさせます。

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

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

コンストラクタの詳細

UnixLoginModule

public UnixLoginModule()

メソッドの詳細

initialize

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

このLoginModuleを初期化します。

定義:

initialize 、インタフェース: LoginModule

パラメータ:

subject - 認証対象のSubject。

callbackHandler - エンド・ユーザーとの通信(ユーザー名とパスワードの入力など)に使用されるCallbackHandler。

sharedState - 共有LoginModuleの状態。

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

login

public boolean login()
              throws LoginException

ユーザーを認証します(第1フェーズ)。

このメソッドを実装すると、ネイティブのUnixシステム・コールを行うことで、ユーザーのUnix Subject情報を取得しようとします。

定義:

login 、インタフェース: LoginModule

戻り値:

常にtrue (このLoginModuleを無視してはならない)。

例外:

FailedLoginException - 背後のシステム情報を取得しようとして失敗した場合。

LoginException - 認証に失敗した場合

commit

public boolean commit()
               throws LoginException

認証をコミットします(第2フェーズ)。

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

このLoginModule自体の認証が成功した場合(Unix認証情報のインポートに成功した場合)、Unix PrincipalがLoginModuleに現在結び付けられているSubjectと関連付けられます。このLoginModuleの認証に失敗した場合は、当初保存された状態が削除されます。

定義:

commit 、インタフェース: LoginModule

戻り値:

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

例外:

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

abort

public boolean abort()
              throws LoginException

認証を中止します(第2フェーズ)。

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

このメソッドは、loginメソッドやcommitメソッドの認証試行の一部として、当初保存された状態を消去します。

定義:

abort 、インタフェース: LoginModule

戻り値:

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

例外:

LoginException - 中止に失敗した場合

logout

public boolean logout()
               throws LoginException

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

このメソッドは、Subjectに関連付けられたプリンシパルを削除します。

定義:

logout 、インタフェース: LoginModule

戻り値:

常にtrue (このLoginModuleを無視してはならない)。

例外:

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