Uses of Interface
org.forgerock.opendj.ldap.messages.SearchRequest

Packages that use SearchRequest

Package	Description
org.forgerock.opendj.io	Classes and interfaces providing I/O functionality.
org.forgerock.opendj.ldap	Classes and interfaces for core types including connections, entries, and attributes.
org.forgerock.opendj.ldap.messages	Classes and interfaces for core LDAP requests/responses.
org.forgerock.opendj.ldap.schema	Classes and interfaces for constructing and querying LDAP schemas.
org.forgerock.opendj.ldif	Classes and interfaces for reading and writing LDIF.

Uses of SearchRequest in org.forgerock.opendj.io

Methods in org.forgerock.opendj.io with parameters of type SearchRequest

Modifier and Type	Method	Description
void	LdapWriter.writeSearchRequest(int messageID, SearchRequest request)	Writes the provided search request.

Uses of SearchRequest in org.forgerock.opendj.ldap

Fields in org.forgerock.opendj.ldap with type parameters of type SearchRequest

Modifier and Type	Field	Description
static Option<SearchRequest>	LdapClients.LDAP_CLIENT_KEEP_ALIVE_SEARCH_REQUEST	Specifies the parameters of the search request that will be used for keep-alives.
static Option<SearchRequest>	LdapClients.LOAD_BALANCER_AVAILABILITY_CHECK_SEARCH_REQUEST	Specifies the parameters of the search request that will be used for availability check.

Methods in org.forgerock.opendj.ldap that return SearchRequest

Modifier and Type	Method	Description
SearchRequest	LdapUrl.asSearchRequest()	Creates a new search request containing the parameters of this LDAP URL.

Methods in org.forgerock.opendj.ldap with parameters of type SearchRequest

Modifier and Type	Method	Description
Result	AbstractAsynchronousConnection.search(SearchRequest request, SearchResultHandler handler)
ConnectionEntryReader	AbstractConnection.search(SearchRequest request)
Result	AbstractConnection.search(SearchRequest request, Collection<? super SearchResultEntry> entries)
Result	AbstractConnection.search(SearchRequest request, Collection<? super SearchResultEntry> entries, Collection<? super SearchResultReference> references)
ConnectionEntryReader	AbstractConnectionWrapper.search(SearchRequest request)	Searches the Directory Server using the provided search parameters.
Result	AbstractConnectionWrapper.search(SearchRequest request, Collection<? super SearchResultEntry> entries)	Searches the Directory Server using the provided search request.
Result	AbstractConnectionWrapper.search(SearchRequest request, Collection<? super SearchResultEntry> entries, Collection<? super SearchResultReference> references)	Searches the Directory Server using the provided search request.
Result	AbstractConnectionWrapper.search(SearchRequest request, SearchResultHandler handler)	Searches the Directory Server using the provided search request.
ConnectionEntryReader	Connection.search(SearchRequest request)	Searches the Directory Server using the provided search parameters.
Result	Connection.search(SearchRequest request, Collection<? super SearchResultEntry> entries)	Searches the Directory Server using the provided search request.
Result	Connection.search(SearchRequest request, Collection<? super SearchResultEntry> entries, Collection<? super SearchResultReference> references)	Searches the Directory Server using the provided search request.
Result	Connection.search(SearchRequest request, SearchResultHandler handler)	Searches the Directory Server using the provided search request.
default io.reactivex.rxjava3.core.Flowable<SearchResultEntry>	LdapClientSocket.search(SearchRequest request)	Searches the Directory Server using the provided search request.
LdapPromise<Result>	AbstractConnection.searchAsync(SearchRequest request, SearchResultHandler resultHandler)
LdapPromise<Result>	AbstractConnectionWrapper.searchAsync(SearchRequest request, IntermediateResponseHandler intermediateResponseHandler, SearchResultHandler entryHandler)	Asynchronously searches the Directory Server using the provided search request.
LdapPromise<Result>	AbstractConnectionWrapper.searchAsync(SearchRequest request, SearchResultHandler resultHandler)	Asynchronously searches the Directory Server using the provided search request.
LdapPromise<Result>	AbstractSynchronousConnection.searchAsync(SearchRequest request, IntermediateResponseHandler intermediateResponseHandler, SearchResultHandler entryHandler)
LdapPromise<Result>	Connection.searchAsync(SearchRequest request, IntermediateResponseHandler intermediateResponseHandler, SearchResultHandler entryHandler)	Asynchronously searches the Directory Server using the provided search request.
LdapPromise<Result>	Connection.searchAsync(SearchRequest request, SearchResultHandler entryHandler)	Asynchronously searches the Directory Server using the provided search request.
SearchResultEntry	AbstractConnection.searchSingleEntry(SearchRequest request)
SearchResultEntry	AbstractConnectionWrapper.searchSingleEntry(SearchRequest request)	Searches the Directory Server for a single entry using the provided search request.
SearchResultEntry	Connection.searchSingleEntry(SearchRequest request)	Searches the Directory Server for a single entry using the provided search request.
default io.reactivex.rxjava3.core.Single<SearchResultEntry>	LdapClientSocket.searchSingleEntry(SearchRequest request)	Searches the Directory Server for a single entry using the provided search request.
LdapPromise<SearchResultEntry>	AbstractConnection.searchSingleEntryAsync(SearchRequest request)
LdapPromise<SearchResultEntry>	AbstractConnectionWrapper.searchSingleEntryAsync(SearchRequest request)	Asynchronously searches the Directory Server for a single entry using the provided search request.
LdapPromise<SearchResultEntry>	Connection.searchSingleEntryAsync(SearchRequest request)	Asynchronously searches the Directory Server for a single entry using the provided search request.

Uses of SearchRequest in org.forgerock.opendj.ldap.messages

Methods in org.forgerock.opendj.ldap.messages that return SearchRequest

Modifier and Type	Method	Description
SearchRequest	SearchRequest.addAttribute(String... attributeDescriptions)	Adds the provided attribute name(s) to the list of attributes to be included with each entry that matches the search criteria.
SearchRequest	SearchRequest.addControl(Control control)
SearchRequest	SearchRequest.addControls(Iterable<? extends Control> controls)
static SearchRequest	Requests.copyOfSearchRequest(SearchRequest request)	Creates a new search request that is an exact copy of the provided request.
static SearchRequest	Requests.newSearchRequest(String name, SearchScope scope)	Creates a new search request using the provided distinguished name and scope.
static SearchRequest	Requests.newSearchRequest(String name, SearchScope scope, String filter, String... attributeDescriptions)	Creates a new search request using the provided distinguished name, scope, and filter, decoded using the default schema.
static SearchRequest	Requests.newSearchRequest(Dn name, SearchScope scope)	Creates a new search request using the provided distinguished name and scope.
static SearchRequest	Requests.newSearchRequest(Dn name, SearchScope scope, Filter filter, String... attributeDescriptions)	Creates a new search request using the provided distinguished name, scope, and filter.
static SearchRequest	Requests.newSingleEntrySearchRequest(String name, SearchScope scope, String filter, String... attributeDescriptions)	Creates a new search request for a single entry, using the provided distinguished name, scope, and filter, decoded using the default schema.
static SearchRequest	Requests.newSingleEntrySearchRequest(Dn name, SearchScope scope, Filter filter, String... attributeDescriptions)	Creates a new search request for a single entry, using the provided distinguished name, scope, and filter.
SearchRequest	SearchRequest.setDereferenceAliasesPolicy(DereferenceAliasesPolicy policy)	Sets the alias dereferencing policy to be used during the search.
SearchRequest	SearchRequest.setFilter(String filter)	Sets the filter that defines the conditions that must be fulfilled in order for an entry to be returned.
SearchRequest	SearchRequest.setFilter(Filter filter)	Sets the filter that defines the conditions that must be fulfilled in order for an entry to be returned.
SearchRequest	SearchRequest.setName(String dn)	Sets the distinguished name of the base entry relative to which the search is to be performed.
SearchRequest	SearchRequest.setName(Dn dn)	Sets the distinguished name of the base entry relative to which the search is to be performed.
SearchRequest	SearchRequest.setScope(SearchScope scope)	Sets the scope of the search.
SearchRequest	SearchRequest.setSizeLimit(int limit)	Sets the size limit that should be used in order to restrict the maximum number of entries returned by the search.
SearchRequest	SearchRequest.setTimeLimit(int limit)	Sets the time limit that should be used in order to restrict the maximum time (in seconds) allowed for the search.
SearchRequest	SearchRequest.setTypesOnly(boolean typesOnly)	Specifies whether search results are to contain both attribute descriptions and values, or just attribute descriptions.
static SearchRequest	Requests.unmodifiableSearchRequest(SearchRequest request)	Creates an unmodifiable search request of the provided request.

Methods in org.forgerock.opendj.ldap.messages with parameters of type SearchRequest

Modifier and Type	Method	Description
static SearchRequest	Requests.copyOfSearchRequest(SearchRequest request)	Creates a new search request that is an exact copy of the provided request.
static SearchRequest	Requests.unmodifiableSearchRequest(SearchRequest request)	Creates an unmodifiable search request of the provided request.
R	AbstractRequestVisitor.visitRequest(P p, SearchRequest request)
R	RequestVisitor.visitRequest(P p, SearchRequest request)	Visits an Search request.

Uses of SearchRequest in org.forgerock.opendj.ldap.schema

Methods in org.forgerock.opendj.ldap.schema that return SearchRequest

Modifier and Type	Method	Description
static SearchRequest	Schema.getReadSchemaSearchRequest(Dn name)	Constructs a search request for retrieving the named subschema sub-entry.

Uses of SearchRequest in org.forgerock.opendj.ldif

Methods in org.forgerock.opendj.ldif with parameters of type SearchRequest

Modifier and Type	Method	Description
static EntryReader	Ldif.search(EntryReader input, SearchRequest search)	Returns a filtered view of input containing only those entries which match the search base DN, scope, and filtered defined in search.
static EntryReader	Ldif.search(EntryReader input, SearchRequest search, Schema schema)	Returns a filtered view of input containing only those entries which match the search base DN, scope, and filtered defined in search.

Constructors in org.forgerock.opendj.ldif with parameters of type SearchRequest

Constructor	Description
ConnectionEntryReader(Connection connection, SearchRequest searchRequest)	Creates a new connection entry reader whose destination is the provided connection using an unbounded LinkedBlockingQueue.
ConnectionEntryReader(Connection connection, SearchRequest searchRequest, BlockingQueue<Response> entries)	Creates a new connection entry reader whose destination is the provided connection.