StandardPasswordHistoryAccessor (javadoc-all-dev 8.0.0 API)

java.lang.Object
- jp.co.intra_mart.foundation.security.password.StandardPasswordHistoryAccessor

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

public class StandardPasswordHistoryAccessor
extends Object
implements PasswordHistoryAccessor

パスワード履歴管理アクセッサクラス。

パスワード履歴の読み込みおよび書き込みクラスです。

タグ名	属性	説明	デフォルト値
change-password-first-login	(なし)	初回ログイン時のパスワード変更要求の有無を設定します。	false
password-expire-limit	(なし)	パスワードの有効期限（日数）を設定します。0の場合無期限となります。	0
password-history-count	(なし)	何世代前まで世代管理を行うかを設定します。0の場合履歴管理を行いません。	0
deny-client-types	(なし)	パスワード変更画面に遷移させないクライアントタイプをカンマ区切りで設定します。	(なし)
password-expire-page	client-type	パスワード変更画面ＵＲＬを設定します。（client-type属性値別に複数指定できます。） client-type属性：クライアントタイプこの属性を指定したタグ内でクライアント別のURLを指定します。	/user/password/expire
check-password	enable	パスワードチェックの利用有無を判定します。 enable属性： true：利用 false：利用なし check-password-class属性：Javaインタフェース jp.co.intra_mart.foundation.security.password.PasswordHistoryAccessor を実装したクラスのFQDNを指定してください。指定されている場合は、指定されたクラスの `checkPassword(String, String, String)` メソッドに処理が委譲されます。	false
check-password	check-password-class		(なし)
check-password-length	enable	パスワードの文字数判定の利用有無とその範囲を設定します。 enable属性： true：利用 false：利用なし min属性：パスワードの最小文字数（半角数字,0以上）を設定します。 max属性：パスワードの最大文字数（半角数字,最大50）を設定します。 51文字以上は入力した場合は、50文字に設定されます。 min属性 < max属性の関係になっていない場合はデフォルト値が設定されます。	false
	min		0
	max		50
allow-latin-letters	required	使用可能文字の設定(アルファベット)を行います。 required属性：使用可能文字から最低1文字は設定を必要とするかどうか true：設定を必要とする false：設定を必要としない enable属性： true：利用 false：利用なし	allow-latin-lettersタグ：ABCDEFGHIJKLMNOPQRSTUVWXYZ abcdefghijklmnopqrstuvwxyz required属性：false enable属性：true
allow-latin-letters	enable
allow-number	required	使用可能文字の設定(数字)を行います。 required属性：使用可能文字から最低1文字は設定を必要とするかどうか true：設定を必要とする false：設定を必要としない enable属性： true：利用 false：利用なし	allow-numberタグ：0123456789 required属性：false enable属性：true
allow-number	enable		allow-numberタグ：0123456789 required属性：false enable属性：true
allow-extra-char	required	使用可能文字の設定（その他の文字列、記号など)を行います。 required属性：使用可能文字から最低1文字は設定を必要とするかどうか true：設定を必要とする false：設定を必要としない enable属性： true：利用 false：利用なし	allow-extra-charタグ：_-.+$#!/@ required属性：false enable属性：true
allow-extra-char	enable		allow-extra-charタグ：_-.+$#!/@ required属性：false enable属性：true
allow-group-char	required	使用可能文字グループの設定を行います。複数設定することが可能です。 required属性：使用可能文字から最低1文字は設定を必要とするかどうか true：設定を必要とする false：設定を必要としない	allow-group-charタグ：(なし) required属性：false
deny-old-password	include	パスワード履歴管理で管理されているパスワードと一致する場合に拒否するかどうかを設定します。 true：拒否する false：拒否しない include属性： true：パスワード履歴管理で管理されているパスワードを含む場合に拒否する false：拒否しない	deny-old-passwordタグ：false include属性：false
deny-userid	include	useridと同じパスワードを拒否するかどうかを設定します。 true：拒否する false：拒否しない include属性： true：useridを含む場合に拒否する false：拒否しない	deny-useridタグ：false include属性：false
password-cryption-class	(なし)	暗号化を行うクラスを設定します。アカウントのパスワードを不可逆な形式で保存する設定を行っている場合はこの設定は無視され、アカウントのパスワードと同じ形式でハッシュ化されます。	jp.co.intra_mart. foundation.security.cryption. standard.StandardCryption
return-initial-page	(なし)	パスワード有効期限切れの場合、パスワード変更後ログイン画面に戻るかそのままログイン処理を継続してログインするか判定します。 true:ログイン画面に戻ります。 false:ログイン処理を継続してログインします。	false

バージョンによる挙動の変更について

version 8.0.13 以降、以下のメソッドの挙動に変更があります。詳細は各メソッドの説明を参照してください。

#getPasswordHistories(String)
#getLatestPasswordHistory(String)

導入されたバージョン:: 8.0.0
バージョン:: 8.0.29

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

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

StandardPasswordHistoryAccessor()

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

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`void`	`addPasswordHistory(String groupId, String userCd, String password)` パスワード履歴の追加。
`PasswordHistoryResult`	`checkPassword(String groupId, String userId, String password)` 入力パスワードのチェック。
`PasswordHistoryResult`	`checkPasswordHistory(String groupId, String userId, String password)` 入力パスワードのチェック。
`void`	`clearPasswordHistories(String groupId)` パスワード履歴の消去。
`void`	`clearPasswordHistory(String groupId, String userCd)` 指定ユーザのパスワード履歴の消去。
`String`	`createPassword(int count)` パスワードをランダムに生成。
`PasswordHistory`	`getLatestPasswordHistory(String groupId, String userCd)` 最新のパスワードと更新日付を取得。
`int`	`getPasswordExpireLimit(String groupId)` 設定したパスワードの有効期限を取得。
`PasswordHistory[]`	`getPasswordHistories(String groupId, String userCd)` パスワード履歴を取得。
`int`	`getPasswordHistoryCount(String groupId, String userCd)` パスワード履歴数を取得。
`int`	`getPasswordHistoryManagedCount(String groupId)` 世代管理数を取得。
`String`	`getPasswordPage(String groupId)` パスワード変更画面のＵＲＬを取得。
`void`	`init(Node defaultNode, Node groupNode)` パラメータを取得。
`boolean`	`isChangePasswordFirstLogin(String groupId)` 初回ログイン時にパスワード変更要求を行うかの判定。
`boolean`	`isDenyClientType(String clientType)` クライアントタイプの判定パラメータdeny-client-typesに記述があるクライアントタイプの判定を行う。
`boolean`	`isFirstLogin(String groupId, String userId)` 初回ログインの判定
`boolean`	`isForwardInitialPage(String groupId)` パスワード変更後の画面遷移。
`boolean`	`isPasswordExpired(String groupId, String userId, String clientType, Date date)` パスワードが有効期限切れかどうかの判定。
`boolean`	`isPasswordHistoryManaged(String groupId)` 履歴管理の有無。
`boolean`	`setFirstLogin(String groupId, String userId, boolean isFirstLogin)` 初回ログインの設定を行います。
`void`	`verifyPasswordHistory(String groupId, String userCd, int remain)` ユーザのパスワードを消去。

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

- コンストラクタの詳細
  - StandardPasswordHistoryAccessor
```
public StandardPasswordHistoryAccessor()
```
- メソッドの詳細
  - addPasswordHistory
```
public void addPasswordHistory(String groupId,
                               String userCd,
                               String password)
                        throws PasswordHistoryException
```
    パスワード履歴の追加。
    
    指定ユーザの入力パスワードをデータベースに追加します。
    
    定義:
    
    addPasswordHistory インタフェース内 PasswordHistoryAccessor
    
    パラメータ:
    
    groupId - (グループID) - 互換用パラメータのため利用していません。
    
    userCd - ユーザCD
    
    password - 入力パスワード
    
    例外:
    
    PasswordHistoryException - パスワード履歴の追加に失敗した場合にスローされます。
  - checkPassword
```
public PasswordHistoryResult checkPassword(String groupId,
                                           String userId,
                                           String password)
                                    throws PasswordHistoryException
```
    入力パスワードのチェック。
    
    このメソッドではパスワードの利用可能文字のみチェックを行います。
    パスワードの世代管理チェックは行いません。
    旧パスワードの使用禁止についてもチェックを行いたい場合は、checkPasswordHistory(String, String, String) を利用してください。
    
    パスワードの文字数をチェックします。
    パスワードが51文字以上の場合、falseを返します。
    
    パスワードの入力チェックの利用について判定します。
    パラメータ"check-password"で設定した値が設定した値がfalseの場合trueを返します。パスワードチェックは行いません。
    trueの場合は以下のパスワードチェックを行います。
    ただし、"check-password"の"check-password-class"属性に以下のJavaインタフェースを実装したクラスのFQDNが指定されている場合は、指定されたクラスの checkPassword(String, String, String) メソッドに処理を委譲します。
    jp.co.intra_mart.foundation.security.password.PasswordHistoryAccessor
    
    "check-password-length"の"enable"属性がtrueの場合、文字数チェックを行います。
    
    "deny-userid"がtrueの場合useridと同一パスワードの判定を行います。
    "deny-userid"の"include"属性がtrueの場合、useridを含むパスワードかの判定も行います。
    
    使用不可能文字が混在していないかチェックを行います。
    
    パスワードに設定が必要な文字が含まれているかどうかチェックを行います。
    設定が必要な文字は、以下の各パラメータの"required"属性にtrueが設定されている場合、各パラメータ内で設定されている文字から最低1文字は設定が必要になります。
    - "allow-latin-letters"
    - "allow-number"
    - "allow-extra-char"
    - "allow-group-char"
    設定が必要な文字が存在する場合、パスワードの文字数は設定が必要な文字数以上に設定する必要があります。
    定義:
    
    checkPassword インタフェース内 PasswordHistoryAccessor
    
    パラメータ:
    
    groupId - (グループID) - 互換用パラメータのため利用していません。
    
    userId - ユーザID
    
    password - 入力パスワード
    
    戻り値:
    
    true：入力チェック成功 false：入力チェック失敗,メッセージ,詳細メッセージ
    
    例外:
    
    PasswordHistoryException - 入力パスワードのチェックに失敗した場合にスローされます。
  - checkPasswordHistory
```
public PasswordHistoryResult checkPasswordHistory(String groupId,
                                                  String userId,
                                                  String password)
                                           throws PasswordHistoryException
```
    入力パスワードのチェック。
    
    このメソッドでは以下のパスワードのチェックを行います。
    - checkPassword(String, String, String) によるパスワードチェックを行います。
    - パスワードの入力チェックの利用について判定します。
      パラメータ"check-password"で設定した値がfalseの場合trueを返します。パスワードチェックは行いません。
    - パラメータ"deny-old-password"または"include"属性がtrue、かつ"password-history-count"が0より大きい場合、世代管理チェックを行います。
    定義:
    
    checkPasswordHistory インタフェース内 PasswordHistoryAccessor
    
    パラメータ:
    
    groupId - (グループID) - 互換用パラメータのため利用していません。
    
    userId - ユーザID
    
    password - 入力パスワード
    
    戻り値:
    
    true：入力チェック成功 false：入力チェック失敗,メッセージ,詳細メッセージ
    
    例外:
    
    PasswordHistoryException - 入力パスワードのチェックに失敗した場合にスローされます。
  - clearPasswordHistories
```
public void clearPasswordHistories(String groupId)
                            throws PasswordHistoryException
```
    パスワード履歴の消去。
    
    パスワード履歴をすべて消去します。
    
    定義:
    
    clearPasswordHistories インタフェース内 PasswordHistoryAccessor
    
    パラメータ:
    
    groupId - (グループID) - 互換用パラメータのため利用していません。
    
    例外:
    
    PasswordHistoryException - パスワード履歴の消去に失敗した場合にスローされます。
  - clearPasswordHistory
```
public void clearPasswordHistory(String groupId,
                                 String userCd)
                          throws PasswordHistoryException
```
    指定ユーザのパスワード履歴の消去。
    
    引数のユーザのパスワード履歴を消去します。
    
    定義:
    
    clearPasswordHistory インタフェース内 PasswordHistoryAccessor
    
    パラメータ:
    
    groupId - (グループID) - 互換用パラメータのため利用していません。
    
    userCd - ユーザCD
    
    例外:
    
    PasswordHistoryException - 指定ユーザのパスワード履歴の消去に失敗した場合にスローされます。
  - createPassword
```
public String createPassword(int count)
```
    パスワードをランダムに生成。
    
    引数の値の長さのパスワードをランダムに生成します。
    呼出し毎に異なるパスワードを生成します。
    
    定義:
    
    createPassword インタフェース内 PasswordHistoryAccessor
    
    パラメータ:
    
    count - パスワードの長さ
    負の値を設定した場合は、10文字で作成します。
    ただし、パスワードの最小文字数の設定が10文字より大きい場合は、最小文字数の長さとします。
    また、設定が必要なパスワード文字数がパスワードの最小文字数がより大きい場合は、設定が必要なパスワード文字数の長さとします。
    
    戻り値:
    
    生成されたパスワード
  - getLatestPasswordHistory
```
public PasswordHistory getLatestPasswordHistory(String groupId,
                                                String userCd)
                                         throws PasswordHistoryException
```
    最新のパスワードと更新日付を取得。
    
    指定ユーザの最新パスワードと更新日付を取得します。
    アカウントパスワードを不可逆な形式で保存する設定の場合、パスワード履歴管理情報に設定されるパスワード値はnullとなります。
    
    定義:
    
    getLatestPasswordHistory インタフェース内 PasswordHistoryAccessor
    
    パラメータ:
    
    groupId - (グループID) - 互換用パラメータのため利用していません。
    
    userCd - ユーザID
    
    戻り値:
    
    パスワード、更新日付
    
    例外:
    
    PasswordHistoryException - 最新のパスワード情報の取得に失敗した場合にスローされます。
  - getPasswordExpireLimit
```
public int getPasswordExpireLimit(String groupId)
```
    設定したパスワードの有効期限を取得。
    
    パラメータで設定したパスワードの有効期限日数を取得します。
    
    定義:
    
    getPasswordExpireLimit インタフェース内 PasswordHistoryAccessor
    
    パラメータ:
    
    groupId - (グループID) - 互換用パラメータのため利用していません。
    
    戻り値:
    
    パスワード有効期限日数
  - getPasswordHistories
```
public PasswordHistory[] getPasswordHistories(String groupId,
                                              String userCd)
                                       throws PasswordHistoryException
```
    パスワード履歴を取得。
    
    指定ユーザのパスワード履歴を取得します。
    アカウントパスワードを不可逆な形式で保存する設定の場合、パスワード履歴管理情報に設定されるパスワード値はnullとなります。
    
    定義:
    
    getPasswordHistories インタフェース内 PasswordHistoryAccessor
    
    パラメータ:
    
    groupId - (グループID) - 互換用パラメータのため利用していません。
    
    userCd - ユーザID
    
    戻り値:
    
    指定ユーザのパスワード履歴一覧
    
    例外:
    
    PasswordHistoryException - パスワード履歴の取得に失敗した場合にスローされます。
  - getPasswordHistoryCount
```
public int getPasswordHistoryCount(String groupId,
                                   String userCd)
                            throws PasswordHistoryException
```
    パスワード履歴数を取得。
    
    指定ユーザのパスワード履歴数を取得します。
    
    定義:
    
    getPasswordHistoryCount インタフェース内 PasswordHistoryAccessor
    
    パラメータ:
    
    groupId - (グループID) - 互換用パラメータのため利用していません。
    
    userCd - ユーザID
    
    戻り値:
    
    パスワード履歴数
    
    例外:
    
    PasswordHistoryException - パスワード履歴数の取得に失敗した場合にスローされます。
  - getPasswordHistoryManagedCount
```
public int getPasswordHistoryManagedCount(String groupId)
```
    世代管理数を取得。
    
    パスワードの世代管理数を取得します。
    
    定義:
    
    getPasswordHistoryManagedCount インタフェース内 PasswordHistoryAccessor
    
    パラメータ:
    
    groupId - (グループID) - 互換用パラメータのため利用していません。
    
    戻り値:
    
    パスワード世代管理数
  - getPasswordPage
```
public String getPasswordPage(String groupId)
```
    パスワード変更画面のＵＲＬを取得。
    
    パスワード変更画面のＵＲＬを取得します。
    
    定義:
    
    getPasswordPage インタフェース内 PasswordHistoryAccessor
    
    パラメータ:
    
    groupId - (グループID) - 互換用パラメータのため利用していません。
    
    戻り値:
    
    パスワード変更画面のＵＲＬ
  - init
```
public void init(Node defaultNode,
                 Node groupNode)
```
    パラメータを取得。
    
    設定したパスワード履歴管理に関するパラメータを取得します。
    
    定義:
    
    init インタフェース内 PasswordHistoryAccessor
    
    パラメータ:
    
    defaultNode - デフォルトパラメータ
    
    groupNode - グループパラメータ
  - isChangePasswordFirstLogin
```
public boolean isChangePasswordFirstLogin(String groupId)
```
    初回ログイン時にパスワード変更要求を行うかの判定。
    
    定義:
    
    isChangePasswordFirstLogin インタフェース内 PasswordHistoryAccessor
    
    パラメータ:
    
    groupId - (グループID) - 互換用パラメータのため利用していません。
    
    戻り値:
    
    true：パスワード変更要求を行う / false：パスワード変更要求を行わない
  - isDenyClientType
```
public boolean isDenyClientType(String clientType)
```
    クライアントタイプの判定
    
    パラメータdeny-client-typesに記述があるクライアントタイプの判定を行う。
    
    定義:
    
    isDenyClientType インタフェース内 PasswordHistoryAccessor
    
    パラメータ:
    
    clientType - クライアントタイプ
    
    戻り値:
    
    true：クライアントタイプが含まれている false：クライアントタイプが含まれていない
  - isFirstLogin
```
public boolean isFirstLogin(String groupId,
                            String userId)
```
    初回ログインの判定
    
    定義:
    
    isFirstLogin インタフェース内 PasswordHistoryAccessor
    
    パラメータ:
    
    groupId - (グループID) - 互換用パラメータのため利用していません。
    
    userId - ユーザID
    
    戻り値:
    
    true：初回ログイン / false：初回ログインではない
  - isForwardInitialPage
```
public boolean isForwardInitialPage(String groupId)
```
    パスワード変更後の画面遷移。
    
    パスワードの有効期限切れによるパスワード再設定後、ログイン画面に戻るか、ログイン処理を継続してログインするかを判定します。
    
    定義:
    
    isForwardInitialPage インタフェース内 PasswordHistoryAccessor
    
    パラメータ:
    
    groupId - (グループID) - 互換用パラメータのため利用していません。
    
    戻り値:
    
    true：ログイン画面に戻ります。 false：ログイン処理を継続してログインします。
  - isPasswordExpired
```
public boolean isPasswordExpired(String groupId,
                                 String userId,
                                 String clientType,
                                 Date date)
```
    パスワードが有効期限切れかどうかの判定。
    
    パスワードが有効期限切れかどうかを行うか判定します。
    クライアントタイプがdeny-client-typesに記述されているクライアントタイプの場合はパスワードの有効期限チェックを行いません。
    
    定義:
    
    isPasswordExpired インタフェース内 PasswordHistoryAccessor
    
    パラメータ:
    
    groupId - (グループID) - 互換用パラメータのため利用していません。
    
    userId - ユーザID
    
    clientType - クライアントタイプ
    
    date - パスワードのチェックの基準となる日付。省略された場合、現在日付が利用されます。
    
    戻り値:
    
    true：パスワード変更要求を行います。 false：パスワード変更要求を行いません。
  - isPasswordHistoryManaged
```
public boolean isPasswordHistoryManaged(String groupId)
```
    履歴管理の有無。
    
    履歴管理を行うかどうか判定します。
    パラメータ"password-expire-limit"が0の場合履歴管理は行いません。
    
    定義:
    
    isPasswordHistoryManaged インタフェース内 PasswordHistoryAccessor
    
    パラメータ:
    
    groupId - (グループID) - 互換用パラメータのため利用していません。
    
    戻り値:
    
    true：履歴管理を行います。 false：履歴管理を行いません。
  - setFirstLogin
```
public boolean setFirstLogin(String groupId,
                             String userId,
                             boolean isFirstLogin)
```
    初回ログインの設定を行います。
    
    指定ユーザを初回ログインとする設定を行います。
    
    定義:
    
    setFirstLogin インタフェース内 PasswordHistoryAccessor
    
    パラメータ:
    
    groupId - (グループID) - 互換用パラメータのため利用していません。
    
    userId - ユーザID
    
    isFirstLogin - 初回ログインとするかどうか？
    
    戻り値:
    
    処理が成功した場合はtrue
  - verifyPasswordHistory
```
public void verifyPasswordHistory(String groupId,
                                  String userCd,
                                  int remain)
                           throws PasswordHistoryException
```
    ユーザのパスワードを消去。
    
    引数 remain の値分残してユーザの履歴を消去します。
    引数 remain が0以下の場合、履歴をすべて消去します。
    
    定義:
    
    verifyPasswordHistory インタフェース内 PasswordHistoryAccessor
    
    パラメータ:
    
    groupId - (グループID) - 互換用パラメータのため利用していません。
    
    userCd - ユーザCD
    
    remain - 残す履歴の数
    
    例外:
    
    PasswordHistoryException - パスワード履歴の消去に失敗した場合にスローされます。

クラス StandardPasswordHistoryAccessor

バージョンによる挙動の変更について

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

メソッドのサマリー

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

コンストラクタの詳細

StandardPasswordHistoryAccessor

メソッドの詳細

addPasswordHistory

checkPassword

checkPasswordHistory

clearPasswordHistories

clearPasswordHistory

createPassword

getLatestPasswordHistory

getPasswordExpireLimit

getPasswordHistories

getPasswordHistoryCount

getPasswordHistoryManagedCount

getPasswordPage

init

isChangePasswordFirstLogin

isDenyClientType

isFirstLogin

isForwardInitialPage

isPasswordExpired

isPasswordHistoryManaged

setFirstLogin

verifyPasswordHistory