com.handywedge.user.auth

インタフェース FWLoginManager

public interface FWLoginManager

認証に関連する処理のインターフェースです。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
boolean	authAPIToken(String token) APIトークンで認証を行います。
boolean	checkPassword(String id, String password) ログイン操作はせず、ユーザーIDとパスワードが正しいか確認のみ行います。
boolean	expirationAPIToken(String token) APIトークンの有効期限をチェックします。
void	login(String id) 認証なしでログイン処理のみ行います。
boolean	login(String id, String password) 引数のユーザーIDとパスワードが正しいか認証します。
void	logout() セッションからユーザー情報を削除します。
String	publishAPIToken(String id, boolean multiple) 引数のユーザーIDにAPIトークンを発行します。
void	removeAPIToken(String token) 引数のトークンを削除します。

メソッドの詳細

login

boolean login(String id,
              String password)

引数のユーザーIDとパスワードが正しいか認証します。
認証された場合はtrueを返し、同時にセッションのユーザー情報に値を設定します。
認証済のセッションでこのメソッドが呼ばれた場合は特に何もしません。
仮登録ユーザーの場合はパスワードが正しい場合でもfalseとなります。

パラメータ:

id - ユーザーID

password - パスワード

戻り値:

ユーザーIDとパスワードが正しい場合はtrue

login

void login(String id)

認証なしでログイン処理のみ行います。
このメソッドを実行する場合は事前に認証処理を実施して下さい。

パラメータ:

id - ユーザーID

checkPassword

boolean checkPassword(String id,
                      String password)

ログイン操作はせず、ユーザーIDとパスワードが正しいか確認のみ行います。
仮登録ユーザーの場合はパスワードが正しい場合でもfalseとなります。

パラメータ:

id - ユーザーID

password - パスワード

戻り値:

ユーザーIDとパスワードが正しい場合はtrue

logout

void logout()

セッションからユーザー情報を削除します。

publishAPIToken

String publishAPIToken(String id,
                       boolean multiple)

引数のユーザーIDにAPIトークンを発行します。
このメソッドでは認証処理は行われないので、必ずloginメソッドで認証を行ってから実行して下さい。
multiple=falseの場合、既にAPIトークンが発行されているユーザーは再発行します。
この場合、以前のAPIトークンは使用できなくなります。

パラメータ:

id - ユーザーID

multiple - 多重発行する場合はtrue

戻り値:

発行したAPIトークン

removeAPIToken

void removeAPIToken(String token)

引数のトークンを削除します。
トークンが発行されていない場合は特に何もしません。

パラメータ:

token - トークン

authAPIToken

boolean authAPIToken(String token)

APIトークンで認証を行います。
認証された場合はtrueを返します。

パラメータ:

token - APIトークン

戻り値:

認証された場合はtrue

expirationAPIToken

boolean expirationAPIToken(String token)

APIトークンの有効期限をチェックします。
有効期限内の場合はtrueを返します。

パラメータ:

token - APIトークン

戻り値:

有効期限内の場合はtrue

導入されたバージョン:

0.6.0