com.unboundid.ldap.sdk.migrate.ldapjdk

Class LDAPSearchConstraints

java.lang.Object

com.unboundid.ldap.sdk.migrate.ldapjdk.LDAPConstraints

com.unboundid.ldap.sdk.migrate.ldapjdk.LDAPSearchConstraints

All Implemented Interfaces:

java.io.Serializable

@NotExtensible
 @Mutable
 @ThreadSafety(level=NOT_THREADSAFE)
public class LDAPSearchConstraints
extends LDAPConstraints

This class provides a data structure which may be used to define a set of constraints that may be used when processing search operations.

This class is primarily intended to be used in the process of updating applications which use the Netscape Directory SDK for Java to switch to or coexist with the UnboundID LDAP SDK for Java. For applications not written using the Netscape Directory SDK for Java, the LDAPConnectionOptions class should be used instead.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LDAPSearchConstraints() Creates a new set of search constraints with the default settings.
LDAPSearchConstraints(int msLimit, int dereference, int maxResults, boolean doReferrals, int batchSize, LDAPRebind rebindProc, int hopLimit) Creates a new set of search constraints with the specified information.
LDAPSearchConstraints(int msLimit, int timeLimit, int dereference, int maxResults, boolean doReferrals, int batchSize, LDAPBind bindProc, int hopLimit) Creates a new set of search constraints with the specified information.
LDAPSearchConstraints(int msLimit, int timeLimit, int dereference, int maxResults, boolean doReferrals, int batchSize, LDAPRebind rebindProc, int hopLimit) Creates a new set of search constraints with the specified information.

Method Summary

Modifier and Type	Method and Description
LDAPSearchConstraints	duplicate() Creates a duplicate of this search constraints object.
int	getBatchSize() Retrieves the suggested batch size to use when retrieving results.
int	getDereference() Retrieves the alias dereferencing policy that should be used.
int	getMaxResults() Retrieves the maximum number of entries that should be returned for a search.
int	getServerTimeLimit() Retrieves the maximum length of time in seconds that the server should spend processing a search.
void	setBatchSize(int batchSize) Specifies the suggested batch size to use when retrieving results.
void	setDereference(int dereference) Specifies the alias dereferencing policy that should be used.
void	setMaxResults(int maxResults) Specifies the maximum number of entries that should be returned for a search.
void	setServerTimeLimit(int limit) Specifies the maximum length of time in seconds that the server should spend processing a search.
java.lang.String	toString() Retrieves a string representation of this search constraints object.

Methods inherited from class com.unboundid.ldap.sdk.migrate.ldapjdk.LDAPConstraints

getBindProc, getClientControls, getHopLimit, getRebindProc, getReferrals, getServerControls, getTimeLimit, setBindProc, setClientControls, setClientControls, setHopLimit, setRebindProc, setReferrals, setServerControls, setServerControls, setTimeLimit

Methods inherited from class java.lang.Object

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

Constructor Detail

LDAPSearchConstraints

public LDAPSearchConstraints()

Creates a new set of search constraints with the default settings.

LDAPSearchConstraints

public LDAPSearchConstraints(int msLimit,
                             int dereference,
                             int maxResults,
                             boolean doReferrals,
                             int batchSize,
                             @Nullable
                             LDAPRebind rebindProc,
                             int hopLimit)

Creates a new set of search constraints with the specified information.

Parameters:

msLimit - The maximum length of time in milliseconds to spend waiting for the response.

dereference - The policy to use when dereferencing aliases.

maxResults - The maximum number of entries to return from the server.

doReferrals - Indicates whether to follow referrals.

batchSize - The batch size to use when retrieving results.

rebindProc - The object to use to obtain information for authenticating the connection for use when following referrals.

hopLimit - The maximum number of hops to take when following referrals.

LDAPSearchConstraints

public LDAPSearchConstraints(int msLimit,
                             int timeLimit,
                             int dereference,
                             int maxResults,
                             boolean doReferrals,
                             int batchSize,
                             @Nullable
                             LDAPRebind rebindProc,
                             int hopLimit)

Creates a new set of search constraints with the specified information.

Parameters:

msLimit - The maximum length of time in milliseconds to spend waiting for the response.

timeLimit - The maximum length of time in seconds the server should spend processing the request.

dereference - The policy to use when dereferencing aliases.

maxResults - The maximum number of entries to return from the server.

doReferrals - Indicates whether to follow referrals.

batchSize - The batch size to use when retrieving results.

rebindProc - The object to use to obtain information for authenticating the connection for use when following referrals.

hopLimit - The maximum number of hops to take when following referrals.

LDAPSearchConstraints

public LDAPSearchConstraints(int msLimit,
                             int timeLimit,
                             int dereference,
                             int maxResults,
                             boolean doReferrals,
                             int batchSize,
                             @Nullable
                             LDAPBind bindProc,
                             int hopLimit)

Creates a new set of search constraints with the specified information.

Parameters:

msLimit - The maximum length of time in milliseconds to spend waiting for the response.

timeLimit - The maximum length of time in seconds the server should spend processing the request.

dereference - The policy to use when dereferencing aliases.

maxResults - The maximum number of entries to return from the server.

doReferrals - Indicates whether to follow referrals.

batchSize - The batch size to use when retrieving results.

bindProc - The object to use to obtain authenticating the connection for use when following referrals.

hopLimit - The maximum number of hops to take when following referrals.

Method Detail

getBatchSize

public int getBatchSize()

Retrieves the suggested batch size to use when retrieving results.

Returns:

The suggested batch size to use when retrieving results.

setBatchSize

public void setBatchSize(int batchSize)

Specifies the suggested batch size to use when retrieving results.

Parameters:

batchSize - The suggested batch size to use when retrieving results.

getDereference

public int getDereference()

Retrieves the alias dereferencing policy that should be used.

Returns:

The alias dereferencing policy that should be used.

setDereference

public void setDereference(int dereference)

Specifies the alias dereferencing policy that should be used.

Parameters:

dereference - The alias dereferencing policy that should be used.

getMaxResults

public int getMaxResults()

Retrieves the maximum number of entries that should be returned for a search.

Returns:

The maximum number of entries that should be returned for a search.

setMaxResults

public void setMaxResults(int maxResults)

Specifies the maximum number of entries that should be returned for a search.

Parameters:

maxResults - The maximum number of entries that should be returned for a search.

getServerTimeLimit

public int getServerTimeLimit()

Retrieves the maximum length of time in seconds that the server should spend processing a search.

Returns:

The maximum length of time in seconds that the server should spend processing a search.

setServerTimeLimit

public void setServerTimeLimit(int limit)

Specifies the maximum length of time in seconds that the server should spend processing a search.

Parameters:

limit - The maximum length of time in seconds that the server should spend processing a search.

duplicate

@NotNull
public LDAPSearchConstraints duplicate()

Creates a duplicate of this search constraints object.

Overrides:

duplicate in class LDAPConstraints

Returns:

A duplicate of this search constraints object.

toString

@NotNull
public java.lang.String toString()

Retrieves a string representation of this search constraints object.

Overrides:

toString in class LDAPConstraints

Returns:

A string representation of this search constraints object.