Package com.unboundid.ldap.sdk.unboundidds.controls

Class ReturnConflictEntriesRequestControl

java.lang.Object
com.unboundid.ldap.sdk.Control
com.unboundid.ldap.sdk.unboundidds.controls.ReturnConflictEntriesRequestControl
All Implemented Interfaces:
Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class ReturnConflictEntriesRequestControl extends Control
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.
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.

This control is not based on any public standard. It was originally developed for use with the Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 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:

  • Field Details

  • Constructor Details

    • 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(@NotNull 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 Details

    • getControlName

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

    • toJSONControl

      @NotNull public JSONObject toJSONControl()
      Retrieves a representation of this return conflict entries request control as a JSON object. The JSON object uses the following fields (note that since this control does not have a value, neither the value-base64 nor value-json fields may be present):
      • oid -- A mandatory string field whose value is the object identifier for this control. For the return conflict entries request control, the OID is "1.3.6.1.4.1.30221.2.5.13".
      • control-name -- An optional string field whose value is a human-readable name for this control. This field is only intended for descriptive purposes, and when decoding a control, the oid field should be used to identify the type of control.
      • criticality -- A mandatory Boolean field used to indicate whether this control is considered critical.
      Overrides:
      toJSONControl in class Control
      Returns:
      A JSON object that contains a representation of this control.

    • decodeJSONControl

      @NotNull public static ReturnConflictEntriesRequestControl decodeJSONControl(@NotNull JSONObject controlObject, boolean strict) throws LDAPException
      Attempts to decode the provided object as a JSON representation of a return conflict entries request control.
      Parameters:
      controlObject - The JSON object to be decoded. It must not be null.
      strict - Indicates whether to use strict mode when decoding the provided JSON object. If this is true, then this method will throw an exception if the provided JSON object contains any unrecognized fields. If this is false, then unrecognized fields will be ignored.
      Returns:
      The return conflict entries request control that was decoded from the provided JSON object.
      Throws:
      LDAPException - If the provided JSON object cannot be parsed as a valid return conflict entrie request control.

    • toString

      public void toString(@NotNull 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.