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
LDAP protocol result.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final boolean
Whether to encode control characters. -
Method Summary
Modifier and TypeMethodDescriptionReturns the diagnostic message.default String
Returns the diagnostic message percent encoded ifENCODE_CNTRL_CHARS
is true.Returns the matched DN.String[]
Returns the referral URLs.Returns the result code.default boolean
Returns whether the result code in this result isResultCode.SUCCESS
.Methods inherited from interface org.ldaptive.Message
getControl, getControls, getMessageID
-
Field Details
-
ENCODE_CNTRL_CHARS
static final boolean ENCODE_CNTRL_CHARSWhether to encode control characters.
-
-
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 isResultCode.SUCCESS
.- Returns:
- whether this result is success
-
getEncodedDiagnosticMessage
Returns the diagnostic message percent encoded ifENCODE_CNTRL_CHARS
is true. SeeLdapUtils.percentEncodeControlChars(String)
.- Returns:
- encoded message
-