|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.unboundidds.controls.JoinBaseDN
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class JoinBaseDN
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 a data structure which may be used to indicate the base DN to use for a join request. See the class-level documentation for the
JoinRequestControl
class for additional information and an example
demonstrating its use.
Field Summary | |
---|---|
static byte |
BASE_TYPE_CUSTOM
The base type which indicates that the base DN for join processing should be a custom base DN. |
static byte |
BASE_TYPE_SEARCH_BASE
The base type which indicates that the base DN for join processing should be the same as the base DN from the search request. |
static byte |
BASE_TYPE_SOURCE_ENTRY_DN
The base type which indicates that the base DN for join processing should be the DN of the source entry. |
Method Summary | |
---|---|
static JoinBaseDN |
createUseCustomBaseDN(java.lang.String baseDN)
Creates a join base DN object which indicates that join processing should use the provided base DN. |
static JoinBaseDN |
createUseSearchBaseDN()
Creates a join base DN object which indicates that join processing should use the base DN from the search request. |
static JoinBaseDN |
createUseSourceEntryDN()
Creates a join base DN object which indicates that join processing should use the DN of the source entry. |
java.lang.String |
getCustomBaseDN()
Retrieves the base DN value to use for the custom base DN type. |
byte |
getType()
Retrieves the base type for this join base DN. |
java.lang.String |
toString()
Retrieves a string representation of this join base DN. |
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this join base DN to the provided buffer. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final byte BASE_TYPE_SEARCH_BASE
public static final byte BASE_TYPE_SOURCE_ENTRY_DN
public static final byte BASE_TYPE_CUSTOM
Method Detail |
---|
public static JoinBaseDN createUseSearchBaseDN()
public static JoinBaseDN createUseSourceEntryDN()
public static JoinBaseDN createUseCustomBaseDN(java.lang.String baseDN)
baseDN
- The custom base DN to use. It must not be null
.
public byte getType()
public java.lang.String getCustomBaseDN()
null
if the base DN should be the search base DN or the
source entry DN.public java.lang.String toString()
toString
in class java.lang.Object
public void toString(java.lang.StringBuilder buffer)
buffer
- The buffer to which the information should be appended.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |