View Javadoc

1   /*
2    * Copyright 2002-2005 the original author or authors.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package net.sf.ldaptemplate;
18  
19  import javax.naming.Name;
20  import javax.naming.directory.SearchResult;
21  
22  /***
23   * Responsible for handling a single SearchResult returned by an LDAP seach.
24   * 
25   * @see net.sf.ldaptemplate.LdapTemplate#search(Name, String,
26   *      SearchResultCallbackHandler)
27   * 
28   * @author Mattias Arthursson
29   */
30  public interface SearchResultCallbackHandler {
31  
32      /***
33       * Handle this entry. This method will be called once for each entry
34       * returned by a search or list.
35       * 
36       * @param searchResult
37       *            the searchResult.
38       */
39      public void handleSearchResult(SearchResult searchResult);
40  }