org.apache.hadoop.hive.metastore.ldap

Class LdapSearch

java.lang.Object

org.apache.hadoop.hive.metastore.ldap.LdapSearch

All Implemented Interfaces:

Closeable, AutoCloseable, DirSearch

public final class LdapSearch
extends Object
implements DirSearch

Implements search for LDAP.

Constructor Summary

Constructors

Constructor and Description
LdapSearch(org.apache.hadoop.conf.Configuration conf, DirContext ctx) Construct an instance of LdapSearch.

Method Summary

Modifier and Type	Method and Description
void	close() Closes this search object and releases any system resources associated with it.
List<String>	executeCustomQuery(String query) Executes an arbitrary query.
List<String>	executeUserAndGroupFilterQuery(String user, String userDn, String groupSearchFilter, 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 class java.lang.Object

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

Constructor Detail

LdapSearch

public LdapSearch(org.apache.hadoop.conf.Configuration conf,
                  DirContext ctx)
           throws NamingException

Construct an instance of LdapSearch.

Parameters:

conf - Hive configuration

ctx - Directory service that will be used for the queries.

Throws:

NamingException

Method Detail

close

public void close()

Closes this search object and releases any system resources associated with it. If the search object is already closed then invoking this method has no effect.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

findUserDn

public String findUserDn(String user)
                  throws NamingException

Finds user's distinguished name.

Specified by:

findUserDn in interface DirSearch

Parameters:

user - username

Returns:

DN for the specified username

Throws:

NamingException

findUserDn

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

Finds user's distinguished name.

Specified by:

findUserDn in interface DirSearch

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

public String findGroupDn(String group)
                   throws NamingException

Finds group's distinguished name.

Specified by:

findGroupDn in interface DirSearch

Parameters:

group - group name or unique identifier

Returns:

DN for the specified group name

Throws:

NamingException

isUserMemberOfGroup

public boolean isUserMemberOfGroup(String user,
                                   String groupDn)
                            throws NamingException

Verifies that specified user is a member of specified group.

Specified by:

isUserMemberOfGroup in interface DirSearch

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

public List<String> findGroupsForUser(String userDn)
                               throws NamingException

Finds groups that contain the specified user.

Specified by:

findGroupsForUser in interface DirSearch

Parameters:

userDn - user's distinguished name

Returns:

list of groups

Throws:

NamingException

executeCustomQuery

public List<String> executeCustomQuery(String query)
                                throws NamingException

Executes an arbitrary query.

Specified by:

executeCustomQuery in interface DirSearch

Parameters:

query - any query

Returns:

list of names in the namespace

Throws:

NamingException

executeUserAndGroupFilterQuery

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

Executes an arbitrary query.

Specified by:

executeUserAndGroupFilterQuery in interface DirSearch

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

groupSearchFilter - 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