01: /* Copyright 2004, 2005, 2006 Acegi Technology Pty Limited
02: *
03: * Licensed under the Apache License, Version 2.0 (the "License");
04: * you may not use this file except in compliance with the License.
05: * You may obtain a copy of the License at
06: *
07: * http://www.apache.org/licenses/LICENSE-2.0
08: *
09: * Unless required by applicable law or agreed to in writing, software
10: * distributed under the License is distributed on an "AS IS" BASIS,
11: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12: * See the License for the specific language governing permissions and
13: * limitations under the License.
14: */
15:
16: package org.acegisecurity.ldap;
17:
18: import org.acegisecurity.userdetails.ldap.LdapUserDetails;
19:
20: /**
21: * Obtains a user's information from the LDAP directory given a login name.
22: * <p>
23: * May be optionally used to configure the LDAP authentication implementation when
24: * a more sophisticated approach is required than just using a simple username->DN
25: * mapping.
26: * </p>
27: *
28: * @author Luke Taylor
29: * @version $Id: LdapUserSearch.java 1496 2006-05-23 13:38:33Z benalex $
30: */
31: public interface LdapUserSearch {
32: //~ Methods ========================================================================================================
33:
34: /**
35: * Locates a single user in the directory and returns the LDAP information for that user.
36: *
37: * @param username the login name supplied to the authentication service.
38: *
39: * @return an LdapUserDetailsImpl object containing the user's full DN and requested attributes.
40: */
41: LdapUserDetails searchForUser(String username);
42: }
|