1 /* Copyright 2004, 2005, 2006 Acegi Technology Pty Limited
2 *
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
6 *
7 * http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * 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.GrantedAuthority;
19
20 import org.acegisecurity.ldap.LdapDataAccessException;
21
22 import org.acegisecurity.userdetails.ldap.LdapUserDetails;
23
24
25 /**
26 * Obtains a list of granted authorities for an Ldap user.
27 * <p>
28 * Used by the <tt>LdapAuthenticationProvider</tt> once a user has been
29 * authenticated to create the final user details object.
30 * </p>
31 *
32 * @author Luke Taylor
33 * @version $Id: LdapAuthoritiesPopulator.java 1496 2006-05-23 13:38:33Z benalex $
34 */
35 public interface LdapAuthoritiesPopulator {
36 //~ Methods ========================================================================================================
37
38 /**
39 * Get the list of authorities for the user.
40 *
41 * @param userDetails the user details object which was returned by the LDAP authenticator.
42 *
43 * @return the granted authorities for the given user.
44 *
45 * @throws LdapDataAccessException if there is a problem accessing the directory.
46 */
47 GrantedAuthority[] getGrantedAuthorities(LdapUserDetails userDetails)
48 throws LdapDataAccessException;
49 }