Package org.ldaptive

Interface Result

All Superinterfaces:

Message

All Known Implementing Classes:

AbstractResult, AddResponse, AuthenticationHandlerResponse, AuthenticationResponse, BindResponse, CompareResponse, DeleteResponse, ExtendedResponse, ModifyDnResponse, ModifyResponse, NoticeOfDisconnection, SearchResponse, UnsolicitedNotification

public interface Result
extends Message

LDAP protocol result.

Method Summary

Modifier and Type	Method	Description
String	getDiagnosticMessage()	Returns the diagnostic message.
default String	getEncodedDiagnosticMessage()	Returns the diagnostic message with special characters encoded.
String	getMatchedDN()	Returns the matched DN.
String[]	getReferralURLs()	Returns the referral URLs.
ResultCode	getResultCode()	Returns the result code.
default boolean	isSuccess()	Returns whether the result code in this result is ResultCode.SUCCESS.

Methods inherited from interface org.ldaptive.Message

getControl, getControls, getMessageID

Method Details

getResultCode

ResultCode getResultCode()

Returns the result code.

Returns:

result code

getMatchedDN

String getMatchedDN()

Returns the matched DN.

Returns:

matched DN

getDiagnosticMessage

String getDiagnosticMessage()

Returns the diagnostic message.

Returns:

diagnostic message

getReferralURLs

String[] getReferralURLs()

Returns the referral URLs.

Returns:

referral URLs

isSuccess

default boolean isSuccess()

Returns whether the result code in this result is ResultCode.SUCCESS.

Returns:

whether this result is success

getEncodedDiagnosticMessage

default String getEncodedDiagnosticMessage()

Returns the diagnostic message with special characters encoded. See LdapUtils.percentEncodeControlChars(String).

Returns:

encoded message