com.unboundid.ldap.sdk.unboundidds.controls
Class JoinResultControl

java.lang.Object
  extended by com.unboundid.ldap.sdk.Control
      extended by com.unboundid.ldap.sdk.unboundidds.controls.JoinResultControl
All Implemented Interfaces:
DecodeableControl, java.io.Serializable

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class JoinResultControl
extends Control
implements DecodeableControl

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.

The value of the join result control is encoded as follows:
   JoinResult ::= SEQUENCE {
        COMPONENTS OF LDAPResult,
        entries     [4] SEQUENCE OF JoinedEntry }
 

See Also:
Serialized Form

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

JOIN_RESULT_OID

public static final java.lang.String JOIN_RESULT_OID
The OID (1.3.6.1.4.1.30221.2.5.9) for the join result control.

See Also:
Constant Field Values
Constructor Detail

JoinResultControl

public JoinResultControl(java.util.List<JoinedEntry> joinResults)
Creates a new join result control indicating a successful join.

Parameters:
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.

JoinResultControl

public 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.

Parameters:
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.

JoinResultControl

public JoinResultControl(java.lang.String oid,
                         boolean isCritical,
                         ASN1OctetString value)
                  throws LDAPException
Creates a new join result control with the provided information.

Parameters:
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.
Throws:
LDAPException - If the provided control cannot be decoded as an account usable response control.
Method Detail

getResultCode

public ResultCode getResultCode()
Retrieves the result code for this join result.

Returns:
The result code for this join result.

getDiagnosticMessage

public java.lang.String getDiagnosticMessage()
Retrieves the diagnostic message for this join result.

Returns:
The diagnostic message for this join result, or null if there is no diagnostic message.

getMatchedDN

public java.lang.String getMatchedDN()
Retrieves the matched DN for this join result.

Returns:
The matched DN for this join result, or null if there is no matched DN.

getReferralURLs

public java.util.List<java.lang.String> getReferralURLs()
Retrieves the set of referral URLs for this join result.

Returns:
The set of referral URLs for this join result, or an empty list if there are no referral URLs.

getJoinResults

public java.util.List<JoinedEntry> getJoinResults()
Retrieves the set of entries that have been joined with the associated search result entry.

Returns:
The set of entries that have been joined with the associated search result entry.

decodeControl

public JoinResultControl decodeControl(java.lang.String oid,
                                       boolean isCritical,
                                       ASN1OctetString value)
                                throws LDAPException
Creates a new instance of this decodeable control from the provided information.

Specified by:
decodeControl in interface DecodeableControl
Parameters:
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.
Returns:
The decoded representation of this control.
Throws:
LDAPException - If the provided information cannot be decoded as a valid instance of this decodeable control.

get

public static JoinResultControl get(SearchResultEntry entry)
                             throws LDAPException
Extracts a join result control from the provided search result entry.

Parameters:
entry - The search result entry from which to retrieve the join result control.
Returns:
The join result control contained in the provided search result entry, or null if the entry did not contain a join result control.
Throws:
LDAPException - If a problem is encountered while attempting to decode the join result control contained in the provided search result entry.

getControlName

public java.lang.String getControlName()
Retrieves the user-friendly name for this control, if available. If no user-friendly name has been defined, then the OID will be returned.

Overrides:
getControlName in class Control
Returns:
The user-friendly name for this control, or the OID if no user-friendly name is available.

toString

public void toString(java.lang.StringBuilder buffer)
Appends a string representation of this LDAP control to the provided buffer.

Overrides:
toString in class Control
Parameters:
buffer - The buffer to which to append the string representation of this buffer.