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
21 /***
22 * Responsible for mapping from LDAP Contexts to beans.
23 *
24 * @see net.sf.ldaptemplate.LdapTemplate#search(Name, String, ContextMapper)
25 *
26 * @author Mattias Arthursson
27 */
28 public interface ContextMapper {
29 /***
30 * Map a single LDAP Context to an object. The supplied Object
31 * <code>ctx</code> is the object from a single <code>SearchResult</code>
32 * or a lookup operation.
33 *
34 * @param ctx
35 * the context to map to an object.
36 * @return an object built from the data in the context.
37 */
38 public Object mapFromContext(Object ctx);
39 }