SpringSecurityLdapTemplate (spring-security-docs-manual 5.3.2.RELEASE API)

java.lang.Object
- org.springframework.ldap.core.LdapTemplate
- - org.springframework.security.ldap.SpringSecurityLdapTemplate

実装済みのインターフェース一覧:
org.springframework.beans.factory.InitializingBean, org.springframework.ldap.core.LdapOperations
```
public class SpringSecurityLdapTemplate
extends org.springframework.ldap.core.LdapTemplate
```
Spring LDAP の LdapTemplate クラスを拡張したもので、Spring Security に必要な追加機能が追加されています。
導入:
2.0

ネストされたクラスの概要
- クラス org.springframework.ldap.core.LdapTemplate から継承されたネストクラス / インターフェース
  org.springframework.ldap.core.LdapTemplate.MappingCollectingNameClassPairCallbackHandler<T>, org.springframework.ldap.core.LdapTemplate.NullDirContextProcessor

フィールド概要

フィールド
修飾子と型	フィールドと説明
`static java.lang.String`	`DN_KEY` Map <String、String[]> によってレコードが定義されているすべての検索結果には、少なくともこのキー（レコード自体の DN）が含まれています。
`static java.lang.String[]`	`NO_ATTRS`

コンストラクター概要
コンストラクター
コンストラクターと説明
SpringSecurityLdapTemplate(org.springframework.ldap.core.ContextSource contextSource)

コンストラクター
コンストラクターと説明
`SpringSecurityLdapTemplate(org.springframework.ldap.core.ContextSource contextSource)`

方法の概要

すべてのメソッド静的メソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`boolean`	`compare(java.lang.String dn, java.lang.String attributeName, java.lang.Object value)` 特定のディレクトリエントリの属性値の LDAP 比較操作を実行します。
`org.springframework.ldap.core.DirContextOperations`	`retrieveEntry(java.lang.String dn, java.lang.String[] attributesToRetrieve)` 指定された DN の属性からオブジェクトを作成します。
`java.util.Set<java.util.Map<java.lang.String,java.util.List<java.lang.String>>>`	`searchForMultipleAttributeValues(java.lang.String base, java.lang.String filter, java.lang.Object[] params, java.lang.String[] attributeNames)` 提供されたフィルターを使用して検索を実行し、検索で一致したすべてのエントリで見つかった各名前付き属性の値を返します。
`java.util.Set<java.lang.String>`	`searchForSingleAttributeValues(java.lang.String base, java.lang.String filter, java.lang.Object[] params, java.lang.String attributeName)` 提供されたフィルターを使用して検索を実行し、検索に一致したすべてのエントリで見つかった名前付き属性の値の和集合を返します。
`org.springframework.ldap.core.DirContextOperations`	`searchForSingleEntry(java.lang.String base, java.lang.String filter, java.lang.Object[] params)` 単一のディレクトリエントリを返す必要があるという条件で検索を実行し、提供されたマッパーを使用してそのエントリからオブジェクトを作成します。
`static org.springframework.ldap.core.DirContextOperations`	`searchForSingleEntryInternal(javax.naming.directory.DirContext ctx, javax.naming.directory.SearchControls searchControls, java.lang.String base, java.lang.String filter, java.lang.Object[] params)` AD 検索でのコードの重複を回避するために抽出された内部メソッド。
`void`	`setSearchControls(javax.naming.directory.SearchControls searchControls)` テンプレートによる検索操作に使用される検索コントロールを設定します。

クラス org.springframework.ldap.core.LdapTemplate から継承されたメソッド
afterPropertiesSet, authenticate, authenticate, authenticate, authenticate, authenticate, authenticate, authenticate, authenticate, authenticate, authenticate, bind, bind, bind, create, delete, deleteRecursively, executeReadOnly, executeReadWrite, find, find, findAll, findAll, findByDn, findOne, getContextSource, getObjectDirectoryMapper, list, list, list, list, list, list, listBindings, listBindings, listBindings, listBindings, listBindings, listBindings, listBindings, listBindings, lookup, lookup, lookup, lookup, lookup, lookup, lookup, lookup, lookup, lookup, lookupContext, lookupContext, modifyAttributes, modifyAttributes, modifyAttributes, rebind, rebind, rebind, rename, rename, search, search, search, search, search, search, search, search, search, search, search, search, search, search, search, search, search, search, search, search, search, search, search, search, search, search, search, search, search, search, search, search, search, searchForContext, searchForObject, searchForObject, searchForObject, searchForObject, searchForObject, setContextSource, setDefaultCountLimit, setDefaultSearchScope, setDefaultTimeLimit, setIgnoreNameNotFoundException, setIgnorePartialResultException, setIgnoreSizeLimitExceededException, setObjectDirectoryMapper, unbind, unbind, unbind, unbind, update

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

- フィールドの詳細
  - NO_ATTRS
```
public static final java.lang.String[] NO_ATTRS
```
  - DN_KEY
```
public static final java.lang.String DN_KEY
```
    Map <String、String[]> によってレコードが定義されているすべての検索結果には、少なくともこのキー（レコード自体の DN）が含まれています。
    関連事項:
    定数フィールド値
- コンストラクターの詳細
  - SpringSecurityLdapTemplate
```
public SpringSecurityLdapTemplate(org.springframework.ldap.core.ContextSource contextSource)
```
- メソッドの詳細
  - compare
```
public boolean compare(java.lang.String dn,
                       java.lang.String attributeName,
                       java.lang.Object value)
```
    特定のディレクトリエントリの属性値の LDAP 比較操作を実行します。
    パラメーター:
    dn - 属性が使用されるエントリ
    attributeName - 比較したい値の属性
    value - ディレクトリ値に対してチェックされる値
    戻り値:
    指定された値がディレクトリ内の値と一致する場合は true
  - retrieveEntry
```
public org.springframework.ldap.core.DirContextOperations retrieveEntry(java.lang.String dn,
                                                                        java.lang.String[] attributesToRetrieve)
```
    指定された DN の属性からオブジェクトを作成します。
    パラメーター:
    dn - 読み込まれるディレクトリエントリ
    attributesToRetrieve - ディレクトリエントリから取得される名前付き属性。
    戻り値:
    マッパーによって作成されたオブジェクト
  - searchForSingleAttributeValues
```
public java.util.Set<java.lang.String> searchForSingleAttributeValues(java.lang.String base,
                                                                      java.lang.String filter,
                                                                      java.lang.Object[] params,
                                                                      java.lang.String attributeName)
```
    提供されたフィルターを使用して検索を実行し、検索に一致したすべてのエントリで見つかった名前付き属性の値の和集合を返します。1 つのディレクトリエントリには、属性の値が複数ある場合があることに注意してください。ロール検索および類似のシナリオを対象としています。
    パラメーター:
    base - 検索する DN
    filter - 使用する検索フィルター
    params - 検索フィルターで置換するパラメーター
    attributeName - 値を取得する属性。
    戻り値:
    一致するすべてのエントリで見つかった値の和集合としての属性の文字列値のセット。
  - searchForMultipleAttributeValues
```
public java.util.Set<java.util.Map<java.lang.String,java.util.List<java.lang.String>>> searchForMultipleAttributeValues(java.lang.String base,
                                                                                                                        java.lang.String filter,
                                                                                                                        java.lang.Object[] params,
                                                                                                                        java.lang.String[] attributeNames)
```
    提供されたフィルターを使用して検索を実行し、検索で一致したすべてのエントリで見つかった各名前付き属性の値を返します。1 つのディレクトリエントリには、属性の値が複数ある場合があることに注意してください。ロール検索および類似のシナリオを対象としています。
    パラメーター:
    base - 検索する DN
    filter - 使用する検索フィルター
    params - 検索フィルターで置換するパラメーター
    attributeNames - 取得する属性の値。
    戻り値:
    一致するすべてのエントリで見つかった各属性の文字列値のセット。属性名は、値の各セットのキーです。さらに、各マップには、キーとして事前定義されたキー DN_KEY を持つ文字列として DN が含まれています。
  - searchForSingleEntry
```
public org.springframework.ldap.core.DirContextOperations searchForSingleEntry(java.lang.String base,
                                                                               java.lang.String filter,
                                                                               java.lang.Object[] params)
```
    単一のディレクトリエントリを返す必要があるという条件で検索を実行し、提供されたマッパーを使用してそのエントリからオブジェクトを作成します。
    Active Directory との互換性のために、スローされた場合は PartialResultException を無視します（LdapTemplate.setIgnorePartialResultException(boolean) を参照）。
    パラメーター:
    base - コンテキストソースによって提供されるベースコンテキストを基準とした検索ベース。
    filter - LDAP 検索フィルター
    params - 検索で置換されるパラメーター。
    戻り値:
    一致するエントリから作成された DirContextOperations インスタンス。
    例外:
    org.springframework.dao.IncorrectResultSizeDataAccessException - 結果が見つからない場合、または検索で複数の結果が返された場合。
  - searchForSingleEntryInternal
```
public static org.springframework.ldap.core.DirContextOperations searchForSingleEntryInternal(javax.naming.directory.DirContext ctx,
                                                                                              javax.naming.directory.SearchControls searchControls,
                                                                                              java.lang.String base,
                                                                                              java.lang.String filter,
                                                                                              java.lang.Object[] params)
                                                                                       throws javax.naming.NamingException
```
    AD 検索でのコードの重複を回避するために抽出された内部メソッド。
    例外:
    javax.naming.NamingException
  - setSearchControls
```
public void setSearchControls(javax.naming.directory.SearchControls searchControls)
```
    テンプレートによる検索操作に使用される検索コントロールを設定します。
    パラメーター:
    searchControls - テンプレートにキャッシュされる SearchControls インスタンス。

クラス SpringSecurityLdapTemplate

ネストされたクラスの概要

クラス org.springframework.ldap.core.LdapTemplate から継承されたネストクラス / インターフェース

フィールド概要

コンストラクター概要

方法の概要

クラス org.springframework.ldap.core.LdapTemplate から継承されたメソッド

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

フィールドの詳細

NO_ATTRS

DN_KEY

コンストラクターの詳細

SpringSecurityLdapTemplate

メソッドの詳細

compare

retrieveEntry

searchForSingleAttributeValues

searchForMultipleAttributeValues

searchForSingleEntry

searchForSingleEntryInternal

setSearchControls