org.ldaptive.control.util

Class PersistentSearchItem

java.lang.Object

org.ldaptive.control.util.PersistentSearchItem

public class PersistentSearchItem
extends java.lang.Object

Contains data returned when using the persistent search request control.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PersistentSearchItem.Entry Wrapper class that provides easy access to the EntryChangeNotificationControl contained in a search entry.

Field Summary

Fields

Modifier and Type	Field and Description
private AsyncRequest	asyncRequest Async request from the search operation.
private PersistentSearchItem.Entry	persistentSearchEntry Entry contained in this persistent search item.
private java.lang.Exception	persistentSearchException Exception thrown by the search operation.
private Response	persistentSearchResponse Response contained in this persistent search item.

Constructor Summary

Constructors

Constructor and Description
PersistentSearchItem(AsyncRequest request) Creates a new persistent search item.
PersistentSearchItem(java.lang.Exception exception) Creates a new persistent search item.
PersistentSearchItem(PersistentSearchItem.Entry entry) Creates a new persistent search item.
PersistentSearchItem(Response response) Creates a new persistent search item.

Method Summary

Modifier and Type	Method and Description
AsyncRequest	getAsyncRequest() Returns the async request contained in this item or null if this item does not contain an async request.
PersistentSearchItem.Entry	getEntry() Returns the entry contained in this item or null if this item does not contain an entry.
java.lang.Exception	getException() Returns the exception contained in this item or null if this item does not contain an exception.
Response	getResponse() Returns the response contained in this item or null if this item does not contain a response.
boolean	isAsyncRequest() Returns whether this item represents an async request.
boolean	isEntry() Returns whether this item represents a search entry.
boolean	isException() Returns whether this item represents an exception.
boolean	isResponse() Returns whether this item represents a response.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

asyncRequest

private final AsyncRequest asyncRequest

Async request from the search operation.

persistentSearchEntry

private final PersistentSearchItem.Entry persistentSearchEntry

Entry contained in this persistent search item.

persistentSearchResponse

private final Response persistentSearchResponse

Response contained in this persistent search item.

persistentSearchException

private final java.lang.Exception persistentSearchException

Exception thrown by the search operation.

Constructor Detail

PersistentSearchItem

public PersistentSearchItem(AsyncRequest request)

Creates a new persistent search item.

Parameters:

request - that represents this item

PersistentSearchItem

public PersistentSearchItem(PersistentSearchItem.Entry entry)

Creates a new persistent search item.

Parameters:

entry - that represents this item

PersistentSearchItem

public PersistentSearchItem(Response response)

Creates a new persistent search item.

Parameters:

response - that represents this item

PersistentSearchItem

public PersistentSearchItem(java.lang.Exception exception)

Creates a new persistent search item.

Parameters:

exception - that represents this item

Method Detail

isAsyncRequest

public boolean isAsyncRequest()

Returns whether this item represents an async request.

Returns:

whether this item represents an async request

getAsyncRequest

public AsyncRequest getAsyncRequest()

Returns the async request contained in this item or null if this item does not contain an async request.

Returns:

async request

isEntry

public boolean isEntry()

Returns whether this item represents a search entry.

Returns:

whether this item represents a search entry

getEntry

public PersistentSearchItem.Entry getEntry()

Returns the entry contained in this item or null if this item does not contain an entry.

Returns:

search entry

isResponse

public boolean isResponse()

Returns whether this item represents a response.

Returns:

whether this item represents a response

getResponse

public Response getResponse()

Returns the response contained in this item or null if this item does not contain a response.

Returns:

response

isException

public boolean isException()

Returns whether this item represents an exception.

Returns:

whether this item represents an exception

getException

public java.lang.Exception getException()

Returns the exception contained in this item or null if this item does not contain an exception.

Returns:

exception

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object