|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.IntermediateResponse
com.unboundid.ldap.sdk.controls.ContentSyncInfoIntermediateResponse
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class ContentSyncInfoIntermediateResponse
This class provides an implementation of the sync info message, which is
an intermediate response message used by the content synchronization
operation as defined in
RFC 4533. Directory
servers may return this response in the course of processing 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_INFO_OID
The OID (1.3.6.1.4.1.4203.1.9.1.4) for the sync info intermediate response. |
Fields inherited from class com.unboundid.ldap.sdk.IntermediateResponse |
---|
TYPE_INTERMEDIATE_RESPONSE_OID, TYPE_INTERMEDIATE_RESPONSE_VALUE |
Method Summary | |
---|---|
static ContentSyncInfoIntermediateResponse |
createNewCookieResponse(ASN1OctetString cookie,
Control... controls)
Creates a new sync info intermediate response with a type of ContentSyncInfoType.NEW_COOKIE . |
static ContentSyncInfoIntermediateResponse |
createRefreshDeleteResponse(ASN1OctetString cookie,
boolean refreshDone,
Control... controls)
Creates a new sync info intermediate response with a type of ContentSyncInfoType.REFRESH_DELETE . |
static ContentSyncInfoIntermediateResponse |
createRefreshPresentResponse(ASN1OctetString cookie,
boolean refreshDone,
Control... controls)
Creates a new sync info intermediate response with a type of ContentSyncInfoType.REFRESH_PRESENT . |
static ContentSyncInfoIntermediateResponse |
createSyncIDSetResponse(ASN1OctetString cookie,
java.util.List<java.util.UUID> entryUUIDs,
boolean refreshDeletes,
Control... controls)
Creates a new sync info intermediate response with a type of ContentSyncInfoType.SYNC_ID_SET . |
static ContentSyncInfoIntermediateResponse |
decode(IntermediateResponse r)
Decodes the provided generic intermediate response as a sync info intermediate response. |
ASN1OctetString |
getCookie()
Retrieves an updated state cookie for the synchronization session, if available. |
java.util.List<java.util.UUID> |
getEntryUUIDs()
Retrieves a list of the entryUUID values for the entries referenced in this message. |
java.lang.String |
getIntermediateResponseName()
Retrieves the user-friendly name for the intermediate response, if available. |
ContentSyncInfoType |
getType()
Retrieves the type of content synchronization information represented in this response. |
boolean |
refreshDeletes()
Indicates whether the provided set of UUIDs represent entries that have been removed. |
boolean |
refreshDone()
Indicates whether the refresh phase of the synchronization operation has completed. |
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this intermediate response to the provided buffer. |
java.lang.String |
valueToString()
Retrieves a human-readable string representation for the contents of the value for this intermediate response, if appropriate. |
Methods inherited from class com.unboundid.ldap.sdk.IntermediateResponse |
---|
getControl, getControls, getMessageID, getOID, getValue, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String SYNC_INFO_OID
Method Detail |
---|
public static ContentSyncInfoIntermediateResponse createNewCookieResponse(ASN1OctetString cookie, Control... controls)
ContentSyncInfoType.NEW_COOKIE
.
cookie
- The updated state cookie for the synchronization session.
It must not be null
.controls
- An optional set of controls to include in the response.
It may be null
or empty if no controls should be
included.
public static ContentSyncInfoIntermediateResponse createRefreshDeleteResponse(ASN1OctetString cookie, boolean refreshDone, Control... controls)
ContentSyncInfoType.REFRESH_DELETE
.
cookie
- The updated state cookie for the synchronization
session. It may be null
if no new cookie is
available.refreshDone
- Indicates whether the refresh phase of the
synchronization operation has completed.controls
- An optional set of controls to include in the
response. It may be null
or empty if no
controls should be included.
public static ContentSyncInfoIntermediateResponse createRefreshPresentResponse(ASN1OctetString cookie, boolean refreshDone, Control... controls)
ContentSyncInfoType.REFRESH_PRESENT
.
cookie
- The updated state cookie for the synchronization
session. It may be null
if no new cookie is
available.refreshDone
- Indicates whether the refresh phase of the
synchronization operation has completed.controls
- An optional set of controls to include in the
response. It may be null
or empty if no
controls should be included.
public static ContentSyncInfoIntermediateResponse createSyncIDSetResponse(ASN1OctetString cookie, java.util.List<java.util.UUID> entryUUIDs, boolean refreshDeletes, Control... controls)
ContentSyncInfoType.SYNC_ID_SET
.
cookie
- The updated state cookie for the synchronization
session. It may be null
if no new cookie
is available.entryUUIDs
- The set of entryUUIDs for the entries referenced in
this response. It must not be null
.refreshDeletes
- Indicates whether the entryUUIDs represent entries
that have been removed rather than those that have
remained unchanged.controls
- An optional set of controls to include in the
response. It may be null
or empty if no
controls should be included.
public static ContentSyncInfoIntermediateResponse decode(IntermediateResponse r) throws LDAPException
r
- The intermediate response to be decoded as a sync info
intermediate response. It must not be null
.
LDAPException
- If a problem occurs while trying to decode the
provided intermediate response as a sync info
response.public ContentSyncInfoType getType()
public ASN1OctetString getCookie()
null
for a type of
ContentSyncInfoType.NEW_COOKIE
, and may or may not be null
for other types.
null
if none is available.public boolean refreshDone()
ContentSyncInfoType.REFRESH_DELETE
and
ContentSyncInfoType.REFRESH_PRESENT
types.
true
if the refresh phase of the synchronization operation
has completed, or false
if not or if it is not applicable
for this message type.public java.util.List<java.util.UUID> getEntryUUIDs()
ContentSyncInfoType.SYNC_ID_SET
type.
null
if it is not applicable for this message
type.public boolean refreshDeletes()
ContentSyncInfoType.SYNC_ID_SET
type.
true
if the associated set of entryUUIDs represent entries
that have been deleted, or false
if they represent entries
that remain unchanged or if it is not applicable for this message
type.public java.lang.String getIntermediateResponseName()
null
will be returned.
getIntermediateResponseName
in class IntermediateResponse
null
if neither a user-friendly name
nor a response OID are available.public java.lang.String valueToString()
valueToString
in class IntermediateResponse
null
if there is
no value or no string representation is available.public void toString(java.lang.StringBuilder buffer)
toString
in interface LDAPResponse
toString
in class IntermediateResponse
buffer
- The buffer to which the string representation should be
appended.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |