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