Processing the DirContext

本部分介绍如何处理 DirContext，包括预处理和后处理。

Custom DirContext Pre- and Post-processing

在某些情况下，您可能希望在搜索操作之前和之后对 DirContext 执行操作。用于此操作的接口称为 DirContextProcessor。以下列表显示了 DirContextProcessor 接口：

public interface DirContextProcessor {
   public void preProcess(DirContext ctx) throws NamingException;
   public void postProcess(DirContext ctx) throws NamingException;
}

LdapTemplate 类具有一个搜索方法，该方法采用 DirContextProcessor，如下所示：

public void search(SearchExecutor se, NameClassPairCallbackHandler handler,
   DirContextProcessor processor) throws DataAccessException;

在搜索操作之前，将对给定的 DirContextProcessor 实例调用 preProcess 方法。在搜索运行且生成的结果 NamingEnumeration 被处理后，将调用 postProcess 方法。这允许您对将用于搜索的 DirContext 执行操作，并在搜索执行后检查 DirContext。这可能非常有用（例如，在处理请求和响应控件时）。

当您不需要自定义 SearchExecutor 时，还可以使用以下便捷方法：

public void search(Name base, String filter,
   SearchControls controls, NameClassPairCallbackHandler handler, DirContextProcessor processor)

public void search(String base, String filter,
   SearchControls controls, NameClassPairCallbackHandler handler, DirContextProcessor processor)

public void search(Name base, String filter,
   SearchControls controls, AttributesMapper mapper, DirContextProcessor processor)

public void search(String base, String filter,
   SearchControls controls, AttributesMapper mapper, DirContextProcessor processor)

public void search(Name base, String filter,
   SearchControls controls, ContextMapper mapper, DirContextProcessor processor)

public void search(String base, String filter,
   SearchControls controls, ContextMapper mapper, DirContextProcessor processor)

Implementing a Request Control DirContextProcessor

LDAPv3 协议使用“Controls`" 发送和接收额外的用于影响预定义操作的行为的数据。为了简化请求控制 `DirContextProcessor 的实现，Spring LDAP 提供了 AbstractRequestControlDirContextProcessor 基本类。此类处理从 LdapContext 检索当前的请求控制，调用模板方法创建请求控制并将其添加到 LdapContext。您需要在子类中做的是实现用于执行搜索后所需操作的模板方法 createRequestControl 和 postProcess 方法。以下列表显示了相关签名：

public abstract class AbstractRequestControlDirContextProcessor implements
      DirContextProcessor {

   public void preProcess(DirContext ctx) throws NamingException {
      ...
   }

   public abstract Control createRequestControl();
}

典型的 DirContextProcessor 类似于以下示例：

Example 1. A request control DirContextProcessor implementation
public class MyCoolRequestControl extends AbstractRequestControlDirContextProcessor {
   private static final boolean CRITICAL_CONTROL = true;
   private MyCoolCookie cookie;
   ...
   public MyCoolCookie getCookie() {
      return cookie;
   }

   public Control createRequestControl() {
      return new SomeCoolControl(cookie.getCookie(), CRITICAL_CONTROL);
   }

   public void postProcess(DirContext ctx) throws NamingException {
      LdapContext ldapContext = (LdapContext) ctx;
      Control[] responseControls = ldapContext.getResponseControls();

      for (int i = 0; i < responseControls.length; i++) {
         if (responseControls[i] instanceof SomeCoolResponseControl) {
            SomeCoolResponseControl control = (SomeCoolResponseControl) responseControls[i];
            this.cookie = new MyCoolCookie(control.getCookie());
         }
      }
   }
}

使用控件时确保使用 LdapContextSource。 Control 接口适用于 LDAPv3，并且要求使用 LdapContext 而不是 DirContext。如果用非 LdapContext 的参数调用 AbstractRequestControlDirContextProcessor 子类，它会抛出一个 IllegalArgumentException。

Paged Search Results

某些搜索可能返回大量的结果。如果没有简单的方法过滤出少量结果，则服务器每次调用只返回一定数量的结果将非常方便。这被称为“分步搜索结果”。然后可以显示结果的每个“页面”，并链接到下一页和上一页。如果没有此功能，客户端必须手动将搜索结果限制为页面或检索整个结果，然后将其分解为合适大小的页面。前者相当复杂，而后者将消耗不必要的内存量。

某些 LDAP 服务器支持 PagedResultsControl，它请求 LDAP 服务器返回指定大小的页面中的搜索操作结果。用户通过控制调用的频率来控制返回页面的速率。但是，您必须跟踪调用之间的 cookie。服务器使用此 cookie 跟踪上一次使用分步结果请求调用时停止的位置。

Spring LDAP 使用前面部分讨论的概念对分步上下文进行预处理和后处理，从而提供对分步结果的支持。它通过使用 PagedResultsDirContextProcessor 类来实现。PagedResultsDirContextProcessor 类使用所请求的页面大小创建一个 PagedResultsControl 并将其添加到 LdapContext。在搜索之后，它获取 PagedResultsResponseControl 并检索分步结果 cookie，这对于在连续的分步结果请求之间保持上下文是必需的。

以下示例显示如何使用分步搜索结果功能：

Example 2. Paged results using PagedResultsDirContextProcessor
public List<String> getAllPersonNames() {
  final SearchControls searchControls = new SearchControls();
  searchControls.setSearchScope(SearchControls.SUBTREE_SCOPE);

  final PagedResultsDirContextProcessor processor =
        new PagedResultsDirContextProcessor(PAGE_SIZE);

  return SingleContextSource.doWithSingleContext(
        contextSource, new LdapOperationsCallback<List<String>>() {

      @Override
      public List<String> doWithLdapOperations(LdapOperations operations) {
        List<String> result = new LinkedList<String>();

        do {
          List<String> oneResult = operations.search(
            "ou=People",
            "(&(objectclass=person))",
            searchControls,
            CN_ATTRIBUTES_MAPPER,
            processor);
          result.addAll(oneResult);
        } while(processor.hasMore());

        return result;
      }
  });
}

为了让分页结果 cookie 继续有效，您必须为每次分页结果调用使用相同的底层连接。您可以通过使用 SingleContextSource 来做到这一点，如前面的示例中所示。