com.unboundid.ldap.sdk.forgerockds.controls

Class ReplicationRepairRequestControl

java.lang.Object

com.unboundid.ldap.sdk.Control

com.unboundid.ldap.sdk.forgerockds.controls.ReplicationRepairRequestControl

All Implemented Interfaces:

java.io.Serializable

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

This class provides an implementation of a control that may be used to process an add, delete, modify, or modify DN operation in the ForgeRock Directory Server that will not be replicated to other servers. This control is primarily intended for use in manually resolving replication conflicts.
This request control has an OID of 1.3.6.1.4.1.26027.1.5.2 and a criticality of true. It does not have a value.

Example

The following example demonstrates the use of the replication repair request control:

 ModifyRequest modifyRequest = new ModifyRequest("dc=example,dc=com",
      new Modification(ModificationType.REPLACE, "attrName", "attrValue"));
 modifyRequest.addControl(new ReplicationRepairRequestControl());
 LDAPResult modifyResult = connection.modify(modifyRequest);
 

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	REPLICATION_REPAIR_REQUEST_OID The OID (1.3.6.1.4.1.26027.1.5.2) for the replication repair request control.

Constructor Summary

Constructors

Constructor and Description
ReplicationRepairRequestControl() Creates a new replication repair request control.
ReplicationRepairRequestControl(boolean isCritical) Creates a new replication repair request control with the specified criticality.
ReplicationRepairRequestControl(Control control) Creates a new replication repair request control that is decoded from the provided generic control.

Method Summary

Modifier and Type	Method and Description
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, decodeJSONControl, deregisterDecodeableControl, encode, encodeControls, equals, getOID, getValue, hashCode, hasValue, isCritical, readFrom, registerDecodeableControl, registerDecodeableControl, toJSONControl, toString, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

REPLICATION_REPAIR_REQUEST_OID

@NotNull
public static final java.lang.String REPLICATION_REPAIR_REQUEST_OID

The OID (1.3.6.1.4.1.26027.1.5.2) for the replication repair request control.

See Also:

Constant Field Values

Constructor Detail

ReplicationRepairRequestControl

public ReplicationRepairRequestControl()

Creates a new replication repair request control. It will be marked critical.

ReplicationRepairRequestControl

public ReplicationRepairRequestControl(boolean isCritical)

Creates a new replication repair request control with the specified criticality.

Parameters:

isCritical - Indicates whether the control should be marked critical.

ReplicationRepairRequestControl

public ReplicationRepairRequestControl(@NotNull
                                       Control control)
                                throws LDAPException

Creates a new replication repair request control that is decoded from the provided generic control.

Parameters:

control - The generic control to be decoded as a replication repair request control.

Throws:

LDAPException - If the provided control cannot be decoded as a replication repair 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.