クラス LdapAuthenticationProviderConfigurer<B extends ProviderManagerBuilder<B>>
- java.lang.Object
-
- org.springframework.security.config.annotation.SecurityConfigurerAdapter<AuthenticationManager,B>
-
- org.springframework.security.config.annotation.authentication.configurers.ldap.LdapAuthenticationProviderConfigurer<B>
- 型パラメーター:
B
- これが構成しているProviderManagerBuilder
型。
- 実装されたすべてのインターフェース:
SecurityConfigurer<AuthenticationManager,B>
public class LdapAuthenticationProviderConfigurer<B extends ProviderManagerBuilder<B>> extends SecurityConfigurerAdapter<AuthenticationManager,B>
ProviderManagerBuilder
で LDAPAuthenticationProvider
を構成します。- 導入:
- 3.2
ネストされたクラスのサマリー
ネストされたクラス 修飾子と型 クラス 説明 class
LdapAuthenticationProviderConfigurer.ContextSourceBuilder
BaseLdapPathContextSource
を構築し、オプションで組み込み LDAP インスタンスを作成できます。class
LdapAuthenticationProviderConfigurer.PasswordCompareConfigurer
パスワードに基づく比較を設定する
コンストラクターのサマリー
コンストラクター コンストラクター 説明 LdapAuthenticationProviderConfigurer()
メソッドのサマリー
クラス org.springframework.security.config.annotation.SecurityConfigurerAdapter から継承されたメソッド
addObjectPostProcessor, and, getBuilder, init, postProcess, setBuilder
メソッドの詳細
ldapAuthoritiesPopulator
public LdapAuthenticationProviderConfigurer<B> ldapAuthoritiesPopulator(LdapAuthoritiesPopulator ldapAuthoritiesPopulator)
LdapAuthoritiesPopulator
を指定します。- パラメーター:
ldapAuthoritiesPopulator
-LdapAuthoritiesPopulator
デフォルトはDefaultLdapAuthoritiesPopulator
- 戻り値:
- さらにカスタマイズするための
LdapAuthenticationProviderConfigurer
withObjectPostProcessor
public LdapAuthenticationProviderConfigurer<B> withObjectPostProcessor(ObjectPostProcessor<?> objectPostProcessor)
このクラスにObjectPostProcessor
を追加します。- パラメーター:
objectPostProcessor
-- 戻り値:
- さらにカスタマイズするための
ChannelSecurityConfigurer
authoritiesMapper
public LdapAuthenticationProviderConfigurer<B> authoritiesMapper(GrantedAuthoritiesMapper grantedAuthoritiesMapper)
GrantedAuthoritiesMapper
を指定します。- パラメーター:
grantedAuthoritiesMapper
-GrantedAuthoritiesMapper
デフォルトはSimpleAuthorityMapper
- 戻り値:
- さらにカスタマイズするための
LdapAuthenticationProviderConfigurer
- 導入:
- 4.1.1
getAuthoritiesMapper
protected GrantedAuthoritiesMapper getAuthoritiesMapper() throws java.lang.Exception
GrantedAuthoritiesMapper
を取得し、デフォルトはSimpleAuthorityMapper
です。- 戻り値:
GrantedAuthoritiesMapper
- 例外:
java.lang.Exception
-SimpleAuthorityMapper.afterPropertiesSet()
にエラーがある場合
contextSource
public LdapAuthenticationProviderConfigurer<B> contextSource(org.springframework.ldap.core.support.BaseLdapPathContextSource contextSource)
使用するBaseLdapPathContextSource
を指定します。指定しない場合、組み込み LDAP サーバーはcontextSource()
を使用して作成されます。- パラメーター:
contextSource
- 使用するBaseLdapPathContextSource
- 戻り値:
- さらにカスタマイズするための
LdapAuthenticationProviderConfigurer
- 関連事項:
contextSource()
contextSource
public LdapAuthenticationProviderConfigurer.ContextSourceBuilder contextSource()
作成された組み込み LDAP サーバーを指すデフォルトで、BaseLdapPathContextSource
を簡単に構成できます。- 戻り値:
- さらにカスタマイズするための
LdapAuthenticationProviderConfigurer.ContextSourceBuilder
passwordEncoder
public LdapAuthenticationProviderConfigurer<B> passwordEncoder(PasswordEncoder passwordEncoder)
パスワード比較による認証時に使用するPasswordEncoder
を指定します。- パラメーター:
passwordEncoder
- 使用するPasswordEncoder
- 戻り値:
- さらにカスタマイズするための
LdapAuthenticationProviderConfigurer
userDnPatterns
public LdapAuthenticationProviderConfigurer<B> userDnPatterns(java.lang.String... userDnPatterns)
ユーザーがディレクトリ内の固定された場所にいる場合(つまり、ディレクトリ検索を行わずにユーザー名から直接 DN を計算できる場合)、この属性を使用して DN に直接マップできます。AbstractLdapAuthenticator の userDnPatterns プロパティに直接マップされます。この値は、"uid={0},ou=people" など、ユーザーの DN を構築するために使用される特定のパターンです。キー "{0}" が存在する必要があり、ユーザー名に置き換えられます。- パラメーター:
userDnPatterns
- ユーザー名を見つけるための LDAP パターン- 戻り値:
- さらにカスタマイズするための
LdapAuthenticationProviderConfigurer
userDetailsContextMapper
public LdapAuthenticationProviderConfigurer<B> userDetailsContextMapper(UserDetailsContextMapper userDetailsContextMapper)
ユーザーのディレクトリエントリからのコンテキスト情報で呼び出される UserDetailsContextMapper Bean を指定することにより、ロードされたユーザーオブジェクトを明示的にカスタマイズできます。- パラメーター:
userDetailsContextMapper
- 使用するUserDetailsContextMapper
- 戻り値:
- さらにカスタマイズするための
LdapAuthenticationProviderConfigurer
- 関連事項:
PersonContextMapper
,InetOrgPersonContextMapper
,LdapUserDetailsMapper
groupRoleAttribute
public LdapAuthenticationProviderConfigurer<B> groupRoleAttribute(java.lang.String groupRoleAttribute)
ロール名を含む属性名を指定します。デフォルトは "cn" です。- パラメーター:
groupRoleAttribute
- グループをロールにマップする属性名。- 戻り値:
- さらにカスタマイズするための
LdapAuthenticationProviderConfigurer
groupSearchBase
public LdapAuthenticationProviderConfigurer<B> groupSearchBase(java.lang.String groupSearchBase)
グループメンバーシップ検索の検索ベース。デフォルトは "" です。- パラメーター:
groupSearchBase
-- 戻り値:
- さらにカスタマイズするための
LdapAuthenticationProviderConfigurer
groupSearchSubtree
public LdapAuthenticationProviderConfigurer<B> groupSearchSubtree(boolean groupSearchSubtree)
true に設定すると、サブツリースコープ検索がグループメンバーシップに対して実行されます。false の場合、単一レベルの検索が使用されます。- パラメーター:
groupSearchSubtree
- true に設定すると、groupSearchBase のツリー全体の検索が有効になります。- 戻り値:
- さらにカスタマイズするための
LdapAuthenticationProviderConfigurer
groupSearchFilter
public LdapAuthenticationProviderConfigurer<B> groupSearchFilter(java.lang.String groupSearchFilter)
グループを検索する LDAP フィルター。デフォルトは "(uniqueMember={0})" です。置換されたパラメーターは、ユーザーの DN です。- パラメーター:
groupSearchFilter
- グループを検索する LDAP フィルター- 戻り値:
- さらにカスタマイズするための
LdapAuthenticationProviderConfigurer
rolePrefix
public LdapAuthenticationProviderConfigurer<B> rolePrefix(java.lang.String rolePrefix)
既存のロールのプレフィックスとして追加される空でない文字列プレフィックス。デフォルトは "ROLE_" です。- パラメーター:
rolePrefix
- ロードされるロールに追加されるプレフィックス。- 戻り値:
- さらにカスタマイズするための
LdapAuthenticationProviderConfigurer
- 関連事項:
SimpleAuthorityMapper.setPrefix(String)
userSearchBase
public LdapAuthenticationProviderConfigurer<B> userSearchBase(java.lang.String userSearchBase)
ユーザー検索の検索ベース。デフォルトは "" です。userSearchFilter(String)
でのみ使用されます。- パラメーター:
userSearchBase
- ユーザー検索の検索ベース- 戻り値:
- さらにカスタマイズするための
LdapAuthenticationProviderConfigurer
userSearchFilter
public LdapAuthenticationProviderConfigurer<B> userSearchFilter(java.lang.String userSearchFilter)
ユーザーの検索に使用される LDAP フィルター(オプション)。たとえば、"(uid={0})" です。置換されるパラメーターは、ユーザーのログイン名です。- パラメーター:
userSearchFilter
- ユーザーの検索に使用される LDAP フィルター- 戻り値:
- さらにカスタマイズするための
LdapAuthenticationProviderConfigurer
configure
public void configure(B builder) throws java.lang.Exception
インターフェースからコピーされた説明:SecurityConfigurer
SecurityBuilder
に必要なプロパティを設定して、SecurityBuilder
を構成します。- 次で指定:
- インターフェース
SecurityConfigurer<AuthenticationManager,B extends ProviderManagerBuilder<B>>
のconfigure
- オーバーライド:
- クラス
SecurityConfigurerAdapter<AuthenticationManager,B extends ProviderManagerBuilder<B>>
のconfigure
- 例外:
java.lang.Exception
passwordCompare
public LdapAuthenticationProviderConfigurer.PasswordCompareConfigurer passwordCompare()
- 戻り値:
- さらにカスタマイズするための
LdapAuthenticationProviderConfigurer.PasswordCompareConfigurer