org.iplass.mtp.impl.auth.authenticate

インタフェース AuthenticationProvider

すべてのスーパーインタフェース:

ServiceInitListener<AuthService>

既知の実装クラスのリスト:

AuthenticationProviderBase, BuiltinAuthenticationProvider, ConfigFileAuthenticationProvider, InternalAuthenticationProvider, JaasAuthenticationProvider, LdapAuthenticationProvider, RememberMeTokenAuthenticationProvider, SimpleAuthTokenAuthenticationProvider

public interface AuthenticationProvider
extends ServiceInitListener<AuthService>

ログイン認証Provider

メソッドのサマリー

修飾子とタイプ	メソッドと説明
default void	afterLoginSuccess(AccountHandle user) ログイン処理が成功した後のコールバック
default void	afterLogout(AccountHandle user) ログアウト処理が完了（セッションも無効化）した後のコールバック
void	cleanupData() ハウスキーピング処理から呼び出される。
AccountManagementModule	getAccountManagementModule() AuthenticationProviderがアカウントの登録、更新、削除機能を保持する場合、 その操作インタフェースであるAccountManagementModuleを返却する。
AuthLogger	getAuthLogger() 非推奨です。
default AutoLoginHandler	getAutoLoginHandler()
java.lang.Class<? extends Credential>	getCredentialType()
java.lang.String	getProviderName() Service-Configに設定された認証プロバイダ名を取得する。
TrustedAuthValidator	getTrustedAuthValidator()
UserEntityResolver	getUserEntityResolver()
boolean	isSelectableOnAuthPolicy()
AccountHandle	login(Credential credential) ログイン処理を行い、認証されたユーザへの参照を示すUserHandleを返す。
void	logout(AccountHandle user) 指定のユーザのログアウト処理をする。

インタフェースから継承されたメソッド org.iplass.mtp.spi.ServiceInitListener

destroyed, inited

メソッドの詳細

login

AccountHandle login(Credential credential)

ログイン処理を行い、認証されたユーザへの参照を示すUserHandleを返す。

パラメータ:

credential -

戻り値:

logout

void logout(AccountHandle user)

指定のユーザのログアウト処理をする。

パラメータ:

user -

afterLogout

default void afterLogout(AccountHandle user)

ログアウト処理が完了（セッションも無効化）した後のコールバック

afterLoginSuccess

default void afterLoginSuccess(AccountHandle user)

ログイン処理が成功した後のコールバック

パラメータ:

credential -

user -

getTrustedAuthValidator

TrustedAuthValidator getTrustedAuthValidator()

cleanupData

void cleanupData()

ハウスキーピング処理から呼び出される。ゴミデータを消す。

getAccountManagementModule

AccountManagementModule getAccountManagementModule()

AuthenticationProviderがアカウントの登録、更新、削除機能を保持する場合、 その操作インタフェースであるAccountManagementModuleを返却する。 登録、更新、削除ができない場合は、nullを返却する。

戻り値:

getProviderName

java.lang.String getProviderName()

Service-Configに設定された認証プロバイダ名を取得する。

戻り値:

String

getAuthLogger

@Deprecated
AuthLogger getAuthLogger()

非推奨です。

このProviderで利用するAuthLoggerを取得。 nullを返却した場合は、デフォルトのAuthLoggerが利用される。

戻り値:

getUserEntityResolver

UserEntityResolver getUserEntityResolver()

getCredentialType

java.lang.Class<? extends Credential> getCredentialType()

getAutoLoginHandler

default AutoLoginHandler getAutoLoginHandler()

isSelectableOnAuthPolicy

boolean isSelectableOnAuthPolicy()