com.unboundid.ldap.sdk.unboundidds.controls

Class JoinBaseDN

java.lang.Object

com.unboundid.ldap.sdk.unboundidds.controls.JoinBaseDN

All Implemented Interfaces:

java.io.Serializable

@NotMutable
 @ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class JoinBaseDN
extends java.lang.Object
implements java.io.Serializable

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.

NOTE: This class, and other classes within the com.unboundid.ldap.sdk.unboundidds package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
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

Modifier and Type	Method and Description
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

BASE_TYPE_SEARCH_BASE

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

See Also:

Constant Field Values

BASE_TYPE_SOURCE_ENTRY_DN

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

See Also:

Constant Field Values

BASE_TYPE_CUSTOM

public static final byte BASE_TYPE_CUSTOM

The base type which indicates that the base DN for join processing should be a custom base DN.

See Also:

Constant Field Values

Method Detail

createUseSearchBaseDN

@NotNull
public static JoinBaseDN createUseSearchBaseDN()

Creates a join base DN object which indicates that join processing should use the base DN from the search request.

Returns:

A join base DN object which indicates that join processing should use the base DN from the search request.

createUseSourceEntryDN

@NotNull
public static JoinBaseDN createUseSourceEntryDN()

Creates a join base DN object which indicates that join processing should use the DN of the source entry.

Returns:

A join base DN object which indicates that join processing should use the DN of the source entry.

createUseCustomBaseDN

@NotNull
public static JoinBaseDN createUseCustomBaseDN(@NotNull
                                                        java.lang.String baseDN)

Creates a join base DN object which indicates that join processing should use the provided base DN.

Parameters:

baseDN - The custom base DN to use. It must not be null.

Returns:

A join base DN object which indicates that join processing should use the provided base DN.

getType

public byte getType()

Retrieves the base type for this join base DN.

Returns:

The base type for this join base DN.

getCustomBaseDN

@Nullable
public java.lang.String getCustomBaseDN()

Retrieves the base DN value to use for the custom base DN type.

Returns:

The base DN value to use for the custom base DN type, or null if the base DN should be the search base DN or the source entry DN.

toString

@NotNull
public java.lang.String toString()

Retrieves a string representation of this join base DN.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this join base DN.

toString

public void toString(@NotNull
                     java.lang.StringBuilder buffer)

Appends a string representation of this join base DN to the provided buffer.

Parameters:

buffer - The buffer to which the information should be appended.