org.apache.directory.server.core.api

Class SearchRequestContainer

java.lang.Object

org.apache.directory.server.core.api.SearchRequestContainer

public class SearchRequestContainer
extends java.lang.Object

A container storing a SearchRequest being processed, and the associated size and time limit.
We use an instance of this class for each new searchRequest, and we discard it when the SearchRequest is completed or abandonned.

Field Summary

Fields

Modifier and Type	Field and Description
private int	count The number of entries already sent
private org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry>	cursor The Cursor associated with the searchRequest
private long	initialTime The SearchRequest reception date
private org.apache.directory.api.ldap.model.message.SearchRequest	searchRequest The SearchRequest
private long	sizeLimit The maximum number of entries we can send
private long	timeLimit The time limit

Constructor Summary

Constructors

Constructor and Description
SearchRequestContainer(org.apache.directory.api.ldap.model.message.SearchRequest searchRequest, org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry> cursor) Create an instance of the container with the SearchRequest and its limit.

Method Summary

Modifier and Type	Method and Description
int	getCount()
org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry>	getCursor()
long	getInitialTime()
org.apache.directory.api.ldap.model.message.SearchRequest	getSearchRequest()
long	getSizeLimit()
int	getTimeLimit()
void	increment()
boolean	isSizeLimitReached() Check the size limit
boolean	isTimeLimitReached() Check if we have reached the time limit
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

searchRequest

private org.apache.directory.api.ldap.model.message.SearchRequest searchRequest

The SearchRequest

sizeLimit

private long sizeLimit

The maximum number of entries we can send

count

private int count

The number of entries already sent

timeLimit

private long timeLimit

The time limit

initialTime

private long initialTime

The SearchRequest reception date

cursor

private org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry> cursor

The Cursor associated with the searchRequest

Constructor Detail

SearchRequestContainer

public SearchRequestContainer(org.apache.directory.api.ldap.model.message.SearchRequest searchRequest,
                              org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry> cursor)

Create an instance of the container with the SearchRequest and its limit.

Parameters:

searchRequest - The SearchRequest instance

sizeLimit - The size limit

timeLimit - The time limit

Method Detail

getSearchRequest

public org.apache.directory.api.ldap.model.message.SearchRequest getSearchRequest()

Returns:

the searchRequest

getSizeLimit

public long getSizeLimit()

Returns:

the sizeLimit

getCount

public int getCount()

Returns:

the count

isSizeLimitReached

public boolean isSizeLimitReached()

Check the size limit

Returns:

true if we have reached the size limit

increment

public void increment()

Parameters:

count - the count to set

getTimeLimit

public int getTimeLimit()

Returns:

the timeLimit

isTimeLimitReached

public boolean isTimeLimitReached()

Check if we have reached the time limit

Returns:

true if we have reached the time limit

getInitialTime

public long getInitialTime()

Returns:

the initialTime

getCursor

public org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry> getCursor()

Returns:

The cursor associated with the SearchRequest

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()