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

クラス LdapUserDetailsMapper

  • 実装されているすべてのインターフェース:
    UserDetailsContextMapper
    public class LdapUserDetailsMapper
extends java.lang.Object
implements UserDetailsContextMapper
    LDAP 認証プロバイダーが LDAP ユーザーオブジェクトを作成するために使用するコンテキストマッパー。

    • コンストラクターの概要

      コンストラクター  
      コンストラクター 説明
      LdapUserDetailsMapper()

    • メソッドのサマリー

      すべてのメソッド   インスタンスメソッド   具象メソッド  
      修飾子と型 メソッド 説明
      protected GrantedAuthoritycreateAuthority​(java.lang.Object role)
      ロール属性から GrantedAuthority を作成します。
      protected java.lang.StringmapPassword​(java.lang.Object passwordValue)
      ディレクトリに格納されている属性からユーザーのパスワードをカスタマイズして作成できるようにする拡張ポイント。
      UserDetailsmapUserFromContext​(org.springframework.ldap.core.DirContextOperations ctx, java.lang.String username, java.util.Collection<? extends GrantedAuthority> authorities)
      セキュリティフレームワークで使用するために完全に読み込まれた UserDetails オブジェクトを作成します。
      voidmapUserToContext​(UserDetails user, org.springframework.ldap.core.DirContextAdapter ctx)
      上記の操作の逆。
      voidsetConvertToUpperCase​(boolean convertToUpperCase)
      ロード時にロールフィールド値を大文字に変換するかどうかを決定します。
      voidsetPasswordAttributeName​(java.lang.String passwordAttributeName)
      ユーザーのパスワードを含む属性の名前。
      voidsetRoleAttributes​(java.lang.String[] roleAttributes)
      アプリケーションロールを表すユーザーのエントリ内の属性の名前。
      voidsetRolePrefix​(java.lang.String rolePrefix)
      ロール名に適用されるプレフィックス

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

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • コンストラクターの詳細

      • LdapUserDetailsMapper

        public LdapUserDetailsMapper()

    • メソッドの詳細

      • mapUserFromContext

        public UserDetails mapUserFromContext​(org.springframework.ldap.core.DirContextOperations ctx,
                                      java.lang.String username,
                                      java.util.Collection<? extends GrantedAuthority> authorities)
        インターフェースからコピーされた説明: UserDetailsContextMapper
        セキュリティフレームワークで使用するために完全に読み込まれた UserDetails オブジェクトを作成します。
        次で指定:
        インターフェース UserDetailsContextMapper の mapUserFromContext 
        パラメーター:
        ctx - ユーザー情報を含むコンテキストオブジェクト。
        username - ユーザーが指定したログイン名。
        戻り値:
        ユーザーオブジェクト。

      • mapUserToContext

        public void mapUserToContext​(UserDetails user,
                             org.springframework.ldap.core.DirContextAdapter ctx)
        インターフェースからコピーされた説明: UserDetailsContextMapper
        上記の操作の逆。指定されたユーザーオブジェクトからコンテキストオブジェクトを作成します。たとえば、ユーザーを保存するときに呼び出されます。
        次で指定:
        インターフェース UserDetailsContextMapper の mapUserToContext 

      • mapPassword

        protected java.lang.String mapPassword​(java.lang.Object passwordValue)
        ディレクトリに格納されている属性からユーザーのパスワードをカスタマイズして作成できるようにする拡張ポイント。
        パラメーター:
        passwordValue - パスワード属性の値
        戻り値:
        パスワードの文字列表現。

      • createAuthority

        protected GrantedAuthority createAuthority​(java.lang.Object role)
        ロール属性から GrantedAuthority を作成します。権限オブジェクトの作成をカスタマイズするためにオーバーライドします。

        デフォルトの実装では、rolePrefix および convertToUpperCase プロパティを使用して、文字列属性をロールに変換します。文字列以外の属性は無視されます。

        パラメーター:
        role - から返された属性
        戻り値:
        ユーザーの権限のリストに追加される権限。この属性を無視する必要がある場合は null

      • setConvertToUpperCase

        public void setConvertToUpperCase​(boolean convertToUpperCase)
        ロード時にロールフィールド値を大文字に変換するかどうかを決定します。デフォルトは true です。
        パラメーター:
        convertToUpperCase - ロールを大文字に変換する必要がある場合は true。

      • setPasswordAttributeName

        public void setPasswordAttributeName​(java.lang.String passwordAttributeName)
        ユーザーのパスワードを含む属性の名前。デフォルトは "userPassword" です。
        パラメーター:
        passwordAttributeName - 属性の名前

      • setRoleAttributes

        public void setRoleAttributes​(java.lang.String[] roleAttributes)
        アプリケーションロールを表すユーザーのエントリ内の属性の名前。これらは GrantedAuthority に変換され、返された LdapUserDetails オブジェクトのリストに追加されます。属性値はデフォルトで文字列でなければなりません。
        パラメーター:
        roleAttributes - ロール属性の名前。

      • setRolePrefix

        public void setRolePrefix​(java.lang.String rolePrefix)
        ロール名に適用されるプレフィックス
        パラメーター:
        rolePrefix - プレフィックス（デフォルトは "ROLE_" ）。