|
|||||||||
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.JoinRequestControl
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class JoinRequestControl
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 an LDAP control which can be included in a search request to indicate that search result entries should be returned along with related entries based on a given set of criteria, much like an SQL join in a relational database.
SearchRequest searchRequest = new SearchRequest( "ou=People,dc=example,dc=com", SearchScope.SUB, Filter.createEqualityFilter("uid", userID)); searchRequest.addControl(new JoinRequestControl(new JoinRequestValue( JoinRule.createEqualityJoin("accountNumber", "accountNumber", false), JoinBaseDN.createUseCustomBaseDN("ou=Accounts,dc=example,dc=com"), SearchScope.SUB, DereferencePolicy.NEVER, null, Filter.createEqualityFilter("objectClass", "accountEntry"), new String[0], false, null))); SearchResult searchResult = connection.search(searchRequest); for (SearchResultEntry userEntry : searchResult.getSearchEntries()) { JoinResultControl c = JoinResultControl.get(userEntry); for (JoinedEntry accountEntry : c.getJoinResults()) { // User userEntry was joined with account accountEntry } }
Field Summary | |
---|---|
static java.lang.String |
JOIN_REQUEST_OID
The OID (1.3.6.1.4.1.30221.2.5.9) for the join request control. |
Constructor Summary | |
---|---|
JoinRequestControl(Control control)
Creates a new join request control which is decoded from the provided generic control. |
|
JoinRequestControl(JoinRequestValue joinRequestValue)
Creates a new join request control with the provided join request value. |
Method Summary | |
---|---|
java.lang.String |
getControlName()
Retrieves the user-friendly name for this control, if available. |
JoinRequestValue |
getJoinRequestValue()
Retrieves the join request value for this join request control. |
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_REQUEST_OID
Constructor Detail |
---|
public JoinRequestControl(JoinRequestValue joinRequestValue)
joinRequestValue
- The join request value to use for this control.public JoinRequestControl(Control control) throws LDAPException
control
- The generic control to be decoded as a join request
control.
LDAPException
- If the provided control cannot be decoded as a
virtual attributes only request control.Method Detail |
---|
public JoinRequestValue getJoinRequestValue()
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 |