org.apache.directory.server.core.api

Class EntryToResponseCursor

java.lang.Object

org.apache.directory.api.ldap.model.cursor.AbstractCursor<org.apache.directory.api.ldap.model.message.Response>

org.apache.directory.server.core.api.EntryToResponseCursor

All Implemented Interfaces:

java.lang.Iterable<org.apache.directory.api.ldap.model.message.Response>, org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.message.Response>, org.apache.directory.api.ldap.model.cursor.SearchCursor

public class EntryToResponseCursor
extends org.apache.directory.api.ldap.model.cursor.AbstractCursor<org.apache.directory.api.ldap.model.message.Response>
implements org.apache.directory.api.ldap.model.cursor.SearchCursor

A cursor to get SearchResponses after setting the underlying cursor's ServerEntry object in SearchResultEnty object

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	done The done flag
private static boolean	IS_DEBUG Speedup for logs
private static org.slf4j.Logger	LOG_CURSOR A dedicated log for cursors
private int	messageId The messsage ID
private org.apache.directory.api.ldap.model.message.SearchResultDone	searchDoneResp a reference to hold the SearchResultDone response
private org.apache.directory.api.ldap.model.message.SearchRequest	searchRequest The search request
private org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry>	wrapped the underlying cursor

Constructor Summary

Constructors

Constructor and Description
EntryToResponseCursor(org.apache.directory.api.ldap.model.message.SearchRequest searchRequest, int messageId, org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry> wrapped)

Method Summary

Modifier and Type	Method and Description
void	after(org.apache.directory.api.ldap.model.message.Response resp)
void	afterLast()
boolean	available()
void	before(org.apache.directory.api.ldap.model.message.Response resp)
void	beforeFirst()
void	close()
void	close(java.lang.Exception e)
boolean	first()
org.apache.directory.api.ldap.model.message.Response	get()
org.apache.directory.api.ldap.model.entry.Entry	getEntry()
org.apache.directory.api.ldap.model.message.IntermediateResponse	getIntermediate()
org.apache.directory.api.ldap.model.message.Referral	getReferral()
org.apache.directory.api.ldap.model.message.SearchResultDone	getSearchResultDone() gives the SearchResultDone message received at the end of search results
boolean	isClosed()
boolean	isDone()
boolean	isEntry()
boolean	isIntermediate()
boolean	isReferral()
java.util.Iterator<org.apache.directory.api.ldap.model.message.Response>	iterator()
boolean	last()
boolean	next()
boolean	previous()
void	setClosureMonitor(org.apache.directory.api.ldap.model.cursor.ClosureMonitor monitor)

Methods inherited from class org.apache.directory.api.ldap.model.cursor.AbstractCursor

checkNotClosed, isAfterLast, isBeforeFirst, isFirst, isLast, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.directory.api.ldap.model.cursor.Cursor

isAfterLast, isBeforeFirst, isFirst, isLast, toString

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

LOG_CURSOR

private static final org.slf4j.Logger LOG_CURSOR

A dedicated log for cursors

IS_DEBUG

private static final boolean IS_DEBUG

Speedup for logs

wrapped

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

the underlying cursor

searchDoneResp

private org.apache.directory.api.ldap.model.message.SearchResultDone searchDoneResp

a reference to hold the SearchResultDone response

done

private boolean done

The done flag

messageId

private int messageId

The messsage ID

searchRequest

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

The search request

Constructor Detail

EntryToResponseCursor

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

Method Detail

iterator

public java.util.Iterator<org.apache.directory.api.ldap.model.message.Response> iterator()

Specified by:

iterator in interface java.lang.Iterable<org.apache.directory.api.ldap.model.message.Response>

Overrides:

iterator in class org.apache.directory.api.ldap.model.cursor.AbstractCursor<org.apache.directory.api.ldap.model.message.Response>

after

public void after(org.apache.directory.api.ldap.model.message.Response resp)
           throws org.apache.directory.api.ldap.model.exception.LdapException,
                  org.apache.directory.api.ldap.model.cursor.CursorException

Specified by:

after in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.message.Response>

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

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

afterLast

public void afterLast()
               throws org.apache.directory.api.ldap.model.exception.LdapException,
                      org.apache.directory.api.ldap.model.cursor.CursorException

Specified by:

afterLast in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.message.Response>

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

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

available

public boolean available()

Specified by:

available in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.message.Response>

before

public void before(org.apache.directory.api.ldap.model.message.Response resp)
            throws org.apache.directory.api.ldap.model.exception.LdapException,
                   org.apache.directory.api.ldap.model.cursor.CursorException

Specified by:

before in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.message.Response>

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

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

beforeFirst

public void beforeFirst()
                 throws org.apache.directory.api.ldap.model.exception.LdapException,
                        org.apache.directory.api.ldap.model.cursor.CursorException

Specified by:

beforeFirst in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.message.Response>

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

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

close

public void close()

Specified by:

close in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.message.Response>

Overrides:

close in class org.apache.directory.api.ldap.model.cursor.AbstractCursor<org.apache.directory.api.ldap.model.message.Response>

close

public void close(java.lang.Exception e)

Specified by:

close in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.message.Response>

Overrides:

close in class org.apache.directory.api.ldap.model.cursor.AbstractCursor<org.apache.directory.api.ldap.model.message.Response>

first

public boolean first()
              throws org.apache.directory.api.ldap.model.exception.LdapException,
                     org.apache.directory.api.ldap.model.cursor.CursorException

Specified by:

first in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.message.Response>

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

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

get

public org.apache.directory.api.ldap.model.message.Response get()
                                                         throws org.apache.directory.api.ldap.model.cursor.CursorException

Specified by:

get in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.message.Response>

Throws:

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

getSearchResultDone

public org.apache.directory.api.ldap.model.message.SearchResultDone getSearchResultDone()

gives the SearchResultDone message received at the end of search results

Specified by:

getSearchResultDone in interface org.apache.directory.api.ldap.model.cursor.SearchCursor

Returns:

the SearchResultDone message, null if the search operation fails for any reason

isClosed

public boolean isClosed()

Specified by:

isClosed in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.message.Response>

Overrides:

isClosed in class org.apache.directory.api.ldap.model.cursor.AbstractCursor<org.apache.directory.api.ldap.model.message.Response>

last

public boolean last()
             throws org.apache.directory.api.ldap.model.exception.LdapException,
                    org.apache.directory.api.ldap.model.cursor.CursorException

Specified by:

last in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.message.Response>

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

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

next

public boolean next()
             throws org.apache.directory.api.ldap.model.exception.LdapException,
                    org.apache.directory.api.ldap.model.cursor.CursorException

Specified by:

next in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.message.Response>

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

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

previous

public boolean previous()
                 throws org.apache.directory.api.ldap.model.exception.LdapException,
                        org.apache.directory.api.ldap.model.cursor.CursorException

Specified by:

previous in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.message.Response>

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

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

setClosureMonitor

public void setClosureMonitor(org.apache.directory.api.ldap.model.cursor.ClosureMonitor monitor)

Specified by:

setClosureMonitor in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.message.Response>

Overrides:

setClosureMonitor in class org.apache.directory.api.ldap.model.cursor.AbstractCursor<org.apache.directory.api.ldap.model.message.Response>

isDone

public boolean isDone()

Specified by:

isDone in interface org.apache.directory.api.ldap.model.cursor.SearchCursor

isReferral

public boolean isReferral()

Specified by:

isReferral in interface org.apache.directory.api.ldap.model.cursor.SearchCursor

getReferral

public org.apache.directory.api.ldap.model.message.Referral getReferral()
                                                                 throws org.apache.directory.api.ldap.model.exception.LdapException

Specified by:

getReferral in interface org.apache.directory.api.ldap.model.cursor.SearchCursor

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

isEntry

public boolean isEntry()

Specified by:

isEntry in interface org.apache.directory.api.ldap.model.cursor.SearchCursor

getEntry

public org.apache.directory.api.ldap.model.entry.Entry getEntry()
                                                         throws org.apache.directory.api.ldap.model.exception.LdapException

Specified by:

getEntry in interface org.apache.directory.api.ldap.model.cursor.SearchCursor

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

isIntermediate

public boolean isIntermediate()

Specified by:

isIntermediate in interface org.apache.directory.api.ldap.model.cursor.SearchCursor

getIntermediate

public org.apache.directory.api.ldap.model.message.IntermediateResponse getIntermediate()
                                                                                 throws org.apache.directory.api.ldap.model.exception.LdapException

Specified by:

getIntermediate in interface org.apache.directory.api.ldap.model.cursor.SearchCursor

Throws:

org.apache.directory.api.ldap.model.exception.LdapException