|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.lang.Throwable
java.lang.Exception
com.unboundid.util.LDAPSDKException
com.unboundid.ldap.sdk.LDAPException
com.unboundid.ldap.sdk.LDAPSearchException
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class LDAPSearchException
This class defines an exception that can be thrown if a problem occurs while
performing LDAP-related processing. It includes all of the elements of the
SearchResult
object, potentially including entries and references
returned before the failure result.
Field Summary |
---|
Fields inherited from class com.unboundid.ldap.sdk.LDAPException |
---|
NO_CONTROLS, NO_REFERRALS |
Constructor Summary | |
---|---|
LDAPSearchException(LDAPException ldapException)
Creates a new LDAP search exception from the provided exception. |
|
LDAPSearchException(ResultCode resultCode,
java.lang.String errorMessage)
Creates a new LDAP search exception with the provided information. |
|
LDAPSearchException(ResultCode resultCode,
java.lang.String errorMessage,
java.lang.Throwable cause)
Creates a new LDAP search exception with the provided information. |
|
LDAPSearchException(SearchResult searchResult)
Creates a new LDAP search exception with the provided result. |
Method Summary | |
---|---|
int |
getEntryCount()
Retrieves the number of matching entries returned for the search operation before this exception was thrown. |
int |
getReferenceCount()
Retrieves the number of search references returned for the search operation before this exception was thrown. |
java.util.List<SearchResultEntry> |
getSearchEntries()
Retrieves a list containing the matching entries returned from the search operation before this exception was thrown. |
java.util.List<SearchResultReference> |
getSearchReferences()
Retrieves a list containing the search references returned from the search operation before this exception was thrown. |
SearchResult |
getSearchResult()
Retrieves the search result object associated with this LDAP search exception. |
SearchResult |
toLDAPResult()
Creates a new SearchResult object from this exception. |
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this LDAP exception to the provided buffer. |
Methods inherited from class com.unboundid.ldap.sdk.LDAPException |
---|
getDiagnosticMessage, getExceptionMessage, getMatchedDN, getReferralURLs, getResponseControl, getResponseControls, getResultCode, getResultString, hasResponseControl, hasResponseControl |
Methods inherited from class com.unboundid.util.LDAPSDKException |
---|
toString |
Methods inherited from class java.lang.Throwable |
---|
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public LDAPSearchException(ResultCode resultCode, java.lang.String errorMessage)
resultCode
- The result code for this LDAP search exception.errorMessage
- The error message for this LDAP search exception.public LDAPSearchException(ResultCode resultCode, java.lang.String errorMessage, java.lang.Throwable cause)
resultCode
- The result code for this LDAP search exception.errorMessage
- The error message for this LDAP search exception.cause
- The underlying exception that triggered this LDAP
search exception.public LDAPSearchException(LDAPException ldapException)
ldapException
- The LDAP exception with the information to include
in this LDAP search exception.public LDAPSearchException(SearchResult searchResult)
searchResult
- The search result to use to create this LDAP search
exception.Method Detail |
---|
public SearchResult getSearchResult()
public int getEntryCount()
public int getReferenceCount()
public java.util.List<SearchResultEntry> getSearchEntries()
SearchResultListener
was not used during the search.
null
if a
SearchResultListener
was used during the search.public java.util.List<SearchResultReference> getSearchReferences()
SearchResultListener
was not used during the search.
null
if a
SearchResultListener
was used during the search.public SearchResult toLDAPResult()
SearchResult
object from this exception.
toLDAPResult
in class LDAPException
SearchResult
object created from this exception.public void toString(java.lang.StringBuilder buffer)
toString
in class LDAPException
buffer
- The buffer to which to append a string representation of
this LDAP exception.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |