uk.ac.bath.bucs.idm.ldap

Class LdapUtils

java.lang.Object

uk.ac.bath.bucs.idm.ldap.LdapUtils

public final class LdapUtils
extends Object

Class containing static methods to assist with use of the Bath LDAP.

Author:

Tim Barrett

Method Summary

Modifier and Type	Method and Description
static boolean	addGroupMember(LdapService ldapSvc, String uid, String groupCn) A light-weight method to add a member to a groupOfNames without reading the whole thing in first.
static boolean	addGroupOwner(LdapService ldapSvc, String uid, String groupCn) A light-weight method to add an owner to a groupOfNames without reading the whole thing in first.
static boolean	addPosixGroupMember(LdapService ldapSvc, String uid, String groupCn) A light-weight method to add a member to a posixGroup without reading the whole thing in first.
static List<String>	dnsToUids(List<String> dns) Converts a list of Distinguished Names to a list of uids.
static String	dnToUid(String dn) Converts a Distinguished Name for a person to the uid for that person.
static boolean	isGroupMember(LdapService ldapSvc, String groupCn, String userUid) Tests to see if a particular user is a member of a particular LDAP groupOfNames.
static boolean	isGroupOwner(LdapService ldapSvc, String groupCn, String userUid) Tests to see if a particular user is an owner of a particular LDAP groupOfNames.
static String	personIdToUid(LdapService ldapSvc, int personId) Converts a PersonId to a uid by querying the LDAP.
static List<String>	processExternalPhones(String rawField) Turns the String stored in any of the phone number-related properties of beans into a List of numbers suitable for external display.
static List<String>	processInternalPhones(String rawField) Turns the String stored in any of the phone number-related properties of beans into a List of numbers suitable for internal display.
static boolean	removeGroupMember(LdapService ldapSvc, String uid, String groupCn) A light-weight method to remove a member from a groupOfNames without reading the whole thing in first.
static boolean	removeGroupOwner(LdapService ldapSvc, String uid, String groupCn) A light-weight method to remove an owner from a groupOfNames without reading the whole thing in first.
static boolean	removePosixGroupMember(LdapService ldapSvc, String uid, String groupCn) A light-weight method to remove a member from a posixGroup without reading the whole thing in first.
static List<GroupRecord>	searchGroupRecords(LdapService ldapSvc, String filter) Searches for groups (groupOfNames or posixGroup) using the supplied filter, and returns a fully-fledged GroupRecord object for each one found.
static List<GroupRecord>	searchGroupRecords(LdapService ldapSvc, String filter, int searchScope) Searches for groups (groupOfNames or posixGroup) using the supplied filter and search scope, and returns a fully-fledged GroupRecord object for each one found.
static List<PersonRecord>	searchPersonRecords(LdapService ldapSvc, String filter) Searches for people using the supplied filter, and returns a fully-fledged PersonRecord object for each one found.
static Map<RoleRecord,PersonRecord>	searchRoleRecords(LdapService ldapSvc, String filter) Searches for roles using the supplied filter and returns a RoleRecord object, along with the fully-fledged PersonRecord object containing it, for each one found.
static List<UnitRecord>	searchUnitRecords(LdapService ldapSvc, String filter) Searches for units using the supplied filter, and returns a fully-fledged UnitRecord object for each one found.
static List<String>	uidsToDns(List<String> uids) Converts a list of uids to a list of Distinguished Names.
static String	uidToDn(String uid) Converts a uid to a Distinguished Name for the object representing that uid.
static int	uidToPersonId(LdapService ldapSvc, String uid) Converts a uid to a PersonId by querying the LDAP.
static boolean	usernameExists(LdapService ldapSvc, String uid) Queries the LDAP to check if a username exists.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

uidToDn

public static String uidToDn(String uid)

Converts a uid to a Distinguished Name for the object representing that uid.

Parameters:

uid - The uid to convert

Returns:

the DN for the relevant object

uidsToDns

public static List<String> uidsToDns(List<String> uids)

Converts a list of uids to a list of Distinguished Names.

Parameters:

uids - The list of uids to convert

Returns:

a list of DNs

dnToUid

public static String dnToUid(String dn)
                      throws NamingException

Converts a Distinguished Name for a person to the uid for that person.

Parameters:

dn - The DN to convert

Returns:

the uid for the relevant object

Throws:

NamingException - if the format of the DN isn't correct

dnsToUids

public static List<String> dnsToUids(List<String> dns)
                              throws NamingException

Converts a list of Distinguished Names to a list of uids.

Parameters:

dns - The list of DNs to convert

Returns:

a list of uids

Throws:

NamingException - if the format of a DN is incorrect

usernameExists

public static boolean usernameExists(LdapService ldapSvc,
                                     String uid)
                              throws NamingException

Queries the LDAP to check if a username exists.

Parameters:

ldapSvc - an LdapService configured to connect to the relevant server

uid - the username to check

Returns:

true if the username exists on the server

Throws:

NamingException - in case of LDAP error

personIdToUid

public static String personIdToUid(LdapService ldapSvc,
                                   int personId)
                            throws NamingException,
                                   NotFoundException

Converts a PersonId to a uid by querying the LDAP.

Parameters:

ldapSvc - an LdapService configured to connect to the relevant server

personId - the PersonId to convert to a uid

Returns:

the uid

Throws:

NamingException - in case of LDAP error

NotFoundException - if the uid cannot be located

uidToPersonId

public static int uidToPersonId(LdapService ldapSvc,
                                String uid)
                         throws NamingException,
                                NotFoundException,
                                LdapDataException

Converts a uid to a PersonId by querying the LDAP.

Parameters:

ldapSvc - an LdapService configured to connect to the relevant server

uid - the uid to convert to a PersonId

Returns:

the PersonId

Throws:

NamingException - in case of LDAP error

NotFoundException - if the PersonId cannot be located

LdapDataException - if issues are found with the data in the LDAP

processInternalPhones

public static List<String> processInternalPhones(String rawField)

Turns the String stored in any of the phone number-related properties of beans into a List of numbers suitable for internal display.

Parameters:

rawField - the String as stored in a bean

Returns:

a list of internal display numbers, which may be empty

processExternalPhones

public static List<String> processExternalPhones(String rawField)

Turns the String stored in any of the phone number-related properties of beans into a List of numbers suitable for external display.

Parameters:

rawField - the String as stored in a bean

Returns:

a list of external display numbers, which may be empty

searchPersonRecords

public static List<PersonRecord> searchPersonRecords(LdapService ldapSvc,
                                                     String filter)
                                              throws NamingException,
                                                     LdapDataException,
                                                     SizeLimitExceededException

Searches for people using the supplied filter, and returns a fully-fledged PersonRecord object for each one found. A one-level search of ou=people will be performed with the supplied filter. The list is sorted before return.

If the LdapService is unauthenticated then LdapService.searchSmall() will be used, which will throw a SizeLimitExceededException if the result limit is exceeded.

Parameters:

ldapSvc - an LdapService configured to connect to the relevant server

filter - the filter to use

Returns:

a list of PersonRecords, which will be empty if nothing was found

Throws:

NamingException - in case of LDAP error

LdapDataException - in case of issues with the data read from the LDAP

SizeLimitExceededException - if the result limit is exceeded

searchRoleRecords

public static Map<RoleRecord,PersonRecord> searchRoleRecords(LdapService ldapSvc,
                                                             String filter)
                                                      throws NamingException,
                                                             LdapDataException,
                                                             SizeLimitExceededException

Searches for roles using the supplied filter and returns a RoleRecord object, along with the fully-fledged PersonRecord object containing it, for each one found. A subtree search of ou=people will be performed with the supplied filter combined with a restriction to objectClass BathBaseRole. There will be no duplication of PersonRecord objects in the returned map; that is, where two roles belonging to the same person are returned, both roles will map to the same PersonRecord object.

If the LdapService is unauthenticated then LdapService.searchSmall() will be used, which will throw a SizeLimitExceededException if the result limit is exceeded.

Parameters:

ldapSvc - an LdapService configured to connect to the relevant server

filter - the filter to use

Returns:

a map of RoleRecords to PersonRecords, which will be empty if nothing was found

Throws:

NamingException - in case of LDAP error

LdapDataException - in case of issues with the data read from the LDAP

SizeLimitExceededException - if the result limit is exceeded

searchUnitRecords

public static List<UnitRecord> searchUnitRecords(LdapService ldapSvc,
                                                 String filter)
                                          throws NamingException,
                                                 LdapDataException,
                                                 SizeLimitExceededException

Searches for units using the supplied filter, and returns a fully-fledged UnitRecord object for each one found. A one-level search of ou=units will be performed with the supplied filter. The list is sorted before return.

Parameters:

ldapSvc - an LdapService configured to connect to the relevant server

filter - the filter to use

Returns:

a list of UnitRecords, which will be empty if nothing was found

Throws:

NamingException - in case of LDAP error

LdapDataException - in case of issues with the data read from the LDAP

SizeLimitExceededException - if the result limit is exceeded

searchGroupRecords

public static List<GroupRecord> searchGroupRecords(LdapService ldapSvc,
                                                   String filter,
                                                   int searchScope)
                                            throws NamingException,
                                                   LdapDataException,
                                                   SizeLimitExceededException

Searches for groups (groupOfNames or posixGroup) using the supplied filter and search scope, and returns a fully-fledged GroupRecord object for each one found. The search only looks within ou=groups and ou=unixgroups,ou=config. The list is sorted before return.

Parameters:

ldapSvc - an LdapService configured with sufficient access

filter - the filter to use

searchScope - the scope within which to search, as defined by SearchControls

Returns:

a list of GroupRecords, which will be empty if nothing was found

Throws:

NamingException - in case of LDAP error

LdapDataException - in case of issues with the data read from the LDAP

SizeLimitExceededException - if the result limit is exceeded

searchGroupRecords

public static List<GroupRecord> searchGroupRecords(LdapService ldapSvc,
                                                   String filter)
                                            throws NamingException,
                                                   LdapDataException,
                                                   SizeLimitExceededException

Searches for groups (groupOfNames or posixGroup) using the supplied filter, and returns a fully-fledged GroupRecord object for each one found. The search only looks within ou=groups and ou=unixgroups,ou=config. The list is sorted before return.

Parameters:

ldapSvc - an LdapService configured with sufficient access

filter - the filter to use

Returns:

a list of GroupRecords, which will be empty if nothing was found

Throws:

NamingException - in case of LDAP error

LdapDataException - in case of issues with the data read from the LDAP

SizeLimitExceededException - if the result limit is exceeded

isGroupMember

public static boolean isGroupMember(LdapService ldapSvc,
                                    String groupCn,
                                    String userUid)
                             throws NamingException,
                                    LdapDataException,
                                    SizeLimitExceededException

Tests to see if a particular user is a member of a particular LDAP groupOfNames.

Parameters:

ldapSvc - an LdapService configured to connect to the relevant server

groupCn - The cn of the group to check

userUid - The username of the user to check

Returns:

true if the user is a member of the group

Throws:

NamingException - in case of LDAP error

LdapDataException - in case of issues with the data read from the LDAP

SizeLimitExceededException - if the result limit is exceeded

isGroupOwner

public static boolean isGroupOwner(LdapService ldapSvc,
                                   String groupCn,
                                   String userUid)
                            throws NamingException,
                                   LdapDataException,
                                   SizeLimitExceededException

Tests to see if a particular user is an owner of a particular LDAP groupOfNames.

Parameters:

ldapSvc - an LdapService configured to connect to the relevant server

groupCn - The cn of the group to check

userUid - The username of the user to check

Returns:

true if the user is a owner of the group

Throws:

NamingException - in case of LDAP error

LdapDataException - in case of issues with the data read from the LDAP

SizeLimitExceededException - if the result limit is exceeded

addGroupMember

public static boolean addGroupMember(LdapService ldapSvc,
                                     String uid,
                                     String groupCn)
                              throws NamingException

A light-weight method to add a member to a groupOfNames without reading the whole thing in first.

Parameters:

ldapSvc - an LdapService configured to connect to the relevant server

uid - the username of the member to add

groupCn - the cn of the group to add a member to

Returns:

true if the member was added, false if it was already there

Throws:

NamingException - in case of LDAP error

removeGroupMember

public static boolean removeGroupMember(LdapService ldapSvc,
                                        String uid,
                                        String groupCn)
                                 throws NamingException

A light-weight method to remove a member from a groupOfNames without reading the whole thing in first.

Parameters:

ldapSvc - an LdapService configured to connect to the relevant server

uid - the username of the member to remove

groupCn - the cn of the group to remove a member from

Returns:

true if the member was removed, false if it wasn't there to remove

Throws:

NamingException - in case of LDAP error

addGroupOwner

public static boolean addGroupOwner(LdapService ldapSvc,
                                    String uid,
                                    String groupCn)
                             throws NamingException

A light-weight method to add an owner to a groupOfNames without reading the whole thing in first.

Parameters:

ldapSvc - an LdapService configured to connect to the relevant server

uid - the username of the owner to add

groupCn - the cn of the group to add an owner to

Returns:

true if the owner was added, false if it was already there

Throws:

NamingException - in case of LDAP error

removeGroupOwner

public static boolean removeGroupOwner(LdapService ldapSvc,
                                       String uid,
                                       String groupCn)
                                throws NamingException

A light-weight method to remove an owner from a groupOfNames without reading the whole thing in first.

Parameters:

ldapSvc - an LdapService configured to connect to the relevant server

uid - the username of the owner to remove

groupCn - the cn of the group to remove an owner from

Returns:

true if the owner was removed, false if it wasn't there to remove

Throws:

NamingException - in case of LDAP error

addPosixGroupMember

public static boolean addPosixGroupMember(LdapService ldapSvc,
                                          String uid,
                                          String groupCn)
                                   throws NamingException

A light-weight method to add a member to a posixGroup without reading the whole thing in first.

Parameters:

ldapSvc - an LdapService configured to connect to the relevant server

uid - the username of the member to add

groupCn - the cn of the group to add a member to

Returns:

true if the member was added, false if it was already there

Throws:

NamingException - in case of LDAP error

removePosixGroupMember

public static boolean removePosixGroupMember(LdapService ldapSvc,
                                             String uid,
                                             String groupCn)
                                      throws NamingException

A light-weight method to remove a member from a posixGroup without reading the whole thing in first.

Parameters:

ldapSvc - an LdapService configured to connect to the relevant server

uid - the username of the member to remove

groupCn - the cn of the group to remove a member from

Returns:

true if the member was removed, false if it wasn't there to remove

Throws:

NamingException - in case of LDAP error