org.jboss.aerogear.sync.server

Interface ServerSynchronizer<T,S extends Edit<? extends Diff>>

Type Parameters:

T - The type of documents that this engine can handle.

S - The type of Edits that this synchronizer can handle

All Known Implementing Classes:

DiffMatchPatchServerSynchronizer, JsonMergePatchServerSynchronizer, JsonPatchServerSynchronizer

public interface ServerSynchronizer<T,S extends Edit<? extends Diff>>

A instance of this class will be able to handle tasks needed to implement Differential Synchronization for a specific type of documents.

Method Summary

Modifier and Type	Method and Description
S	clientDiff(Document<T> document, ShadowDocument<T> shadowDocument) Is called to produce an Edit of changes coming from a client.
PatchMessage<S>	createPatchMessage(String documentId, String clientId, Queue<S> edits) Creates a new PatchMessage with the with the type of Edit that this synchronizer can handle.
Document<T>	documentFromJson(com.fasterxml.jackson.databind.JsonNode json) Converts the JsonNode into a Document instance.
Document<T>	patchDocument(S edit, Document<T> document) Called when the document should be patched.
PatchMessage<S>	patchMessageFromJson(String json) Creates a {link PatchMessage} by parsing the passed-in json.
ShadowDocument<T>	patchShadow(S edit, ShadowDocument<T> shadowDocument) Called when the shadow should be patched.
S	serverDiff(Document<T> document, ShadowDocument<T> shadowDocument) The first step in a sync is to produce a an edit for the changes.

Method Detail

patchShadow

ShadowDocument<T> patchShadow(S edit,
                              ShadowDocument<T> shadowDocument)

Called when the shadow should be patched. Is called when an update is recieved.

Parameters:

edit - The edits.

shadowDocument - the ShadowDocument to patch

Returns:

ShadowDocument a new patched shadow document.

patchDocument

Document<T> patchDocument(S edit,
                          Document<T> document)

Called when the document should be patched.

Parameters:

edit - the edit to use to path the document

document - the document to be patched.

Returns:

Document a new patched document.

serverDiff

S serverDiff(Document<T> document,
             ShadowDocument<T> shadowDocument)

The first step in a sync is to produce a an edit for the changes. The produced edit can then be sent to the opposing side perform an update/sync.

Parameters:

document - the document containing

shadowDocument - the document shadow.

Returns:

Edit the edit representing the diff between the document and it's shadow document.

clientDiff

S clientDiff(Document<T> document,
             ShadowDocument<T> shadowDocument)

Is called to produce an Edit of changes coming from a client.

Parameters:

document - the server side document .

shadowDocument - the document shadow containing the client changes.

Returns:

Edit the edit representing the diff between the document and it's shadow document.

createPatchMessage

PatchMessage<S> createPatchMessage(String documentId,
                                   String clientId,
                                   Queue<S> edits)

Creates a new PatchMessage with the with the type of Edit that this synchronizer can handle.

Parameters:

documentId - the document identifier for the PatchMessage

clientId - the client identifier for the PatchMessage

edits - the Edits for the PatchMessage

Returns:

PatchMessage the created {code PatchMessage}

patchMessageFromJson

PatchMessage<S> patchMessageFromJson(String json)

Creates a {link PatchMessage} by parsing the passed-in json.

Parameters:

json - the json representation of a PatchMessage

Returns:

PatchMessage the created {code PatchMessage}

documentFromJson

Document<T> documentFromJson(com.fasterxml.jackson.databind.JsonNode json)

Converts the JsonNode into a Document instance.

Parameters:

json - the JsonNode to convert

Returns:

Document the document representing the contents of the JsonNode instance.