此版本仍在开发中,尚未被视为稳定版本。对于最新的稳定版本,请使用 Spring LDAP 3.2.8! |
处理DirContext
本节介绍如何处理DirContext
,包括预处理和后处理。
习惯DirContext
前处理和后处理
在某些情况下,您可能希望对DirContext
搜索作之前和之后。用于此目的的接口称为DirContextProcessor
.下面的清单显示了DirContextProcessor
接口:
public interface DirContextProcessor {
public void preProcess(DirContext ctx) throws NamingException;
public void postProcess(DirContext ctx) throws NamingException;
}
这LdapTemplate
class 有一个 search 方法,该方法采用DirContextProcessor
如下:
public void search(SearchExecutor se, NameClassPairCallbackHandler handler,
DirContextProcessor processor) throws DataAccessException;
在搜索作之前,preProcess
method 在给定的DirContextProcessor
实例。在搜索运行并生成的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)
实现请求控制DirContextProcessor
LDAPv3 协议使用“控件”来发送和接收其他数据,以影响预定义作的行为。简化请求控件的实现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
类似于以下示例:
DirContextProcessor
实现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 当您使用 Controls 时。这Control interface 特定于 LDAPv3,并要求LdapContext 替换为DirContext .如果AbstractRequestControlDirContextProcessor subclass 使用不是LdapContext ,它会抛出一个IllegalArgumentException . |
分页搜索结果
某些搜索可能会返回大量结果。当没有简单的方法可以过滤掉较小的数量时,让服务器每次调用时只返回一定数量的结果会很方便。这称为 “分页搜索结果”。然后可以显示结果的每个“页面”,并带有指向下一页和上一页的链接。如果没有此功能,客户端必须手动将搜索结果限制到页面中,或者检索整个结果,然后将其切成大小合适的页面。前者相当复杂,而后者会消耗不必要的内存量。
某些 LDAP 服务器支持PagedResultsControl
,它请求 LDAP 服务器以指定大小的页面返回搜索作的结果。用户通过控制调用搜索的速率来控制返回页面的速率。但是,您必须跟踪调用之间的 Cookie。服务器使用此 Cookie 来跟踪上次使用分页结果请求调用它时停止的位置。
Spring LDAP 通过使用 pre-processing 和 post-processing 的概念来提供对分页结果的支持LdapContext
,如前面几节所述。它通过使用PagedResultsDirContextProcessor
类。这PagedResultsDirContextProcessor
class 会创建一个PagedResultsControl
替换为请求的页面大小,并将其添加到LdapContext
.搜索后,它会得到PagedResultsResponseControl
并检索分页结果 Cookie,这是在连续分页结果请求之间保持上下文所必需的。
以下示例显示了如何使用分页搜索结果功能:
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 ,如前面的示例所示。 |