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.
  • Field Details

    • ENCODE_CNTRL_CHARS

      static final boolean ENCODE_CNTRL_CHARS
      Whether 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 is ResultCode.SUCCESS.
      Returns:
      whether this result is success
    • getEncodedDiagnosticMessage

      default String getEncodedDiagnosticMessage()
      Returns the diagnostic message percent encoded if ENCODE_CNTRL_CHARS is true. See LdapUtils.percentEncodeControlChars(String).
      Returns:
      encoded message