Class ReplicationRepairRequestControl
- java.lang.Object
-
- com.unboundid.ldap.sdk.Control
-
- com.unboundid.ldap.sdk.unboundidds.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 which may be used to process an add, delete, modify, or modify DN operation in the Directory Server which will not be replicated to other servers. This control is primarily intended for use in manually resolving replication conflicts.
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 request control has an OID of 1.3.6.1.4.1.30221.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 Description static java.lang.String
REPLICATION_REPAIR_REQUEST_OID
The OID (1.3.6.1.4.1.30221.1.5.2) for the replication repair request control.
-
Constructor Summary
Constructors Constructor 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 which is decoded from the provided generic control.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ReplicationRepairRequestControl
decodeJSONControl(JSONObject controlObject, boolean strict)
Attempts to decode the provided object as a JSON representation of a replication repair request control.java.lang.String
getControlName()
Retrieves the user-friendly name for this control, if available.JSONObject
toJSONControl()
Retrieves a representation of this replication repair request control as a JSON object.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, toString, writeTo
-
-
-
-
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.30221.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 which 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 classControl
- 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 replication repair request control as a JSON object. The JSON object uses the following fields (note that since this control does not have a value, neither thevalue-base64
norvalue-json
fields may be present):-
oid
-- A mandatory string field whose value is the object identifier for this control. For the replication repair request control, the OID is "1.3.6.1.4.1.30221.1.5.2". -
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, theoid
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 classControl
- Returns:
- A JSON object that contains a representation of this control.
-
-
decodeJSONControl
@NotNull public static ReplicationRepairRequestControl decodeJSONControl(@NotNull JSONObject controlObject, boolean strict) throws LDAPException
Attempts to decode the provided object as a JSON representation of a replication repair request control.- Parameters:
controlObject
- The JSON object to be decoded. It must not benull
.strict
- Indicates whether to use strict mode when decoding the provided JSON object. If this istrue
, then this method will throw an exception if the provided JSON object contains any unrecognized fields. If this isfalse
, then unrecognized fields will be ignored.- Returns:
- The replication repair request control that was decoded from the provided JSON object.
- Throws:
LDAPException
- If the provided JSON object cannot be parsed as a valid replication repair request control.
-
-