| 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.requests |
Classes and interfaces for core LDAP requests.
|
| org.forgerock.opendj.ldap.spi |
Interfaces and classes for service providers.
|
| org.forgerock.opendj.ldif |
Classes and interfaces for reading and writing LDIF.
|
| Modifier and Type | Method and Description |
|---|---|
void |
AbstractLDAPMessageHandler.searchRequest(int messageID,
SearchRequest request) |
void |
LDAPMessageHandler.searchRequest(int messageID,
SearchRequest request)
Handles an LDAP search request message.
|
void |
LDAPWriter.writeSearchRequest(int messageID,
SearchRequest request)
Writes the provided search request.
|
| Modifier and Type | Method and Description |
|---|---|
SearchRequest |
LDAPUrl.asSearchRequest()
Creates a new search request containing the parameters of this LDAP URL.
|
| Modifier and Type | Method and Description |
|---|---|
void |
RequestHandler.handleSearch(C requestContext,
SearchRequest request,
IntermediateResponseHandler intermediateResponseHandler,
SearchResultHandler entryHandler,
LdapResultHandler<Result> resultHandler)
Invoked when a search request is received from a client.
|
void |
MemoryBackend.handleSearch(RequestContext requestContext,
SearchRequest request,
IntermediateResponseHandler intermediateResponseHandler,
SearchResultHandler entryHandler,
LdapResultHandler<Result> resultHandler) |
static ConnectionFactory |
Connections.newHeartBeatConnectionFactory(ConnectionFactory factory,
long interval,
long timeout,
TimeUnit unit,
SearchRequest heartBeat)
Creates a new heart-beat connection factory which will create connections
using the provided connection factory and periodically ping any created
connections using the specified search request in order to detect that
they are still alive.
|
static ConnectionFactory |
Connections.newHeartBeatConnectionFactory(ConnectionFactory factory,
long interval,
long timeout,
TimeUnit unit,
SearchRequest heartBeat,
ScheduledExecutorService scheduler)
Creates a new heart-beat connection factory which will create connections
using the provided connection factory and periodically ping any created
connections using the specified search request in order to detect that
they are still alive.
|
ConnectionEntryReader |
AbstractConnection.search(SearchRequest request) |
ConnectionEntryReader |
Connection.search(SearchRequest request)
Searches the Directory Server using the provided search parameters.
|
ConnectionEntryReader |
AbstractConnectionWrapper.search(SearchRequest request)
Searches the Directory Server using the provided search parameters.
|
Result |
AbstractConnection.search(SearchRequest request,
Collection<? super SearchResultEntry> entries) |
Result |
Connection.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)
Searches the Directory Server using the provided search request.
|
Result |
AbstractConnection.search(SearchRequest request,
Collection<? super SearchResultEntry> entries,
Collection<? super SearchResultReference> references) |
Result |
Connection.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,
Collection<? super SearchResultEntry> entries,
Collection<? super SearchResultReference> references)
Searches the Directory Server using the provided search request.
|
Result |
AbstractAsynchronousConnection.search(SearchRequest request,
SearchResultHandler handler)
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.
|
Result |
AbstractConnectionWrapper.search(SearchRequest request,
SearchResultHandler handler)
Searches the Directory Server using the provided search request.
|
LdapPromise<Result> |
Connection.searchAsync(SearchRequest request,
IntermediateResponseHandler intermediateResponseHandler,
SearchResultHandler entryHandler)
Asynchronously searches the Directory Server using the provided search
request.
|
LdapPromise<Result> |
AbstractConnectionWrapper.searchAsync(SearchRequest request,
IntermediateResponseHandler intermediateResponseHandler,
SearchResultHandler entryHandler)
Asynchronously searches the Directory Server using the provided search
request.
|
LdapPromise<Result> |
AbstractSynchronousConnection.searchAsync(SearchRequest request,
IntermediateResponseHandler intermediateResponseHandler,
SearchResultHandler entryHandler) |
LdapPromise<Result> |
AbstractConnection.searchAsync(SearchRequest request,
SearchResultHandler resultHandler) |
LdapPromise<Result> |
Connection.searchAsync(SearchRequest request,
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.
|
SearchResultEntry |
AbstractConnection.searchSingleEntry(SearchRequest request) |
SearchResultEntry |
Connection.searchSingleEntry(SearchRequest request)
Searches the Directory Server for a single entry using the provided
search request.
|
SearchResultEntry |
AbstractConnectionWrapper.searchSingleEntry(SearchRequest request)
Searches the Directory Server for a single entry using the provided
search request.
|
LdapPromise<SearchResultEntry> |
AbstractConnection.searchSingleEntryAsync(SearchRequest request) |
LdapPromise<SearchResultEntry> |
Connection.searchSingleEntryAsync(SearchRequest request)
Asynchronously searches the Directory Server for a single entry using the
provided search request.
|
LdapPromise<SearchResultEntry> |
AbstractConnectionWrapper.searchSingleEntryAsync(SearchRequest request)
Asynchronously searches the Directory Server for a single entry using the
provided search request.
|
| Modifier and Type | Method and 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) |
static SearchRequest |
Requests.copyOfSearchRequest(SearchRequest request)
Creates a new search request that is an exact copy of the provided
request.
|
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.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.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.
|
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.
|
SearchRequest |
SearchRequest.setDereferenceAliasesPolicy(DereferenceAliasesPolicy policy)
Sets the alias dereferencing policy to be used during the search.
|
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.setFilter(String filter)
Sets the filter that defines the conditions that must be fulfilled in
order for an entry to be returned.
|
SearchRequest |
SearchRequest.setName(DN dn)
Sets the distinguished name of the base entry relative to which the
search is to be performed.
|
SearchRequest |
SearchRequest.setName(String 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.
|
| Modifier and Type | Method and 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.
|
| Modifier and Type | Method and Description |
|---|---|
static SearchResultLdapPromiseImpl |
LdapPromises.newSearchLdapPromise(int requestID,
SearchRequest request,
SearchResultHandler resultHandler,
IntermediateResponseHandler intermediateResponseHandler,
Connection connection)
Creates a new search
SearchResultLdapPromiseImpl. |
| Modifier and Type | Method and 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. |
| Constructor and 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.
|
Copyright © 2011-2015 ForgeRock AS. All Rights Reserved.