|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.Control
com.unboundid.ldap.sdk.controls.ContentSyncDoneControl
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class ContentSyncDoneControl
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 the ContentSyncRequestControl
class for more
information about using the content synchronization operation.
Field Summary | |
---|---|
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 | |
---|---|
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 | |
---|---|
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 |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String SYNC_DONE_OID
Constructor Detail |
---|
public ContentSyncDoneControl(ASN1OctetString cookie, boolean refreshDeletes)
cookie
- A cookie with an updated synchronization state. It
may be null
if no updated state is
available.refreshDeletes
- Indicates whether the synchronization processing
has completed a delete phase.public ContentSyncDoneControl(java.lang.String oid, boolean isCritical, ASN1OctetString value) throws LDAPException
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.
LDAPException
- If the provided control cannot be decoded as a
content synchronization done control.Method Detail |
---|
public ContentSyncDoneControl decodeControl(java.lang.String oid, boolean isCritical, ASN1OctetString value) throws LDAPException
decodeControl
in interface DecodeableControl
oid
- The OID for the control.isCritical
- Indicates whether the control should be marked
critical.value
- The encoded value for the control. This may be
null
if no value was provided.
LDAPException
- If the provided information cannot be decoded as a
valid instance of this decodeable control.public static ContentSyncDoneControl get(LDAPResult result) throws LDAPException
result
- The result from which to retrieve the content
synchronization done control.
null
if the result did not contain a content
synchronization done control.
LDAPException
- If a problem is encountered while attempting to
decode the content synchronization done control
contained in the provided result.public ASN1OctetString getCookie()
null
if none was included in
the control.public boolean refreshDeletes()
true
if the synchronization processing has completed a
delete phase, or false
if not.public java.lang.String getControlName()
getControlName
in class Control
public void toString(java.lang.StringBuilder buffer)
toString
in class Control
buffer
- The buffer to which to append the string representation of
this buffer.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |