org.apache.directory.server.ldap.handlers

Class SearchTimeLimitingMonitor

java.lang.Object

org.apache.directory.server.ldap.handlers.SearchTimeLimitingMonitor

All Implemented Interfaces:

org.apache.directory.api.ldap.model.cursor.ClosureMonitor

public class SearchTimeLimitingMonitor
extends Object
implements org.apache.directory.api.ldap.model.cursor.ClosureMonitor

A ClosureMonitor implementation which takes into account a time limit.

Author:

Apache Directory Project

Constructor Summary

Constructors

Constructor and Description
SearchTimeLimitingMonitor(long timeToLive, TimeUnit unit) Creates a new instance of SearchTimeLimitingMonitor.

Method Summary

Modifier and Type	Method and Description
void	checkNotClosed()
void	close()
void	close(Exception cause)
void	close(String cause)
Exception	getCause()
boolean	isClosed()

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchTimeLimitingMonitor

public SearchTimeLimitingMonitor(long timeToLive,
                                 TimeUnit unit)

Creates a new instance of SearchTimeLimitingMonitor.

Parameters:

timeToLive - the time before changing state to closed.

unit - the time units for the timeToLive parameter

See Also:

TimeUnit

Method Detail

checkNotClosed

public void checkNotClosed()
                    throws org.apache.directory.api.ldap.model.cursor.CursorClosedException

Specified by:

checkNotClosed in interface org.apache.directory.api.ldap.model.cursor.ClosureMonitor

Throws:

org.apache.directory.api.ldap.model.cursor.CursorClosedException

close

public void close()

Specified by:

close in interface org.apache.directory.api.ldap.model.cursor.ClosureMonitor

close

public void close(String cause)

Specified by:

close in interface org.apache.directory.api.ldap.model.cursor.ClosureMonitor

close

public void close(Exception cause)

Specified by:

close in interface org.apache.directory.api.ldap.model.cursor.ClosureMonitor

getCause

public Exception getCause()

Specified by:

getCause in interface org.apache.directory.api.ldap.model.cursor.ClosureMonitor

isClosed

public boolean isClosed()

Specified by:

isClosed in interface org.apache.directory.api.ldap.model.cursor.ClosureMonitor