com.unboundid.ldap.sdk

Class SearchResultReferenceEntrySourceException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.unboundid.util.LDAPSDKException

com.unboundid.ldap.sdk.EntrySourceException

com.unboundid.ldap.sdk.SearchResultReferenceEntrySourceException

All Implemented Interfaces:

java.io.Serializable

@NotMutable
 @ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class SearchResultReferenceEntrySourceException
extends EntrySourceException

This class defines an exception that may be thrown if a search result reference is received from the directory server while using the EntrySource API (e.g., an LDAPEntrySource object).

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SearchResultReferenceEntrySourceException(SearchResultReference searchReference) Creates a new search result reference entry source exception with the provided search result reference.

Method Summary

Modifier and Type	Method and Description
SearchResultReference	getSearchReference() Retrieves the search result reference for this entry source exception.
void	toString(java.lang.StringBuilder buffer) Appends a string representation of this exception to the provided buffer.

Methods inherited from class com.unboundid.ldap.sdk.EntrySourceException

mayContinueReading

Methods inherited from class com.unboundid.util.LDAPSDKException

getExceptionMessage, getExceptionMessage, toString

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchResultReferenceEntrySourceException

public SearchResultReferenceEntrySourceException(@NotNull
                                                 SearchResultReference searchReference)

Creates a new search result reference entry source exception with the provided search result reference.

Parameters:

searchReference - The search result reference returned by the directory server. It must not be null.

Method Detail

getSearchReference

@NotNull
public SearchResultReference getSearchReference()

Retrieves the search result reference for this entry source exception.

Returns:

The search result reference for this entry source exception.

toString

public void toString(@NotNull
                     java.lang.StringBuilder buffer)

Appends a string representation of this exception to the provided buffer.

Overrides:

toString in class EntrySourceException

Parameters:

buffer - The buffer to which the string representation of this exception is to be appended.