Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.base.ldap
Class LdapSearchManager

java.lang.Object
  extended by com.jivesoftware.base.ldap.LdapSearchManager

public class LdapSearchManager
extends java.lang.Object

Handles LDAP searches for users that are both members of groups and users in LDAP.


Method Summary
 boolean containsUser(java.lang.String user, java.lang.String searchFilter)
          Returns true if the specified user is found in an LDAP search.
 boolean containsUser(java.lang.String user, java.lang.String baseDn, java.lang.String searchFilter)
          Returns true if the specified user is found in an LDAP search.
static LdapSearchManager getInstance()
           
 long[] searchForUserIds(java.lang.String searchFilter)
          An auxilary method used to perform LDAP queries based on a provided LDAP search filter.
 long[] searchForUserIds(java.lang.String baseDn, java.lang.String searchFilter)
          An auxilary method used to perform LDAP queries based on a provided LDAP search filter.
 java.util.List searchForUsers(java.lang.String searchFilter)
          Returns a list of the usernames related to an LDAP search.
 java.util.List searchForUsers(java.lang.String baseDn, java.lang.String searchFilter)
          Returns a list of the usernames related to an LDAP search.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getInstance

public static LdapSearchManager getInstance()

containsUser

public boolean containsUser(java.lang.String user,
                            java.lang.String searchFilter)
Returns true if the specified user is found in an LDAP search.

Parameters:
user - The user that is being checked.
searchFilter - The search filter that is used to check fo the user.
Returns:
Returns true if the user was found in the search and false if they were not.

containsUser

public boolean containsUser(java.lang.String user,
                            java.lang.String baseDn,
                            java.lang.String searchFilter)
Returns true if the specified user is found in an LDAP search. A baseDN from which to search can also be specified.

Parameters:
user - The user that is being checked.
searchFilter - The search filter that is used to check fo the user.
Returns:
Returns true if the user was found in the search and false if they were not.

searchForUsers

public java.util.List searchForUsers(java.lang.String searchFilter)
                              throws javax.naming.NamingException
Returns a list of the usernames related to an LDAP search.

Parameters:
searchFilter - The LDAP search filter that defines the users.
Returns:
The list of user IDs.
Throws:
javax.naming.NamingException - If an error occurs during the ldap search an exception will be thrown.

searchForUsers

public java.util.List searchForUsers(java.lang.String baseDn,
                                     java.lang.String searchFilter)
                              throws javax.naming.NamingException
Returns a list of the usernames related to an LDAP search. A baseDN can also be specified, to narrow down the search.

Parameters:
baseDn - The specicfied baseDn will overide the configured Jive Property
searchFilter - The search filter that specifies the members of the group.
Returns:
Returns a list of the usernames related to an LDAP search. A baseDN can also be specified, to narrow down the search.
Throws:
javax.naming.NamingException

searchForUserIds

public long[] searchForUserIds(java.lang.String searchFilter)
                        throws javax.naming.NamingException
An auxilary method used to perform LDAP queries based on a provided LDAP search filter.

Parameters:
searchFilter - LDAP search filter used to query.
Returns:
an enumeration of SearchResult.
Throws:
javax.naming.NamingException

searchForUserIds

public long[] searchForUserIds(java.lang.String baseDn,
                               java.lang.String searchFilter)
                        throws javax.naming.NamingException
An auxilary method used to perform LDAP queries based on a provided LDAP search filter.

Parameters:
searchFilter - LDAP search filter used to query.
Returns:
an enumeration of SearchResult.
Throws:
javax.naming.NamingException

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.