org.apache.hive.service.auth.ldap

Class Query.QueryBuilder

java.lang.Object

org.apache.hive.service.auth.ldap.Query.QueryBuilder

Enclosing class:

Query

public static final class Query.QueryBuilder
extends Object

A builder of the Query.

Method Summary

Modifier and Type	Method and Description
Query	build() Builds an instance of Query.
Query.QueryBuilder	filter(String filterTemplate) Sets search filter template.
Query.QueryBuilder	limit(int limit) Sets the maximum number of entries to be returned as a result of the search.
Query.QueryBuilder	map(String key, String value) Sets mapping between names in the search filter template and actual values.
Query.QueryBuilder	map(String key, String[] values) Sets mapping between names in the search filter template and actual values.
Query.QueryBuilder	returnAttribute(String attributeName) Sets attribute that should be returned in results for the query.

Methods inherited from class java.lang.Object

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

Method Detail

filter

public Query.QueryBuilder filter(String filterTemplate)

Sets search filter template.

Parameters:

filterTemplate - search filter template

Returns:

the current instance of the builder

map

public Query.QueryBuilder map(String key,
                              String value)

Sets mapping between names in the search filter template and actual values.

Parameters:

key - marker in the search filter template.

value - actual value

Returns:

the current instance of the builder

map

public Query.QueryBuilder map(String key,
                              String[] values)

Sets mapping between names in the search filter template and actual values.

Parameters:

key - marker in the search filter template.

values - array of values

Returns:

the current instance of the builder

returnAttribute

public Query.QueryBuilder returnAttribute(String attributeName)

Sets attribute that should be returned in results for the query.

Parameters:

attributeName - attribute name

Returns:

the current instance of the builder

limit

public Query.QueryBuilder limit(int limit)

Sets the maximum number of entries to be returned as a result of the search.
0 indicates no limit: all entries will be returned.

Parameters:

limit - The maximum number of entries that will be returned.

Returns:

the current instance of the builder

build

public Query build()

Builds an instance of Query.

Returns:

configured directory service query