org.ietf.ldap
Class LDAPSearchConstraints

java.lang.Object
  |
  +--org.ietf.ldap.LDAPConstraints
        |
        +--org.ietf.ldap.LDAPSearchConstraints

All Implemented Interfaces:

java.lang.Cloneable

public class LDAPSearchConstraints

extends LDAPConstraints

Defines the options controlling search operations.

See Also:

com.novell.ldap.LDAPSearchConstraints

Field Summary

static int	DEREF_ALWAYS Used to indicate that aliases are dereferenced when searching for the starting entry and when searching the entries beneath the starting point.
static int	DEREF_FINDING Used to indicate that aliases are dereferenced when searching for the starting entry but are not dereferenced when searching the entries beneath the starting point.
static int	DEREF_NEVER Used to indicate that aliases are never dereferenced.
static int	DEREF_SEARCHING Used to indicate that aliases are are derefrenced when searching the entries beneath the starting point but not when searching for the starting entry.

Constructor Summary

LDAPSearchConstraints()
Constructs an LDAPSearchConstraints object using the default values for the search constraints.

LDAPSearchConstraints(int msLimit, int serverTimeLimit, int dereference, int maxResults, boolean doReferrals, int batchSize, LDAPReferralHandler binder, int hop_limit)
Constructs a new LDAPSearchConstraints object and allows specifying the operational constraints in that object, including the LDAPBind object.

LDAPSearchConstraints(LDAPConstraints cons)
Constructs an LDAPSearchConstraints object using the values from an existing Constraints object.

Method Summary

int	getBatchSize() Returns how results are returned during a search.
int	getDereference() Specifies when aliases should be dereferenced.
int	getMaxResults() Returns the maximum number of search results to be returned; 0 means no limit.
int	getServerTimeLimit() Reports the maximum number of seconds that the server is to wait when returning search results while using this constraint object.
void	setBatchSize(int batchSize) Specifies how results are returned during a search operation.
void	setDereference(int dereference) Sets a preference indicating whether or not aliases should be dereferenced, and if so, when.
void	setMaxResults(int maxResults) Sets the maximum number of search results to be returned; 0 means no limit.
void	setServerTimeLimit(int seconds) Sets the maximum number of seconds that the server is to wait when returning search results.

Methods inherited from class org.ietf.ldap.LDAPConstraints

clone, getControls, getHopLimit, getProperty, getReferralFollowing, getTimeLimit, setControls, setControls, setHopLimit, setProperty, setReferralFollowing, setReferralHandler, setTimeLimit

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEREF_NEVER

public static final int DEREF_NEVER

Used to indicate that aliases are never dereferenced.

See Also:

com.novell.ldap.LDAPSearchConstraints.DEREF_NEVER, Constant Field Values

DEREF_SEARCHING

public static final int DEREF_SEARCHING

Used to indicate that aliases are are derefrenced when searching the entries beneath the starting point but not when searching for the starting entry.

See Also:

com.novell.ldap.LDAPSearchConstraints.DEREF_SEARCHING, Constant Field Values

DEREF_FINDING

public static final int DEREF_FINDING

Used to indicate that aliases are dereferenced when searching for the starting entry but are not dereferenced when searching the entries beneath the starting point.

See Also:

com.novell.ldap.LDAPSearchConstraints.DEREF_FINDING, Constant Field Values

DEREF_ALWAYS

public static final int DEREF_ALWAYS

Used to indicate that aliases are dereferenced when searching for the starting entry and when searching the entries beneath the starting point.

See Also:

com.novell.ldap.LDAPSearchConstraints.DEREF_ALWAYS, Constant Field Values

Constructor Detail

LDAPSearchConstraints

public LDAPSearchConstraints()

Constructs an LDAPSearchConstraints object using the default values for the search constraints.

See Also:

com.novell.ldap.LDAPSearchConstraints.LDAPSearchConstraints()

LDAPSearchConstraints

public LDAPSearchConstraints(LDAPConstraints cons)

Constructs an LDAPSearchConstraints object using the values from an existing Constraints object.

See Also:

com.novell.ldap.LDAPSearchConstraints.LDAPSearchConstraints(LDAPConstraints)

LDAPSearchConstraints

public LDAPSearchConstraints(int msLimit,
                             int serverTimeLimit,
                             int dereference,
                             int maxResults,
                             boolean doReferrals,
                             int batchSize,
                             LDAPReferralHandler binder,
                             int hop_limit)

Constructs a new LDAPSearchConstraints object and allows specifying the operational constraints in that object, including the LDAPBind object.

See Also:

com.novell.ldap.LDAPSearchConstraints.LDAPSearchConstraints( int, int, int, int, boolean, int, LDAPReferralHandler, int)

Method Detail

getBatchSize

public int getBatchSize()

Returns how results are returned during a search.

See Also:

com.novell.ldap.LDAPSearchConstraints.getBatchSize()

getDereference

public int getDereference()

Specifies when aliases should be dereferenced.

See Also:

com.novell.ldap.LDAPSearchConstraints.getDereference()

getMaxResults

public int getMaxResults()

Returns the maximum number of search results to be returned; 0 means no limit.

See Also:

com.novell.ldap.LDAPSearchConstraints.getMaxResults()

getServerTimeLimit

public int getServerTimeLimit()

Reports the maximum number of seconds that the server is to wait when returning search results while using this constraint object.

See Also:

com.novell.ldap.LDAPSearchConstraints.getServerTimeLimit()

setBatchSize

public void setBatchSize(int batchSize)

Specifies how results are returned during a search operation.

See Also:

com.novell.ldap.LDAPSearchConstraints.setBatchSize(int)

setDereference

public void setDereference(int dereference)

Sets a preference indicating whether or not aliases should be dereferenced, and if so, when.

See Also:

com.novell.ldap.LDAPSearchConstraints.setDereference(int)

setMaxResults

public void setMaxResults(int maxResults)

Sets the maximum number of search results to be returned; 0 means no limit. The default is 1000.

See Also:

com.novell.ldap.LDAPSearchConstraints.setMaxResults(int)

setServerTimeLimit

public void setServerTimeLimit(int seconds)

Sets the maximum number of seconds that the server is to wait when returning search results.

See Also:

com.novell.ldap.LDAPSearchConstraints.setServerTimeLimit(int)