All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class javax.naming.directory.SearchControls

java.lang.Object
   |
   +----javax.naming.directory.SearchControls

public class SearchControls
extends Object
implements Serializable
The SearchControls class encapsultes factors that determine scope of search and what gets returned as a result of the search.

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.

The serialized form of a SearchControls object consists of the search scope (an int), the time limit (an int), the "dereference links" flag (a boolean), the "return objects" flag (a boolean), the count limit (an int), and a String array naming the attributes to return.


Variable Index

 o OBJECT_SCOPE
Search the named object.
 o ONELEVEL_SCOPE
Search one level of the named context.
 o SUBTREE_SCOPE
Search the entire subtree rooted at the named object.

Constructor Index

 o SearchControls()
Constructs a search contraints using defaults.
 o SearchControls(int, long, int, String[], boolean, boolean)
Constructs a search contraints using arguments.

Method Index

 o getCountLimit()
Retrieves the maximum number of entries that will be returned as a result of the search.
 o getDerefLinkFlag()
Determines whether links will be dereferenced during the search.
 o getReturningAttributes()
Retrieves the attributes that will be returned as part of the search.
 o getReturningObjFlag()
Determines whether objects will be returned as part of the result.
 o getSearchScope()
Retrieves the search scope of these Controls.
 o getTimeLimit()
Retrieves the time limit of these Controls in milliseconds.
 o setCountLimit(long)
Sets the maximum number of entries to be returned as a result of the search.
 o setDerefLinkFlag(boolean)
Enables/disables link dereferencing during the search.
 o setReturningAttributes(String[])
Specifies the attributes that will be returned as part of the search.
 o setReturningObjFlag(boolean)
Enables/disables returning objects returned as part of the result.
 o setSearchScope(int)
Sets the search scope to one of: OBJECT_SCOPE, ONELEVEL_SCOPE, SUBTREE_SCOPE.
 o setTimeLimit(int)
Sets the time limit of these Controls in milliseconds.

Variables

 o OBJECT_SCOPE
 public static final int OBJECT_SCOPE
Search the named object.

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().

 o ONELEVEL_SCOPE
 public static final int ONELEVEL_SCOPE
Search one level of the named context.

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.

 o SUBTREE_SCOPE
 public static final int SUBTREE_SCOPE
Search the entire subtree rooted at the named object. 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.

Constructors

 o SearchControls
 public SearchControls()
Constructs a search contraints using defaults. The defaults are:

 o SearchControls
 public SearchControls(int scope,
                       long countlim,
                       int timelim,
                       String attrs[],
                       boolean retobj,
                       boolean deref)
Constructs a search contraints using arguments.

Parameters:
scope - The search scope. One of: OBJECT_SCOPE, ONELEVEL_SCOPE, SUBTREE_SCOPE.
timelim - The number of milliseconds to wait before returning. If 0, wait indefinitely.
deref - If true, dereference links during search.
countlim - The maximum number of entries to return. If 0, return all entries that satisfy filter.
retobj - If true, return the object bound to the name of the entry; if false, do not return object.
attrs - The identifiers of the attributes to return along with the entry. If null, return all attributes. If emtpy return no attributes.

Methods

 o getSearchScope
 public int getSearchScope()
Retrieves the search scope of these Controls. One of OBJECT_SCOPE, ONELEVEL_SCOPE, SUBTREE_SCOPE.

Returns:
The search scope of this Controls.
 o getTimeLimit
 public int getTimeLimit()
Retrieves the time limit of these Controls in milliseconds. If the value is 0, this means to wait indefinitely.

Returns:
The time limit of these Controls in milliseconds.
 o getDerefLinkFlag
 public boolean getDerefLinkFlag()
Determines whether links will be dereferenced during the search.

Returns:
true if links will be dereferenced; false otherwise.
 o getReturningObjFlag
 public boolean getReturningObjFlag()
Determines whether objects will be returned as part of the result.

Returns:
true if objects will be returned; false otherwise.
 o getCountLimit
 public long getCountLimit()
Retrieves the maximum number of entries that will be returned as a result of the search. 0 indicates that all entries will be returned.

Returns:
The maximum number of entries that will be returned.
 o getReturningAttributes
 public String[] getReturningAttributes()
Retrieves the attributes that will be returned as part of the search. A value of null indicates that all attributes will be returned. An empty array indicates that no attributes are to be returned.

Returns:
An array of attribute ids identifying the attributes that will be returned. Can be null.
 o setSearchScope
 public void setSearchScope(int scope)
Sets the search scope to one of: OBJECT_SCOPE, ONELEVEL_SCOPE, SUBTREE_SCOPE.

Parameters:
The - search scope of this Controls.
 o setTimeLimit
 public void setTimeLimit(int ms)
Sets the time limit of these Controls in milliseconds. If the value is 0, this means to wait indefinitely.

Parameters:
The - time limit of these Controls in milliseconds.
 o setDerefLinkFlag
 public void setDerefLinkFlag(boolean on)
Enables/disables link dereferencing during the search.

Parameters:
on - if true links will be dereferenced; if false, not followed.
 o setReturningObjFlag
 public void setReturningObjFlag(boolean on)
Enables/disables returning objects returned as part of the result. If disabled, only the name and class of the object is returned. If enabled, the object will be returned.

Parameters:
on - if true, objects will be returned; if false, objects will not be returned.
 o setCountLimit
 public void setCountLimit(long limit)
Sets the maximum number of entries to be returned as a result of the search. 0 indicates no limit: all entries will be returned.

Parameters:
limit - The maximum number of entries that will be returned.
 o setReturningAttributes
 public void setReturningAttributes(String attrs[])
Specifies the attributes that will be returned as part of the search. null indicates that all attributes will be returned. An empty array indicates no attributes are returned.

Parameters:
attrs - An array of attribute ids identifying the attributes that will be returned. Can be null.

All Packages  Class Hierarchy  This Package  Previous  Next  Index