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.GrantedAuthority;
19:
20: import org.acegisecurity.ldap.LdapDataAccessException;
21:
22: import org.acegisecurity.userdetails.ldap.LdapUserDetails;
23:
24: /**
25: * Obtains a list of granted authorities for an Ldap user.
26: * <p>
27: * Used by the <tt>LdapAuthenticationProvider</tt> once a user has been
28: * authenticated to create the final user details object.
29: * </p>
30: *
31: * @author Luke Taylor
32: * @version $Id: LdapAuthoritiesPopulator.java 1496 2006-05-23 13:38:33Z benalex $
33: */
34: public interface LdapAuthoritiesPopulator {
35: //~ Methods ========================================================================================================
36:
37: /**
38: * Get the list of authorities for the user.
39: *
40: * @param userDetails the user details object which was returned by the LDAP authenticator.
41: *
42: * @return the granted authorities for the given user.
43: *
44: * @throws LdapDataAccessException if there is a problem accessing the directory.
45: */
46: GrantedAuthority[] getGrantedAuthorities(LdapUserDetails userDetails)
47: throws LdapDataAccessException;
48: }
|