org.ldaptive.control.util

Class SyncReplItem

java.lang.Object

org.ldaptive.control.util.SyncReplItem

public class SyncReplItem
extends java.lang.Object

Contains data returned when using the sync repl search control.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SyncReplItem.Entry Wrapper class that provides easy access to the SyncStateControl contained in a search entry.
static class	SyncReplItem.Response Wrapper class that provides easy access to the SyncDoneControl contained in a response.

Field Summary

Fields

Modifier and Type	Field and Description
private AsyncRequest	asyncRequest Async request from the search operation.
private SyncInfoMessage	syncInfoMessage Message contained in this sync repl item.
private SyncReplItem.Entry	syncReplEntry Entry contained in this sync repl item.
private java.lang.Exception	syncReplException Exception thrown by the search operation.
private SyncReplItem.Response	syncReplResponse Response contained in this sync repl item.

Constructor Summary

Constructors

Constructor and Description
SyncReplItem(AsyncRequest request) Creates a new sync repl item.
SyncReplItem(java.lang.Exception exception) Creates a new sync repl item.
SyncReplItem(SyncInfoMessage message) Creates a new sync repl item.
SyncReplItem(SyncReplItem.Entry entry) Creates a new sync repl item.
SyncReplItem(SyncReplItem.Response response) Creates a new sync repl 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.
SyncReplItem.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.
SyncInfoMessage	getMessage() Returns the intermediate message contained in this item or null if this item does not contain a message.
SyncReplItem.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	isMessage() Returns whether this item represents an intermediate message.
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.

syncReplEntry

private final SyncReplItem.Entry syncReplEntry

Entry contained in this sync repl item.

syncInfoMessage

private final SyncInfoMessage syncInfoMessage

Message contained in this sync repl item.

syncReplResponse

private final SyncReplItem.Response syncReplResponse

Response contained in this sync repl item.

syncReplException

private final java.lang.Exception syncReplException

Exception thrown by the search operation.

Constructor Detail

SyncReplItem

public SyncReplItem(AsyncRequest request)

Creates a new sync repl item.

Parameters:

request - that represents this item

SyncReplItem

public SyncReplItem(SyncReplItem.Entry entry)

Creates a new sync repl item.

Parameters:

entry - that represents this item

SyncReplItem

public SyncReplItem(SyncInfoMessage message)

Creates a new sync repl item.

Parameters:

message - that represents this item

SyncReplItem

public SyncReplItem(SyncReplItem.Response response)

Creates a new sync repl item.

Parameters:

response - that represents this item

SyncReplItem

public SyncReplItem(java.lang.Exception exception)

Creates a new sync repl 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 SyncReplItem.Entry getEntry()

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

Returns:

sync repl entry

isMessage

public boolean isMessage()

Returns whether this item represents an intermediate message.

Returns:

whether this item represents an intermediate message

getMessage

public SyncInfoMessage getMessage()

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

Returns:

sync info message

isResponse

public boolean isResponse()

Returns whether this item represents a response.

Returns:

whether this item represents a response

getResponse

public SyncReplItem.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