|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.SearchResultReference
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class SearchResultReference
This class provides a data structure for representing an LDAP search result reference. A search result reference consists of a set of referral URLs and may also include zero or more controls. It describes an alternate location in which additional results for the search may be found. If there are multiple referral URLs, then they should all be considered equivalent ways to access the information (e.g., referrals referencing different servers that may be contacted).
Field Summary |
---|
Fields inherited from interface com.unboundid.ldap.protocol.LDAPResponse |
---|
NO_CONTROLS |
Constructor Summary | |
---|---|
SearchResultReference(int messageID,
java.lang.String[] referralURLs,
Control[] controls)
Creates a new search result reference with the provided information. |
|
SearchResultReference(java.lang.String[] referralURLs,
Control[] controls)
Creates a new search result reference with the provided information. |
Method Summary | |
---|---|
Control |
getControl(java.lang.String oid)
Retrieves the control with the specified OID. |
Control[] |
getControls()
Retrieves the set of controls returned with this search result reference. |
int |
getMessageID()
Retrieves the message ID for the LDAP message containing this response. |
java.lang.String[] |
getReferralURLs()
Retrieves the set of referral URLs for this search result reference. |
java.lang.String |
toString()
Retrieves a string representation of this search result reference. |
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this search result reference to the provided buffer. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public SearchResultReference(java.lang.String[] referralURLs, Control[] controls)
referralURLs
- The set of referral URLs for this search result
reference. It must not be null
.controls
- The set of controls returned with this search result
reference. It must not be null
.public SearchResultReference(int messageID, java.lang.String[] referralURLs, Control[] controls)
messageID
- The message ID for the LDAP message containing this
response.referralURLs
- The set of referral URLs for this search result
reference. It must not be null
.controls
- The set of controls returned with this search result
reference. It must not be null
.Method Detail |
---|
public int getMessageID()
getMessageID
in interface LDAPResponse
public java.lang.String[] getReferralURLs()
public Control[] getControls()
get
method in the response control class.
public Control getControl(java.lang.String oid)
oid
- The OID of the control to retrieve.
null
if there is no
such control for this search result reference.public java.lang.String toString()
toString
in class java.lang.Object
public void toString(java.lang.StringBuilder buffer)
toString
in interface LDAPResponse
buffer
- The buffer to which to append the string representation of
this search result reference.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |