Package org.ldaptive
Class SearchResponse
java.lang.Object
org.ldaptive.AbstractMessage
org.ldaptive.AbstractResult
org.ldaptive.SearchResponse
Response that encapsulates the result elements of a search request. This class formally decodes the SearchResultDone
LDAP message defined as:
SearchResultDone ::= [APPLICATION 5] LDAPResult
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class org.ldaptive.AbstractResult
AbstractResult.AbstractBuilder<B,
T extends AbstractResult>, AbstractResult.DiagnosticMessageHandler, AbstractResult.MatchedDNHandler, AbstractResult.ReferralHandler, AbstractResult.ResultCodeHandler Nested classes/interfaces inherited from class org.ldaptive.AbstractMessage
AbstractMessage.ControlParser, AbstractMessage.ControlsHandler, AbstractMessage.MessageIDHandler
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final DERPath
DER path to diagnostic message.private static final int
hash code seed.private static final DERPath
DER path to matched DN.static final int
BER protocol number.private static final DERPath
DER path to referral.private static final DERPath
DER path to result code.Entries contained in this result.private final Set
<SearchResultReference> Search result references contained in this result.Fields inherited from interface org.ldaptive.Result
ENCODE_CNTRL_CHARS
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor.SearchResponse
(DERBuffer buffer) Creates a new search result done. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addEntries
(Collection<LdapEntry> entries) Adds entry(s) to this search result.void
addEntries
(LdapEntry... entry) Adds an entry to this search result.void
addReferences
(Collection<SearchResultReference> references) Adds references(s) to this search result.void
addReferences
(SearchResultReference... reference) Adds a reference to this search result.static SearchResponse.Builder
builder()
Creates a builder for this class.int
Returns the number of entries in this search result.boolean
Returns a collection of ldap entry.getEntry()
Returns a single entry of this result.Returns the ldap in this result with the supplied DN.Returns the entry DNs in this result.Returns a single search reference of this result.Returns a collection of ldap entry.int
hashCode()
Returns the hash code for this object.void
initialize
(SearchResponse result) Copies the values of the supplied search result done to this synthetic result.static SearchResponse
merge
(SearchResponse result) Merges the entries in the supplied result into a single entry.int
Returns the number of references in this search result.static SearchResponse
sort
(SearchResponse sr) Returns a new response whose entries are sorted naturally by DN.subResult
(int fromIndex, int toIndex) Returns a portion of this result between the specified fromIndex, inclusive, and toIndex, exclusive.toString()
Methods inherited from class org.ldaptive.AbstractResult
addReferralURLs, copyValues, getDiagnosticMessage, getMatchedDN, getReferralURLs, getResultCode, setDiagnosticMessage, setMatchedDN, setResultCode
Methods inherited from class org.ldaptive.AbstractMessage
addControls, copyValues, getControls, getMessageID, setMessageID
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.ldaptive.Message
getControl, getControls, getMessageID
Methods inherited from interface org.ldaptive.Result
getEncodedDiagnosticMessage, isSuccess
-
Field Details
-
PROTOCOL_OP
public static final int PROTOCOL_OPBER protocol number.- See Also:
-
HASH_CODE_SEED
private static final int HASH_CODE_SEEDhash code seed.- See Also:
-
RESULT_CODE_PATH
DER path to result code. -
MATCHED_DN_PATH
DER path to matched DN. -
DIAGNOSTIC_MESSAGE_PATH
DER path to diagnostic message. -
REFERRAL_PATH
DER path to referral. -
resultEntries
Entries contained in this result. -
resultReferences
Search result references contained in this result.
-
-
Constructor Details
-
SearchResponse
public SearchResponse()Default constructor. -
SearchResponse
Creates a new search result done.- Parameters:
buffer
- to decode
-
-
Method Details
-
initialize
Copies the values of the supplied search result done to this synthetic result.- Parameters:
result
- of values to copy
-
getEntries
Returns a collection of ldap entry.- Returns:
- collection of ldap entry
-
getEntry
Returns a single entry of this result. If multiple entries exist the first entry returned by the underlying iterator is used. If no entries exist null is returned.- Returns:
- search result entry
-
getEntry
Returns the ldap in this result with the supplied DN.- Parameters:
dn
- of the entry to return- Returns:
- search result entry
-
getEntryDns
Returns the entry DNs in this result.- Returns:
- string array of entry DNs
-
addEntries
Adds an entry to this search result.- Parameters:
entry
- entry to add
-
addEntries
Adds entry(s) to this search result.- Parameters:
entries
- collection of entries to add
-
entrySize
public int entrySize()Returns the number of entries in this search result.- Returns:
- number of entries in this search result
-
getReferences
Returns a collection of ldap entry.- Returns:
- collection of ldap entry
-
getReference
Returns a single search reference of this result. If multiple references exist the first references returned by the underlying iterator is used. If no references exist null is returned.- Returns:
- search result references
-
addReferences
Adds a reference to this search result.- Parameters:
reference
- reference to add
-
addReferences
Adds references(s) to this search result.- Parameters:
references
- collection of references to add
-
referenceSize
public int referenceSize()Returns the number of references in this search result.- Returns:
- number of references in this search result
-
subResult
Returns a portion of this result between the specified fromIndex, inclusive, and toIndex, exclusive. If fromIndex and toIndex are equal, the return result is empty. The result of this method is undefined for unordered results.- Parameters:
fromIndex
- low endpoint of the search result (inclusive)toIndex
- high endpoint of the search result (exclusive)- Returns:
- portion of this search result
- Throws:
IndexOutOfBoundsException
- for illegal index values
-
equals
- Overrides:
equals
in classAbstractResult
-
hashCode
public int hashCode()Description copied from class:AbstractMessage
Returns the hash code for this object.- Specified by:
hashCode
in classAbstractMessage
- Returns:
- hash code
-
toString
- Overrides:
toString
in classAbstractResult
-
sort
Returns a new response whose entries are sorted naturally by DN. Each attribute and each attribute value are also sorted. SeeLdapEntry.sort(LdapEntry)
andLdapAttribute.sort(LdapAttribute)
.- Parameters:
sr
- response to sort- Returns:
- sorted response
-
merge
Merges the entries in the supplied result into a single entry. This method always returns a search result of size zero or one.- Parameters:
result
- search result containing entries to merge- Returns:
- search result containing a single merged entry
-
builder
Creates a builder for this class.- Returns:
- new builder
-