Package com.unboundid.ldap.sdk.controls
Class ContentSyncDoneControl
- java.lang.Object
-
- com.unboundid.ldap.sdk.Control
-
- com.unboundid.ldap.sdk.controls.ContentSyncDoneControl
-
- All Implemented Interfaces:
DecodeableControl
,java.io.Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class ContentSyncDoneControl extends Control implements DecodeableControl
This class provides an implementation of the LDAP content synchronization done control as defined in RFC 4533. Directory servers may include this control in the search result done message for a search request containing the content synchronization request control. See the documentation for theContentSyncRequestControl
class for more information about using the content synchronization operation.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
SYNC_DONE_OID
The OID (1.3.6.1.4.1.4203.1.9.1.3) for the sync done control.
-
Constructor Summary
Constructors Constructor Description ContentSyncDoneControl(ASN1OctetString cookie, boolean refreshDeletes)
Creates a new content synchronization done control that provides updated information about the state of a content synchronization session.ContentSyncDoneControl(java.lang.String oid, boolean isCritical, ASN1OctetString value)
Creates a new content synchronization done control which is decoded from the provided information from a generic control.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description ContentSyncDoneControl
decodeControl(java.lang.String oid, boolean isCritical, ASN1OctetString value)
Creates a new instance of this decodeable control from the provided information.static ContentSyncDoneControl
get(LDAPResult result)
Extracts a content synchronization done control from the provided result.java.lang.String
getControlName()
Retrieves the user-friendly name for this control, if available.ASN1OctetString
getCookie()
Retrieves a cookie providing updated state information for the synchronization session, if available.boolean
refreshDeletes()
Indicates whether the synchronization processing has completed a delete phase.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, deregisterDecodeableControl, encode, encodeControls, equals, getOID, getValue, hashCode, hasValue, isCritical, readFrom, registerDecodeableControl, toString, writeTo
-
-
-
-
Field Detail
-
SYNC_DONE_OID
public static final java.lang.String SYNC_DONE_OID
The OID (1.3.6.1.4.1.4203.1.9.1.3) for the sync done control.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ContentSyncDoneControl
public ContentSyncDoneControl(ASN1OctetString cookie, boolean refreshDeletes)
Creates a new content synchronization done control that provides updated information about the state of a content synchronization session.- Parameters:
cookie
- A cookie with an updated synchronization state. It may benull
if no updated state is available.refreshDeletes
- Indicates whether the synchronization processing has completed a delete phase.
-
ContentSyncDoneControl
public ContentSyncDoneControl(java.lang.String oid, boolean isCritical, ASN1OctetString value) throws LDAPException
Creates a new content synchronization done control which is decoded from the provided information from a generic control.- Parameters:
oid
- The OID for the control used to create this control.isCritical
- Indicates whether the control is marked critical.value
- The encoded value for the control.- Throws:
LDAPException
- If the provided control cannot be decoded as a content synchronization done control.
-
-
Method Detail
-
decodeControl
public ContentSyncDoneControl decodeControl(java.lang.String oid, boolean isCritical, ASN1OctetString value) throws LDAPException
Creates a new instance of this decodeable control from the provided information.- Specified by:
decodeControl
in interfaceDecodeableControl
- Parameters:
oid
- The OID for the control.isCritical
- Indicates whether the control should be marked critical.value
- The encoded value for the control. This may benull
if no value was provided.- Returns:
- The decoded representation of this control.
- Throws:
LDAPException
- If the provided information cannot be decoded as a valid instance of this decodeable control.
-
get
public static ContentSyncDoneControl get(LDAPResult result) throws LDAPException
Extracts a content synchronization done control from the provided result.- Parameters:
result
- The result from which to retrieve the content synchronization done control.- Returns:
- The content synchronization done control contained in the provided
result, or
null
if the result did not contain a content synchronization done control. - Throws:
LDAPException
- If a problem is encountered while attempting to decode the content synchronization done control contained in the provided result.
-
getCookie
public ASN1OctetString getCookie()
Retrieves a cookie providing updated state information for the synchronization session, if available.- Returns:
- A cookie providing updated state information for the
synchronization session, or
null
if none was included in the control.
-
refreshDeletes
public boolean refreshDeletes()
Indicates whether the synchronization processing has completed a delete phase.- Returns:
true
if the synchronization processing has completed a delete phase, orfalse
if not.
-
getControlName
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.
-
-