Package org.ldaptive

Class SearchOperation.Builder

java.lang.Object

org.ldaptive.AbstractOperation.AbstractBuilder<SearchOperation.Builder,SearchOperation>

org.ldaptive.SearchOperation.Builder

Enclosing class:

SearchOperation

public static class SearchOperation.Builder
extends AbstractOperation.AbstractBuilder<SearchOperation.Builder,SearchOperation>

Search operation builder.

Field Summary

Fields inherited from class org.ldaptive.AbstractOperation.AbstractBuilder

object

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()	Creates a new builder.

Method Summary

Modifier and Type	Method	Description
SearchOperation.Builder	onEntry(LdapEntryHandler... handlers)	Sets the functions to execute when a search result entry is received.
SearchOperation.Builder	onReference(SearchReferenceHandler... handlers)	Sets the functions to execute when a search result reference is received.
SearchOperation.Builder	onSearchResult(SearchResultHandler... handlers)	Sets the functions to execute when a search result is complete.
SearchOperation.Builder	request(SearchRequest request)	Sets the search request.
protected SearchOperation.Builder	self()	Returns this builder.
SearchOperation.Builder	template(FilterTemplate template)	Sets the filter template.

Methods inherited from class org.ldaptive.AbstractOperation.AbstractBuilder

build, factory, onControl, onException, onIntermediate, onReferral, onReferralResult, onRequest, onResult, onUnsolicitedNotification, throwIf

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

protected Builder()

Creates a new builder.

Method Detail

self

protected SearchOperation.Builder self()

Description copied from class: AbstractOperation.AbstractBuilder

Returns this builder.

Specified by:

self in class AbstractOperation.AbstractBuilder<SearchOperation.Builder,SearchOperation>

Returns:

builder

request

public SearchOperation.Builder request(SearchRequest request)

Sets the search request.

Parameters:

request - to set

Returns:

this builder

template

public SearchOperation.Builder template(FilterTemplate template)

Sets the filter template.

Parameters:

template - to set

Returns:

this builder

onEntry

public SearchOperation.Builder onEntry(LdapEntryHandler... handlers)

Sets the functions to execute when a search result entry is received.

Parameters:

handlers - to execute on a search result entry

Returns:

this builder

onReference

public SearchOperation.Builder onReference(SearchReferenceHandler... handlers)

Sets the functions to execute when a search result reference is received.

Parameters:

handlers - to execute on a search result reference

Returns:

this builder

onSearchResult

public SearchOperation.Builder onSearchResult(SearchResultHandler... handlers)

Sets the functions to execute when a search result is complete.

Parameters:

handlers - to execute on a search result

Returns:

this builder