org.apache.hive.service.auth.ldap

Class QueryFactory

java.lang.Object

org.apache.hive.service.auth.ldap.QueryFactory

public final class QueryFactory
extends Object

A factory for common types of directory service search queries.

Constructor Summary

Constructors

Constructor and Description
QueryFactory(HiveConf conf) Constructs the factory based on provided Hive configuration.

Method Summary

Modifier and Type	Method and Description
Query	customQuery(String searchFilter) Returns a query object created for the custom filter.
Query	findDnByPattern(String rdn) Returns a query for finding user DN based on DN pattern.
Query	findGroupDnById(String groupId) Returns a query for finding Group DN based on group unique ID.
Query	findGroupsForUser(String userName, String userDn) Returns a query for finding groups to which the user belongs.
Query	findUserDnByName(String userName) Returns a query for finding user DN based on user unique name.
Query	findUserDnByRdn(String userRdn) Returns a query for finding user DN based on user RDN.

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryFactory

public QueryFactory(HiveConf conf)

Constructs the factory based on provided Hive configuration.

Parameters:

conf - Hive configuration

Method Detail

findGroupDnById

public Query findGroupDnById(String groupId)

Returns a query for finding Group DN based on group unique ID.

Parameters:

groupId - group unique identifier

Returns:

an instance of Query

findUserDnByRdn

public Query findUserDnByRdn(String userRdn)

Returns a query for finding user DN based on user RDN.

Parameters:

userRdn - user RDN

Returns:

an instance of Query

findDnByPattern

public Query findDnByPattern(String rdn)

Returns a query for finding user DN based on DN pattern.
Name of this method was derived from the original implementation of LDAP authentication. This method should be replaced by {@link QueryFactory#findUserDnByRdn(java.lang.String).

Parameters:

rdn - user RDN

Returns:

an instance of Query

findUserDnByName

public Query findUserDnByName(String userName)

Returns a query for finding user DN based on user unique name.

Parameters:

userName - user unique name (uid or sAMAccountName)

Returns:

an instance of Query

findGroupsForUser

public Query findGroupsForUser(String userName,
                               String userDn)

Returns a query for finding groups to which the user belongs.

Parameters:

userName - username

userDn - user DN

Returns:

an instance of Query

customQuery

public Query customQuery(String searchFilter)

Returns a query object created for the custom filter.
This query is configured to return a group membership attribute as part of the search result.

Parameters:

searchFilter - custom search filter

Returns:

an instance of Query