Class ReturnConflictEntriesRequestControl
- java.lang.Object
-
- com.unboundid.ldap.sdk.Control
-
- com.unboundid.ldap.sdk.unboundidds.controls.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
-
-
Field Summary
Fields Modifier and Type Field Description 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
Constructors Constructor Description 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
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ReturnConflictEntriesRequestControl
decodeJSONControl(JSONObject controlObject, boolean strict)
Attempts to decode the provided object as a JSON representation of a return conflict entries request control.java.lang.String
getControlName()
Retrieves the user-friendly name for this control, if available.JSONObject
toJSONControl()
Retrieves a representation of this return conflict entries 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
-
RETURN_CONFLICT_ENTRIES_REQUEST_OID
@NotNull 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(@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 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 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 thevalue-base64
norvalue-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, 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 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 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 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.
-
-