RememberMeTokenAuthenticationProvider (iplass-core 3.1.13 API)

java.lang.Object
- org.iplass.mtp.impl.auth.authenticate.rememberme.RememberMeTokenAuthenticationProvider

すべての実装されたインタフェース:: AuthenticationProvider, AutoLoginHandler, ServiceInitListener<AuthService>

public class RememberMeTokenAuthenticationProvider
extends java.lang.Object
implements AuthenticationProvider, AutoLoginHandler

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

コンストラクタ
コンストラクタと説明

RememberMeTokenAuthenticationProvider()

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

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`void`	`afterLoginSuccess(AccountHandle account)` ログイン処理が成功した後のコールバック
`void`	`afterLogout(AccountHandle user)` ログアウト処理が完了（セッションも無効化）した後のコールバック
`void`	`cleanupData()` ハウスキーピング処理から呼び出される。
`void`	`destroyed()` Service破棄時に呼び出されます。
`AccountManagementModule`	`getAccountManagementModule()` AuthenticationProviderがアカウントの登録、更新、削除機能を保持する場合、その操作インタフェースであるAccountManagementModuleを返却する。
`AuthenticationProvider`	`getAuthenticationProvider()`
`AuthLogger`	`getAuthLogger()` このProviderで利用するAuthLoggerを取得。
`java.lang.String`	`getAuthTokenType()`
`AutoLoginHandler`	`getAutoLoginHandler()`
`AuthTokenClientStore`	`getClientStore()`
`java.lang.Class<? extends Credential>`	`getCredentialType()`
`java.lang.String`	`getProviderName()` Service-Configに設定された認証プロバイダ名を取得する。
`TrustedAuthValidator`	`getTrustedAuthValidator()`
`UserEntityResolver`	`getUserEntityResolver()`
`AutoLoginInstruction`	`handle(RequestContext req, boolean isLogined, UserContext user)`
`java.lang.Exception`	`handleException(AutoLoginInstruction ali, ApplicationException e, RequestContext req, boolean isLogined, UserContext user)`
`void`	`handleSuccess(AutoLoginInstruction ali, RequestContext req, UserContext user)`
`void`	`inited(AuthService service, Config config)` Service初期化時に呼び出されます。
`boolean`	`isDeleteTokenOnFailure()`
`boolean`	`isSelectableOnAuthPolicy()`
`AccountHandle`	`login(Credential credential)` ログイン処理を行い、認証されたユーザへの参照を示すUserHandleを返す。
`void`	`logout(AccountHandle user)` 指定のユーザのログアウト処理をする。
`void`	`setAuthenticationProvider(AuthenticationProvider baseAuthenticationProvider)`
`void`	`setAuthTokenType(java.lang.String authTokenType)`
`void`	`setClientStore(AuthTokenClientStore clientStore)`
`void`	`setDeleteTokenOnFailure(boolean deleteTokenOnFailure)`
`void`	`setProviderName(java.lang.String providerName)`
`void`	`setSelectableOnAuthPolicy(boolean selectableOnAuthPolicy)`
`void`	`setTrustedAuthValidator(TrustedAuthValidator trustedAuthValidator)`

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- コンストラクタの詳細
  - RememberMeTokenAuthenticationProvider
```
public RememberMeTokenAuthenticationProvider()
```
- メソッドの詳細
  - getAuthenticationProvider
```
public AuthenticationProvider getAuthenticationProvider()
```
  - setAuthenticationProvider
```
public void setAuthenticationProvider(AuthenticationProvider baseAuthenticationProvider)
```
  - isDeleteTokenOnFailure
```
public boolean isDeleteTokenOnFailure()
```
  - setDeleteTokenOnFailure
```
public void setDeleteTokenOnFailure(boolean deleteTokenOnFailure)
```
  - getClientStore
```
public AuthTokenClientStore getClientStore()
```
  - setClientStore
```
public void setClientStore(AuthTokenClientStore clientStore)
```
  - getAuthTokenType
```
public java.lang.String getAuthTokenType()
```
  - setAuthTokenType
```
public void setAuthTokenType(java.lang.String authTokenType)
```
  - inited
```
public void inited(AuthService service,
                   Config config)
```
    インタフェースからコピーされた説明: ServiceInitListener
    
    Service初期化時に呼び出されます。
    
    定義:
    
    inited インタフェース内 ServiceInitListener<AuthService>
  - destroyed
```
public void destroyed()
```
    インタフェースからコピーされた説明: ServiceInitListener
    
    Service破棄時に呼び出されます。
    
    定義:
    
    destroyed インタフェース内 ServiceInitListener<AuthService>
  - cleanupData
```
public void cleanupData()
```
    インタフェースからコピーされた説明: AuthenticationProvider
    
    ハウスキーピング処理から呼び出される。ゴミデータを消す。
    
    定義:
    
    cleanupData インタフェース内 AuthenticationProvider
  - login
```
public AccountHandle login(Credential credential)
```
    インタフェースからコピーされた説明: AuthenticationProvider
    
    ログイン処理を行い、認証されたユーザへの参照を示すUserHandleを返す。
    
    定義:
    
    login インタフェース内 AuthenticationProvider
    
    戻り値:
  - afterLoginSuccess
```
public void afterLoginSuccess(AccountHandle account)
```
    インタフェースからコピーされた説明: AuthenticationProvider
    
    ログイン処理が成功した後のコールバック
    
    定義:
    
    afterLoginSuccess インタフェース内 AuthenticationProvider
  - afterLogout
```
public void afterLogout(AccountHandle user)
```
    インタフェースからコピーされた説明: AuthenticationProvider
    
    ログアウト処理が完了（セッションも無効化）した後のコールバック
    
    定義:
    
    afterLogout インタフェース内 AuthenticationProvider
  - logout
```
public void logout(AccountHandle user)
```
    インタフェースからコピーされた説明: AuthenticationProvider
    
    指定のユーザのログアウト処理をする。
    
    定義:
    
    logout インタフェース内 AuthenticationProvider
  - getAccountManagementModule
```
public AccountManagementModule getAccountManagementModule()
```
    インタフェースからコピーされた説明: AuthenticationProvider
    
    AuthenticationProviderがアカウントの登録、更新、削除機能を保持する場合、その操作インタフェースであるAccountManagementModuleを返却する。登録、更新、削除ができない場合は、nullを返却する。
    
    定義:
    
    getAccountManagementModule インタフェース内 AuthenticationProvider
    
    戻り値:
  - isSelectableOnAuthPolicy
```
public boolean isSelectableOnAuthPolicy()
```
    定義:
    
    isSelectableOnAuthPolicy インタフェース内 AuthenticationProvider
  - setSelectableOnAuthPolicy
```
public void setSelectableOnAuthPolicy(boolean selectableOnAuthPolicy)
```
  - getProviderName
```
public java.lang.String getProviderName()
```
    インタフェースからコピーされた説明: AuthenticationProvider
    
    Service-Configに設定された認証プロバイダ名を取得する。
    
    定義:
    
    getProviderName インタフェース内 AuthenticationProvider
    
    戻り値:
    
    String
  - setProviderName
```
public void setProviderName(java.lang.String providerName)
```
  - getAuthLogger
```
public AuthLogger getAuthLogger()
```
    インタフェースからコピーされた説明: AuthenticationProvider
    
    このProviderで利用するAuthLoggerを取得。 nullを返却した場合は、デフォルトのAuthLoggerが利用される。
    
    定義:
    
    getAuthLogger インタフェース内 AuthenticationProvider
    
    戻り値:
  - getUserEntityResolver
```
public UserEntityResolver getUserEntityResolver()
```
    定義:
    
    getUserEntityResolver インタフェース内 AuthenticationProvider
  - setTrustedAuthValidator
```
public void setTrustedAuthValidator(TrustedAuthValidator trustedAuthValidator)
```
  - getTrustedAuthValidator
```
public TrustedAuthValidator getTrustedAuthValidator()
```
    定義:
    
    getTrustedAuthValidator インタフェース内 AuthenticationProvider
  - getCredentialType
```
public java.lang.Class<? extends Credential> getCredentialType()
```
    定義:
    
    getCredentialType インタフェース内 AuthenticationProvider
  - getAutoLoginHandler
```
public AutoLoginHandler getAutoLoginHandler()
```
    定義:
    
    getAutoLoginHandler インタフェース内 AuthenticationProvider
  - handleException
```
public java.lang.Exception handleException(AutoLoginInstruction ali,
                                           ApplicationException e,
                                           RequestContext req,
                                           boolean isLogined,
                                           UserContext user)
```
    定義:
    
    handleException インタフェース内 AutoLoginHandler
  - handleSuccess
```
public void handleSuccess(AutoLoginInstruction ali,
                          RequestContext req,
                          UserContext user)
```
    定義:
    
    handleSuccess インタフェース内 AutoLoginHandler
  - handle
```
public AutoLoginInstruction handle(RequestContext req,
                                   boolean isLogined,
                                   UserContext user)
```
    定義:
    
    handle インタフェース内 AutoLoginHandler

クラス RememberMeTokenAuthenticationProvider

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

メソッドのサマリー

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

コンストラクタの詳細

RememberMeTokenAuthenticationProvider

メソッドの詳細

getAuthenticationProvider

setAuthenticationProvider

isDeleteTokenOnFailure

setDeleteTokenOnFailure

getClientStore

setClientStore

getAuthTokenType

setAuthTokenType

inited

destroyed

cleanupData

login

afterLoginSuccess

afterLogout

logout

getAccountManagementModule

isSelectableOnAuthPolicy

setSelectableOnAuthPolicy

getProviderName

setProviderName

getAuthLogger

getUserEntityResolver

setTrustedAuthValidator

getTrustedAuthValidator

getCredentialType

getAutoLoginHandler

handleException

handleSuccess

handle