|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.Control
com.unboundid.ldap.sdk.unboundidds.controls.JoinResultControl
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class JoinResultControl
NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.This class provides an implementation of a control that may be included in a search result entry in response to a join request control to provide a set of entries related to the search result entry. See the class-level documentation for the
JoinRequestControl
class for additional
information and an example demonstrating its use.
JoinResult ::= SEQUENCE { COMPONENTS OF LDAPResult, entries [4] SEQUENCE OF JoinedEntry }
Field Summary | |
---|---|
static java.lang.String |
JOIN_RESULT_OID
The OID (1.3.6.1.4.1.30221.2.5.9) for the join result control. |
Constructor Summary | |
---|---|
JoinResultControl(java.util.List<JoinedEntry> joinResults)
Creates a new join result control indicating a successful join. |
|
JoinResultControl(ResultCode resultCode,
java.lang.String diagnosticMessage,
java.lang.String matchedDN,
java.util.List<java.lang.String> referralURLs,
java.util.List<JoinedEntry> joinResults)
Creates a new join result control with the provided information. |
|
JoinResultControl(java.lang.String oid,
boolean isCritical,
ASN1OctetString value)
Creates a new join result control with the provided information. |
Method Summary | |
---|---|
JoinResultControl |
decodeControl(java.lang.String oid,
boolean isCritical,
ASN1OctetString value)
Creates a new instance of this decodeable control from the provided information. |
static JoinResultControl |
get(SearchResultEntry entry)
Extracts a join result control from the provided search result entry. |
java.lang.String |
getControlName()
Retrieves the user-friendly name for this control, if available. |
java.lang.String |
getDiagnosticMessage()
Retrieves the diagnostic message for this join result. |
java.util.List<JoinedEntry> |
getJoinResults()
Retrieves the set of entries that have been joined with the associated search result entry. |
java.lang.String |
getMatchedDN()
Retrieves the matched DN for this join result. |
java.util.List<java.lang.String> |
getReferralURLs()
Retrieves the set of referral URLs for this join result. |
ResultCode |
getResultCode()
Retrieves the result code for this join result. |
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this LDAP control to the provided buffer. |
Methods inherited from class com.unboundid.ldap.sdk.Control |
---|
decode, decode, decodeControls, deregisterDecodeableControl, encode, encodeControls, equals, getOID, getValue, hashCode, hasValue, isCritical, readFrom, registerDecodeableControl, toString, writeTo |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String JOIN_RESULT_OID
Constructor Detail |
---|
public JoinResultControl(java.util.List<JoinedEntry> joinResults)
joinResults
- The set of entries that have been joined with the
associated search result entry. It may be
null
or empty if no entries were joined with
the search result entry.public JoinResultControl(ResultCode resultCode, java.lang.String diagnosticMessage, java.lang.String matchedDN, java.util.List<java.lang.String> referralURLs, java.util.List<JoinedEntry> joinResults)
resultCode
- The result code for the join processing. It
must not be null
.diagnosticMessage
- A message with additional information about the
result of the join processing. It may be
null
if no message is needed.matchedDN
- The matched DN for the join processing. It may
be null
if no matched DN is needed.referralURLs
- The set of referral URLs for any referrals
encountered while processing the join. It may
be null
or empty if no referral URLs
are needed.joinResults
- The set of entries that have been joined with
associated search result entry. It may be
null
or empty if no entries were joined
with the search result entry.public JoinResultControl(java.lang.String oid, boolean isCritical, ASN1OctetString value) throws LDAPException
oid
- The OID for the control.isCritical
- Indicates whether the control should be marked
critical.value
- The encoded value for the control. This may be
null
if no value was provided.
LDAPException
- If the provided control cannot be decoded as an
account usable response control.Method Detail |
---|
public ResultCode getResultCode()
public java.lang.String getDiagnosticMessage()
null
if
there is no diagnostic message.public java.lang.String getMatchedDN()
null
if there is
no matched DN.public java.util.List<java.lang.String> getReferralURLs()
public java.util.List<JoinedEntry> getJoinResults()
public JoinResultControl decodeControl(java.lang.String oid, boolean isCritical, ASN1OctetString value) throws LDAPException
decodeControl
in interface DecodeableControl
oid
- The OID for the control.isCritical
- Indicates whether the control should be marked
critical.value
- The encoded value for the control. This may be
null
if no value was provided.
LDAPException
- If the provided information cannot be decoded as a
valid instance of this decodeable control.public static JoinResultControl get(SearchResultEntry entry) throws LDAPException
entry
- The search result entry from which to retrieve the join
result control.
null
if the entry did not contain a join result
control.
LDAPException
- If a problem is encountered while attempting to
decode the join result control contained in the
provided search result entry.public java.lang.String getControlName()
getControlName
in class Control
public void toString(java.lang.StringBuilder buffer)
toString
in class Control
buffer
- The buffer to which to append the string representation of
this buffer.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |