Package org.ldaptive.extended
Class SyncInfoMessage
java.lang.Object
org.ldaptive.AbstractMessage
org.ldaptive.extended.IntermediateResponse
org.ldaptive.extended.SyncInfoMessage
- All Implemented Interfaces:
Message
Intermediate response message for LDAP content synchronization. See RFC 4533. Message is defined as:
IntermediateResponse ::= [APPLICATION 25] SEQUENCE { responseName [0] LDAPOID OPTIONAL, responseValue [1] OCTET STRING OPTIONAL } syncInfoValue ::= CHOICE { newcookie [0] syncCookie, refreshDelete [1] SEQUENCE { cookie syncCookie OPTIONAL, refreshDone BOOLEAN DEFAULT TRUE }, refreshPresent [2] SEQUENCE { cookie syncCookie OPTIONAL, refreshDone BOOLEAN DEFAULT TRUE }, syncIdSet [3] SEQUENCE { cookie syncCookie OPTIONAL, refreshDeletes BOOLEAN DEFAULT FALSE, syncUUIDs SET OF syncUUID } }
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
private static class
Parse handler implementation for new cookie.private static class
Parse handler implementation for refresh delete cookie.private static class
Parse handler implementation for refresh delete done.private static class
Parse handler implementation for refresh delete.private static class
Parse handler implementation for refresh present cookie.private static class
Parse handler implementation for refresh present done.private static class
Parse handler implementation for refresh present.private static class
Parse handler implementation for sync id set cookie.private static class
Parse handler implementation for sync id set deletes.private static class
Parse handler implementation for sync id set.private static class
Parse handler implementation for sync id set uuids.static enum
Types of request modes.Nested classes/interfaces inherited from class org.ldaptive.extended.IntermediateResponse
IntermediateResponse.ResponseNameHandler, IntermediateResponse.ResponseValueHandler
Nested classes/interfaces inherited from class org.ldaptive.AbstractMessage
AbstractMessage.AbstractBuilder<B,
T extends AbstractMessage>, AbstractMessage.ControlParser, AbstractMessage.ControlsHandler, AbstractMessage.MessageIDHandler -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate byte[]
server generated cookie.entry uuids.private static final int
hash code seed.private SyncInfoMessage.Type
message type.private static final DERPath
DER path to new cookie.static final String
OID of this response.private static final DERPath
DER path to refresh delete cookie.private static final DERPath
DER path to refresh delete done.private static final DERPath
DER path to refresh delete.private static final DERPath
DER path to refresh present cookie.private static final DERPath
DER path to refresh present done.private static final DERPath
DER path to refresh present.private boolean
refresh deletes.private boolean
refresh done.private static final DERPath
DER path to sync ID set cookie.private static final DERPath
DER path to sync ID set deletes.private static final DERPath
DER path to sync ID set.private static final DERPath
DER path to sync ID set UUIDS.Fields inherited from class org.ldaptive.extended.IntermediateResponse
PROTOCOL_OP
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
Default constructor.SyncInfoMessage
(DERBuffer buffer) Creates a new sync info message. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addEntryUuids
(UUID... uuids) Adds the supplied UUIDs to this message.static SyncInfoMessage.Builder
builder()
Creates a builder for this class.boolean
byte[]
Returns the sync request cookie.Returns the entry uuids.Returns the message type.boolean
Returns whether to refresh deletes.boolean
Returns whether refreshes are done.protected ParseHandler
Returns the parse handler for the response value.int
hashCode()
Returns the hash code for this object.void
setCookie
(byte[] value) Sets the sync request cookie.void
setEntryUuids
(Set<UUID> uuids) Sets the entry uuids.void
Sets the message type.void
setRefreshDeletes
(boolean b) Sets whether to refresh deletes.void
setRefreshDone
(boolean b) Sets whether refreshes are done.toString()
Methods inherited from class org.ldaptive.extended.IntermediateResponse
getResponseName, getResponseValue, setResponseName, setResponseValue
Methods inherited from class org.ldaptive.AbstractMessage
addControls, copyValues, getControls, getMessageID, setMessageID
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.ldaptive.Message
getControl
-
Field Details
-
OID
OID of this response.- See Also:
-
HASH_CODE_SEED
private static final int HASH_CODE_SEEDhash code seed.- See Also:
-
NEW_COOKIE_PATH
DER path to new cookie. -
REFRESH_DELETE_PATH
DER path to refresh delete. -
REFRESH_DELETE_COOKIE_PATH
DER path to refresh delete cookie. -
REFRESH_DELETE_DONE_PATH
DER path to refresh delete done. -
REFRESH_PRESENT_PATH
DER path to refresh present. -
REFRESH_PRESENT_COOKIE_PATH
DER path to refresh present cookie. -
REFRESH_PRESENT_DONE_PATH
DER path to refresh present done. -
SYNC_ID_SET_PATH
DER path to sync ID set. -
SYNC_ID_SET_COOKIE_PATH
DER path to sync ID set cookie. -
SYNC_ID_SET_DELETES_PATH
DER path to sync ID set deletes. -
SYNC_ID_SET_UUIDS_PATH
DER path to sync ID set UUIDS. -
messageType
message type. -
cookie
private byte[] cookieserver generated cookie. -
refreshDone
private boolean refreshDonerefresh done. -
refreshDeletes
private boolean refreshDeletesrefresh deletes. -
entryUuids
entry uuids.
-
-
Constructor Details
-
SyncInfoMessage
protected SyncInfoMessage()Default constructor. -
SyncInfoMessage
Creates a new sync info message.- Parameters:
buffer
- to decode
-
-
Method Details
-
getResponseValueParseHandler
Returns the parse handler for the response value.- Overrides:
getResponseValueParseHandler
in classIntermediateResponse
- Returns:
- parse handler
-
getMessageType
Returns the message type.- Returns:
- message type
-
setMessageType
Sets the message type.- Parameters:
type
- message type
-
getCookie
public byte[] getCookie()Returns the sync request cookie.- Returns:
- sync request cookie
-
setCookie
public void setCookie(byte[] value) Sets the sync request cookie.- Parameters:
value
- sync request cookie
-
getRefreshDone
public boolean getRefreshDone()Returns whether refreshes are done.- Returns:
- refresh done
-
setRefreshDone
public void setRefreshDone(boolean b) Sets whether refreshes are done.- Parameters:
b
- refresh done
-
getRefreshDeletes
public boolean getRefreshDeletes()Returns whether to refresh deletes.- Returns:
- whether to refresh deletes
-
setRefreshDeletes
public void setRefreshDeletes(boolean b) Sets whether to refresh deletes.- Parameters:
b
- whether to refresh deletes
-
getEntryUuids
Returns the entry uuids.- Returns:
- entry uuids
-
addEntryUuids
Adds the supplied UUIDs to this message.- Parameters:
uuids
- to add
-
setEntryUuids
Sets the entry uuids.- Parameters:
uuids
- entry uuids
-
equals
- Overrides:
equals
in classIntermediateResponse
-
hashCode
public int hashCode()Description copied from class:AbstractMessage
Returns the hash code for this object.- Overrides:
hashCode
in classIntermediateResponse
- Returns:
- hash code
-
toString
- Overrides:
toString
in classIntermediateResponse
-
builder
Creates a builder for this class.- Returns:
- new builder
-