パッケージ org.springframework.security.core.userdetails

インターフェース UserDetails

  • すべてのスーパーインターフェース:
    java.io.Serializable
    すべての既知のサブインターフェース:
    LdapUserDetails
    すべての既知の実装クラス:
    InetOrgPerson、LdapUserDetailsImpl、Person、User
    public interface UserDetails
extends java.io.Serializable
    コアユーザー情報を提供します。

    実装は、セキュリティの目的で Spring Security によって直接使用されません。それらは、後で Authentication オブジェクトにカプセル化されるユーザー情報を単に保存します。これにより、セキュリティに関連しないユーザー情報（メールアドレス、電話番号など）を便利な場所に保存できます。

    具体的な実装では、各メソッドの詳細な非 null 契約が強制されるように特に注意する必要があります。リファレンス実装（コードで拡張または使用する場合があります）については、User を参照してください。

    関連事項:
    UserDetailsService, UserCache

    • メソッドのサマリー

      すべてのメソッド   インスタンスメソッド   抽象メソッド  
      修飾子と型 メソッド 説明
      java.util.Collection<? extends GrantedAuthority>getAuthorities()
      ユーザーに付与された権限を返します。
      java.lang.StringgetPassword()
      ユーザーの認証に使用されるパスワードを返します。
      java.lang.StringgetUsername()
      ユーザーの認証に使用されるユーザー名を返します。
      booleanisAccountNonExpired()
      ユーザーのアカウントの有効期限が切れているかどうかを示します。
      booleanisAccountNonLocked()
      ユーザーがロックされているかロック解除されているかを示します。
      booleanisCredentialsNonExpired()
      ユーザーの資格情報（パスワード）の有効期限が切れているかどうかを示します。
      booleanisEnabled()
      ユーザーが有効か無効かを示します。

    • メソッドの詳細

      • getAuthorities

        java.util.Collection<? extends GrantedAuthority> getAuthorities()
        ユーザーに付与された権限を返します。null を返すことができません。
        戻り値:
        自然キーでソートされた権限 (非 null)

      • getPassword

        java.lang.String getPassword()
        ユーザーの認証に使用されるパスワードを返します。
        戻り値:
        パスワード

      • getUsername

        java.lang.String getUsername()
        ユーザーの認証に使用されるユーザー名を返します。null を返すことはできません。
        戻り値:
        ユーザー名 (非 null)

      • isAccountNonExpired

        boolean isAccountNonExpired()
        ユーザーのアカウントの有効期限が切れているかどうかを示します。期限切れのアカウントは認証できません。
        戻り値:
        ユーザーのアカウントが有効な場合（つまり、有効期限が切れていない場合）true、有効でなくなった場合は false (つまり、期限切れ)

      • isAccountNonLocked

        boolean isAccountNonLocked()
        ユーザーがロックされているかロック解除されているかを示します。ロックされたユーザーは認証できません。
        戻り値:
        ユーザーがロックされていない場合は true、それ以外の場合は false 

      • isCredentialsNonExpired

        boolean isCredentialsNonExpired()
        ユーザーの資格情報（パスワード）の有効期限が切れているかどうかを示します。期限切れの資格情報は認証を妨げます。
        戻り値:
        ユーザーの資格情報が有効な場合（つまり、有効期限が切れていない場合）true、有効でなくなった場合は false (つまり、期限切れ)

      • isEnabled

        boolean isEnabled()
        ユーザーが有効か無効かを示します。無効なユーザーは認証できません。
        戻り値:
        ユーザーが有効な場合は true、それ以外の場合は false