com.sun.security.auth.module

クラス UnixLoginModule

java.lang.Object

com.sun.security.auth.module.UnixLoginModule

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

LoginModule

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 自体の認証が成功した場合 (Solaris 認証情報のインポートに成功した場合)、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 - ログアウトに失敗した場合