Class ReturnConflictEntriesRequestControl

  • All Implemented Interfaces:
    java.io.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:
    Serialized Form
    • Constructor Detail

      • 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 Detail

      • getControlName

        @NotNull
        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​(@NotNull
                             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.