org.ldaptive.ad.control.util

Class NotificationClient.NotificationItem

java.lang.Object

org.ldaptive.ad.control.util.NotificationClient.NotificationItem

Enclosing class:

NotificationClient

public static class NotificationClient.NotificationItem
extends Object

Contains data returned when using the notification control.

Field Summary

Fields

Modifier and Type	Field and Description
private AsyncRequest	asyncRequest Async request from the search operation.
private SearchEntry	searchEntry Entry contained in this notification item.
private Exception	searchException Exception thrown by the search operation.
private Response	searchResponse Response contained in this notification item.

Constructor Summary

Constructors

Constructor and Description
NotificationItem(AsyncRequest request) Creates a new notification item.
NotificationItem(Exception exception) Creates a new notification item.
NotificationItem(Response response) Creates a new notification item.
NotificationItem(SearchEntry entry) Creates a new notification 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.
SearchEntry	getEntry() Returns the search entry contained in this item or null if this item does not contain a search entry.
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.
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.

searchEntry

private final SearchEntry searchEntry

Entry contained in this notification item.

searchResponse

private final Response searchResponse

Response contained in this notification item.

searchException

private final Exception searchException

Exception thrown by the search operation.

Constructor Detail

NotificationItem

public NotificationItem(AsyncRequest request)

Creates a new notification item.

Parameters:

request - that represents this item

NotificationItem

public NotificationItem(SearchEntry entry)

Creates a new notification item.

Parameters:

entry - that represents this item

NotificationItem

public NotificationItem(Response response)

Creates a new notification item.

Parameters:

response - that represents this item

NotificationItem

public NotificationItem(Exception exception)

Creates a new notification 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 SearchEntry getEntry()

Returns the search entry contained in this item or null if this item does not contain a search 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 Exception getException()

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

Returns:

exception

toString

public String toString()

Overrides:

toString in class Object