org.apache.hadoop.hive.metastore.ldap

Interface DirSearch

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

LdapSearch

public interface DirSearch
extends Closeable

The object used for executing queries on the Directory Service.

Method Summary

Modifier and Type	Method and Description
List<String>	executeCustomQuery(String query) Executes an arbitrary query.
List<String>	executeUserAndGroupFilterQuery(String user, String userDn, String filter, String groupBaseDn) Executes an arbitrary query.
String	findGroupDn(String group) Finds group's distinguished name.
List<String>	findGroupsForUser(String userDn) Finds groups that contain the specified user.
String	findUserDn(String user) Finds user's distinguished name.
String	findUserDn(String user, String userSearchFilter, String baseDn) Finds user's distinguished name.
boolean	isUserMemberOfGroup(String user, String groupDn) Verifies that specified user is a member of specified group.

Methods inherited from interface java.io.Closeable

close

Method Detail

findUserDn

String findUserDn(String user)
           throws NamingException

Finds user's distinguished name.

Parameters:

user - username

Returns:

DN for the specified username

Throws:

NamingException

findUserDn

String findUserDn(String user,
                  String userSearchFilter,
                  String baseDn)
           throws NamingException

Finds user's distinguished name.

Parameters:

user - username

userSearchFilter - Generic LDAP Search filter for ex: (&(uid={0})(objectClass=person))

baseDn - LDAP BaseDN for user searches for ex: dc=apache,dc=org

Returns:

DN for the specific user if exists, null otherwise

Throws:

NamingException

findGroupDn

String findGroupDn(String group)
            throws NamingException

Finds group's distinguished name.

Parameters:

group - group name or unique identifier

Returns:

DN for the specified group name

Throws:

NamingException

isUserMemberOfGroup

boolean isUserMemberOfGroup(String user,
                            String groupDn)
                     throws NamingException

Verifies that specified user is a member of specified group.

Parameters:

user - user id or distinguished name

groupDn - group's DN

Returns:

true if the user is a member of the group, false - otherwise.

Throws:

NamingException

findGroupsForUser

List<String> findGroupsForUser(String userDn)
                        throws NamingException

Finds groups that contain the specified user.

Parameters:

userDn - user's distinguished name

Returns:

list of groups

Throws:

NamingException

executeCustomQuery

List<String> executeCustomQuery(String query)
                         throws NamingException

Executes an arbitrary query.

Parameters:

query - any query

Returns:

list of names in the namespace

Throws:

NamingException

executeUserAndGroupFilterQuery

List<String> executeUserAndGroupFilterQuery(String user,
                                            String userDn,
                                            String filter,
                                            String groupBaseDn)
                                     throws NamingException

Executes an arbitrary query.

Parameters:

user - user RDN or username. This will be substituted for {0} in group search

userDn - userDn DN for the username. This will be substituted for {1} in group search

filter - filter is the group filter query ex: (&(memberUid={0})(&(CN=group1)(objectClass=posixGroup)))

groupBaseDn - BaseDN for group searches. ex: "ou=groups,dc=apache,dc=org"

Returns:

list of names that match the group filter aka groups that the user belongs to, if any.

Throws:

NamingException