org.apache.hive.service.auth.ldap

Class SearchResultHandler

java.lang.Object

org.apache.hive.service.auth.ldap.SearchResultHandler

public final class SearchResultHandler
extends Object

The object that handles Directory Service search results. In most cases it converts search results into a list of names in the namespace.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SearchResultHandler.RecordProcessor An interface used by SearchResultHandler for processing records of a SearchResult on a per-record basis.

Constructor Summary

Constructors

Constructor and Description
SearchResultHandler(Collection<NamingEnumeration<SearchResult>> searchResults) Constructs a search result handler object for the provided search results.

Method Summary

Modifier and Type	Method and Description
List<String>	getAllLdapNames() Returns all entries from the search result.
List<String>	getAllLdapNamesAndAttributes() Returns all entries and all attributes for these entries.
String	getSingleLdapName() Returns a single entry from the search result.
void	handle(SearchResultHandler.RecordProcessor processor) Allows for custom processing of the search results.
boolean	hasSingleResult() Checks whether search result contains exactly one entry.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchResultHandler

public SearchResultHandler(Collection<NamingEnumeration<SearchResult>> searchResults)

Constructs a search result handler object for the provided search results.

Parameters:

searchResults - directory service search results

Method Detail

getAllLdapNames

public List<String> getAllLdapNames()
                             throws NamingException

Returns all entries from the search result.

Returns:

a list of names in the namespace

Throws:

NamingException

hasSingleResult

public boolean hasSingleResult()
                        throws NamingException

Checks whether search result contains exactly one entry.

Returns:

true if the search result contains a single entry.

Throws:

NamingException

getSingleLdapName

public String getSingleLdapName()
                         throws NamingException

Returns a single entry from the search result. Throws NamingException if the search result doesn't contain exactly one entry.

Returns:

name in the namespace

Throws:

NamingException

getAllLdapNamesAndAttributes

public List<String> getAllLdapNamesAndAttributes()
                                          throws NamingException

Returns all entries and all attributes for these entries.

Returns:

a list that includes all entries and all attributes from these entries.

Throws:

NamingException

handle

public void handle(SearchResultHandler.RecordProcessor processor)
            throws NamingException

Allows for custom processing of the search results.

Parameters:

processor - SearchResultHandler.RecordProcessor implementation

Throws:

NamingException