Package org.ldaptive

Class AbstractResult

java.lang.Object
org.ldaptive.AbstractMessage
org.ldaptive.AbstractResult
All Implemented Interfaces:
Message, Result
Direct Known Subclasses:
AddResponse, AuthenticationHandlerResponse, AuthenticationResponse, BindResponse, CompareResponse, DeleteResponse, ExtendedResponse, ModifyDnResponse, ModifyResponse, SearchResponse
public abstract class AbstractResult extends AbstractMessage implements Result
LDAP result message defined as: 
   LDAPResult ::= SEQUENCE {
     resultCode         ENUMERATED {
       ...  },
     matchedDN          LDAPDN,
     diagnosticMessage  LDAPString,
     referral           [3] Referral OPTIONAL }

   Referral ::= SEQUENCE SIZE (1..MAX) OF uri URI

     URI ::= LDAPString     -- limited to characters permitted in
                            -- URIs

  • Field Details

    • resultCode

      private ResultCode resultCode
      Result code.

    • matchedDN

      private String matchedDN
      Matched DN.

    • diagnosticMessage

      private String diagnosticMessage
      Diagnostic message.

    • referralURLs

      private List<String> referralURLs
      Referral URLS.

  • Constructor Details

    • AbstractResult

      public AbstractResult()

  • Method Details

    • getResultCode

      public ResultCode getResultCode()
      Description copied from interface: Result
      Returns the result code.
      Specified by:
      getResultCode in interface Result
      Returns:
      result code

    • setResultCode

      public void setResultCode(ResultCode code)

    • getMatchedDN

      public String getMatchedDN()
      Description copied from interface: Result
      Returns the matched DN.
      Specified by:
      getMatchedDN in interface Result
      Returns:
      matched DN

    • setMatchedDN

      public void setMatchedDN(String dn)

    • getDiagnosticMessage

      public String getDiagnosticMessage()
      Description copied from interface: Result
      Returns the diagnostic message.
      Specified by:
      getDiagnosticMessage in interface Result
      Returns:
      diagnostic message

    • setDiagnosticMessage

      public void setDiagnosticMessage(String message)

    • getReferralURLs

      public String[] getReferralURLs()
      Description copied from interface: Result
      Returns the referral URLs.
      Specified by:
      getReferralURLs in interface Result
      Returns:
      referral URLs

    • addReferralURLs

      public void addReferralURLs(String... urls)
      Adds referral URLs to the result.
      Parameters:
      urls - to add

    • copyValues

      protected <T extends Result> void copyValues(T result)
      Copies the property values from the supplied result to this result.
      Type Parameters:
      T - type of result
      Parameters:
      result - to copy from

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class AbstractMessage

    • toString

      public String toString()
      Overrides:
      toString in class AbstractMessage