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

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

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class ReturnConflictEntriesRequestControl
extends Control

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 defines a request control that may be included in a search request to indicate that the server should include replication conflict entries in the set of search result entries.

This control is not based on any public standard. It was originally developed for use with the UnboundID Directory Server. It does not have a value.

There is no corresponding response control. Replication conflict entries may be identified by the object class "ds-sync-conflict-entry".

See Also:
Serialized Form

Field Summary
static java.lang.String RETURN_CONFLICT_ENTRIES_REQUEST_OID
          The OID (1.3.6.1.4.1.30221.2.5.13) for the return conflict entries request control.
 
Constructor Summary
ReturnConflictEntriesRequestControl()
          Creates a new return conflict entries request control.
ReturnConflictEntriesRequestControl(boolean isCritical)
          Creates a new return conflict entries request control.
ReturnConflictEntriesRequestControl(Control control)
          Creates a new return conflict entries request control which is decoded from the provided generic control.
 
Method Summary
 java.lang.String getControlName()
          Retrieves the user-friendly name for this control, if available.
 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

RETURN_CONFLICT_ENTRIES_REQUEST_OID

public static final java.lang.String RETURN_CONFLICT_ENTRIES_REQUEST_OID
The OID (1.3.6.1.4.1.30221.2.5.13) for the return conflict entries request control.

See Also:
Constant Field Values
Constructor Detail

ReturnConflictEntriesRequestControl

public ReturnConflictEntriesRequestControl()
Creates a new return conflict entries request control. It will be marked critical.


ReturnConflictEntriesRequestControl

public ReturnConflictEntriesRequestControl(boolean isCritical)
Creates a new return conflict entries request control.

Parameters:
isCritical - Indicates whether this control should be marked critical.

ReturnConflictEntriesRequestControl

public ReturnConflictEntriesRequestControl(Control control)
                                    throws LDAPException
Creates a new return conflict entries request control which is decoded from the provided generic control.

Parameters:
control - The generic control to be decoded as a return conflict entries request control.
Throws:
LDAPException - If the provided control cannot be decoded as a return conflict entries request control.
Method Detail

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.