|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@NotExtensible @ThreadSafety(level=INTERFACE_NOT_THREADSAFE) public interface ReadOnlySearchRequest
This interface defines a set of methods that may be safely called in an LDAP
search request without altering its contents. This interface must not be
implemented by any class other than SearchRequest
.
This interface does not inherently provide the assurance of thread safety for
the methods that it exposes, because it is still possible for a thread
referencing the object which implements this interface to alter the request
using methods not included in this interface. However, if it can be
guaranteed that no thread will alter the underlying object, then the methods
exposed by this interface can be safely invoked concurrently by any number of
threads.
Method Summary | |
---|---|
SearchRequest |
duplicate()
Creates a new instance of this LDAP request that may be modified without impacting this request. |
SearchRequest |
duplicate(Control[] controls)
Creates a new instance of this LDAP request that may be modified without impacting this request. |
java.util.List<java.lang.String> |
getAttributeList()
Retrieves the set of requested attributes to include in matching entries. |
java.lang.String |
getBaseDN()
Retrieves the base DN for this search request. |
DereferencePolicy |
getDereferencePolicy()
Retrieves the dereference policy that should be used by the server for any aliases encountered during search processing. |
Filter |
getFilter()
Retrieves the filter that should be used to identify matching entries. |
SearchScope |
getScope()
Retrieves the scope for this search request. |
int |
getSizeLimit()
Retrieves the maximum number of entries that should be returned by the server when processing this search request. |
int |
getTimeLimitSeconds()
Retrieves the maximum length of time in seconds that the server should spend processing this search request. |
boolean |
typesOnly()
Indicates whether the server should return only attribute names in matching entries, rather than both names and values. |
Methods inherited from interface com.unboundid.ldap.sdk.ReadOnlyLDAPRequest |
---|
followReferrals, getControl, getControlList, getResponseTimeoutMillis, hasControl, hasControl, toCode, toString, toString |
Method Detail |
---|
java.lang.String getBaseDN()
SearchScope getScope()
DereferencePolicy getDereferencePolicy()
int getSizeLimit()
int getTimeLimitSeconds()
boolean typesOnly()
true
if matching entries should include only attribute
names, or false
if matching entries should include both
attribute names and values.Filter getFilter()
java.util.List<java.lang.String> getAttributeList()
SearchRequest duplicate()
duplicate
in interface ReadOnlyLDAPRequest
SearchRequest duplicate(Control[] controls)
duplicate
in interface ReadOnlyLDAPRequest
controls
- The set of controls to include in the duplicate request.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |