Serializable
public class SearchControls extends Object implements Serializable
A SearchControls instance is not synchronized against concurrent multithreaded access. Multiple threads trying to access and modify a single SearchControls instance should lock the object.
Modifier and Type | Field | Description |
---|---|---|
static final int |
OBJECT_SCOPE |
Search the named object. |
static final int |
ONELEVEL_SCOPE |
Search one level of the named context. |
static final int |
SUBTREE_SCOPE |
Search the entire subtree rooted at the named object. |
Constructor | Description |
---|---|
SearchControls() |
Constructs a search constraints using defaults. |
SearchControls |
Constructs a search constraints using arguments. |
Modifier and Type | Method | Description |
---|---|---|
long |
getCountLimit() |
Retrieves the maximum number of entries that will be returned as a result of the search. |
boolean |
getDerefLinkFlag() |
Determines whether links will be dereferenced during the search. |
String[] |
getReturningAttributes() |
Retrieves the attributes that will be returned as part of the search. |
boolean |
getReturningObjFlag() |
Determines whether objects will be returned as part of the result. |
int |
getSearchScope() |
Retrieves the search scope of these SearchControls. |
int |
getTimeLimit() |
Retrieves the time limit of these SearchControls in milliseconds. |
void |
setCountLimit |
Sets the maximum number of entries to be returned as a result of the search. |
void |
setDerefLinkFlag |
Enables/disables link dereferencing during the search. |
void |
setReturningAttributes |
Specifies the attributes that will be returned as part of the search. |
void |
setReturningObjFlag |
Enables/disables returning objects returned as part of the result. |
void |
setSearchScope |
Sets the search scope to one of: OBJECT_SCOPE, ONELEVEL_SCOPE, SUBTREE_SCOPE. |
void |
setTimeLimit |
Sets the time limit of these SearchControls in milliseconds. |
public static final int OBJECT_SCOPE
The NamingEnumeration that results from search() using OBJECT_SCOPE will contain one or zero element. The enumeration contains one element if the named object satisfies the search filter specified in search(). The element will have as its name the empty string because the names of elements in the NamingEnumeration are relative to the target context--in this case, the target context is the named object. It contains zero element if the named object does not satisfy the search filter specified in search().
The value of this constant is 0
.
public static final int ONELEVEL_SCOPE
The NamingEnumeration that results from search() using ONELEVEL_SCOPE contains elements with objects in the named context that satisfy the search filter specified in search(). The names of elements in the NamingEnumeration are atomic names relative to the named context.
The value of this constant is 1
.
public static final int SUBTREE_SCOPE
If the named object is not a DirContext, search only the object. If the named object is a DirContext, search the subtree rooted at the named object, including the named object itself.
The search will not cross naming system boundaries.
The NamingEnumeration that results from search() using SUBTREE_SCOPE contains elements of objects from the subtree (including the named context) that satisfy the search filter specified in search(). The names of elements in the NamingEnumeration are either relative to the named context or is a URL string. If the named context satisfies the search filter, it is included in the enumeration with the empty string as its name.
The value of this constant is 2
.
public SearchControls()
The defaults are:
public SearchControls(int scope, long countlim, int timelim, String[] attrs, boolean retobj, boolean deref)
scope
- The search scope. One of: OBJECT_SCOPE, ONELEVEL_SCOPE, SUBTREE_SCOPE.countlim
- The maximum number of entries to return. If 0, return all entries that satisfy filter.timelim
- The number of milliseconds to wait before returning. If 0, wait indefinitely.attrs
- The identifiers of the attributes to return along with the entry. If null, return all attributes. If empty return no attributes.retobj
- If true, return the object bound to the name of the entry; if false, do not return object.deref
- If true, dereference links during search.public int getSearchScope()
One of OBJECT_SCOPE, ONELEVEL_SCOPE, SUBTREE_SCOPE.
public int getTimeLimit()
If the value is 0, this means to wait indefinitely.
public boolean getDerefLinkFlag()
public boolean getReturningObjFlag()
public long getCountLimit()
0 indicates that all entries will be returned.
public String[] getReturningAttributes()
A value of null indicates that all attributes will be returned. An empty array indicates that no attributes are to be returned.
public void setSearchScope(int scope)
scope
- The search scope of this SearchControls.public void setTimeLimit(int ms)
If the value is 0, this means to wait indefinitely.
ms
- The time limit of these SearchControls in milliseconds.public void setDerefLinkFlag(boolean on)
on
- if true links will be dereferenced; if false, not followed.public void setReturningObjFlag(boolean on)
If disabled, only the name and class of the object is returned. If enabled, the object will be returned.
on
- if true, objects will be returned; if false, objects will not be returned.public void setCountLimit(long limit)
0 indicates no limit: all entries will be returned.
limit
- The maximum number of entries that will be returned.public void setReturningAttributes(String[] attrs)
null indicates that all attributes will be returned. An empty array indicates no attributes are returned.
attrs
- An array of attribute ids identifying the attributes that will be returned. Can be null.
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.naming/javax/naming/directory/SearchControls.html