org.seedstack.ldap

Interface LdapService

public interface LdapService

Convenient interface to interact with an LDAP with user issues in mind. This interface makes use of the UserContext object. Use the createUserContext or findUser methods to get a userContext instance.

Method Summary

Modifier and Type	Method and Description
void	authenticate(LdapUserContext userContext, String password) Authenticates a user with its context
LdapUserContext	createUserContext(String dn) Creates a new DefaultLDAPUserContext knowing the dn of the user.
LdapUserContext	findUser(String identityAttributeValue) Creates a new DefaultLDAPUserContext based on the identifying attribute of the user.
String	getAttributeValue(LdapUserContext userContext, String attribute) Gives the value of the attribute name passed as parameter.
Map<String,String>	getAttributeValues(LdapUserContext userContext, String... attributes) Gives the value of the attribute names passed as parameters.
Set<String>	retrieveUserGroups(LdapUserContext userContext) Finds all the groups in which the user is defined as a member.

Method Detail

createUserContext

LdapUserContext createUserContext(String dn)

Creates a new DefaultLDAPUserContext knowing the dn of the user. Note that this method does not make an LDAP call.

Parameters:

dn - the dn of the user

Returns:

the corresponding DefaultLDAPUserContext

findUser

LdapUserContext findUser(String identityAttributeValue)

Creates a new DefaultLDAPUserContext based on the identifying attribute of the user. The identifying attribute is the one defined in the configuration (uid by default).

Parameters:

identityAttributeValue - the value of the identifying attribute to search

Returns:

the DefaultLDAPUserContext corresponding to the attribute value.

authenticate

void authenticate(LdapUserContext userContext,
                  String password)

Authenticates a user with its context

Parameters:

userContext - the context of a user

getAttributeValue

String getAttributeValue(LdapUserContext userContext,
                         String attribute)

Gives the value of the attribute name passed as parameter. Note that this method will call the LDAP only if the attribute value has not yet been retrieved. As a result, multiple calls of this method with the same attribute name will only make one call to the LDAP.

Parameters:

userContext - the DefaultLDAPUserContext used

attribute - the name of the attribute

Returns:

the value of the attribute passed as a parameter, or null if the attribute does not exist.

getAttributeValues

Map<String,String> getAttributeValues(LdapUserContext userContext,
                                      String... attributes)

Gives the value of the attribute names passed as parameters. Note that this method will call the LDAP only if the attribute values have not yet been retrieved. As a result, multiple calls of this method with the same attribute name will only make one call to the LDAP. Also, a unique call will be made to retrieve all the required attributes.

Parameters:

userContext - the DefaultLDAPUserContext used

attributes - the names of the attributes

Returns:

the values of the attributes passed as a parameters as a map. Non existing attributes in the LDAP will give null values.

retrieveUserGroups

Set<String> retrieveUserGroups(LdapUserContext userContext)

Finds all the groups in which the user is defined as a member. Note that this method will effectively call the LDAP each time it is executed.

Parameters:

userContext - the userContext to use

Returns:

the groups as a set of the groups CNs