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.providers.ldap;
17:
18: import org.acegisecurity.userdetails.ldap.LdapUserDetails;
19:
20: /**
21: * The strategy interface for locating and authenticating an Ldap user.
22: * <p>
23: * The LdapAuthenticationProvider calls this interface to authenticate a user
24: * and obtain the information for that user from the directory.
25: * </p>
26: *
27: *
28: * @author Luke Taylor
29: * @version $Id: LdapAuthenticator.java 1496 2006-05-23 13:38:33Z benalex $
30: */
31: public interface LdapAuthenticator {
32: //~ Methods ========================================================================================================
33:
34: /**
35: * Authenticates as a user and obtains additional user information from the directory.
36: *
37: * @param username the user's login name (<em>not</em> their DN).
38: * @param password the user's password supplied at login.
39: *
40: * @return the details of the successfully authenticated user.
41: */
42: LdapUserDetails authenticate(String username, String password);
43: }
|