org.jboss.aerogear.sync.jsonpatch.client

Class JsonPatchClientSynchronizer

java.lang.Object

org.jboss.aerogear.sync.jsonpatch.client.JsonPatchClientSynchronizer

All Implemented Interfaces:

ClientSynchronizer<com.fasterxml.jackson.databind.JsonNode,JsonPatchEdit>

public class JsonPatchClientSynchronizer
extends Object
implements ClientSynchronizer<com.fasterxml.jackson.databind.JsonNode,JsonPatchEdit>

A ServerSynchronizer implementation that can handle text documents.

Constructor Summary

Constructors

Constructor and Description
JsonPatchClientSynchronizer()

Method Summary

Modifier and Type	Method and Description
void	addContent(com.fasterxml.jackson.databind.JsonNode content, com.fasterxml.jackson.databind.node.ObjectNode objectNode, String fieldName) Adds the content of the passed in content to the ObjectNode.
static String	checksum(com.fasterxml.jackson.databind.JsonNode content)
JsonPatchEdit	clientDiff(ShadowDocument<com.fasterxml.jackson.databind.JsonNode> shadowDocument, ClientDocument<com.fasterxml.jackson.databind.JsonNode> document) Produces a Edit containing the changes between updated ShadowDocument and the ClientDocument.
PatchMessage<JsonPatchEdit>	createPatchMessage(String documentId, String clientId, Queue<JsonPatchEdit> edits) Creates a new PatchMessage with the with the type of Edit that this synchronizer can handle.
ClientDocument<com.fasterxml.jackson.databind.JsonNode>	patchDocument(JsonPatchEdit edit, ClientDocument<com.fasterxml.jackson.databind.JsonNode> document) Called when the document should be patched.
PatchMessage<JsonPatchEdit>	patchMessageFromJson(String json) Creates a {link PatchMessage} by parsing the passed-in json.
ShadowDocument<com.fasterxml.jackson.databind.JsonNode>	patchShadow(JsonPatchEdit edit, ShadowDocument<com.fasterxml.jackson.databind.JsonNode> shadowDocument) Called when the shadow should be patched.
JsonPatchEdit	serverDiff(ClientDocument<com.fasterxml.jackson.databind.JsonNode> document, ShadowDocument<com.fasterxml.jackson.databind.JsonNode> shadowDocument) Produces a Edit containing the changes between the updated ClientDocument and the ShadowDocument.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JsonPatchClientSynchronizer

public JsonPatchClientSynchronizer()

Method Detail

clientDiff

public JsonPatchEdit clientDiff(ShadowDocument<com.fasterxml.jackson.databind.JsonNode> shadowDocument,
                                ClientDocument<com.fasterxml.jackson.databind.JsonNode> document)

Description copied from interface: ClientSynchronizer

Produces a Edit containing the changes between updated ShadowDocument and the ClientDocument. This method would be called when the client receives an update from the server and need to produce an Edit to be able to patch the ClientDocument.

Specified by:

clientDiff in interface ClientSynchronizer<com.fasterxml.jackson.databind.JsonNode,JsonPatchEdit>

Parameters:

shadowDocument - the ShadowDocument patched with updates from the server

document - the ClientDocument

Returns:

Edit the edit representing the diff between the shadow document and the client document.

serverDiff

public JsonPatchEdit serverDiff(ClientDocument<com.fasterxml.jackson.databind.JsonNode> document,
                                ShadowDocument<com.fasterxml.jackson.databind.JsonNode> shadowDocument)

Description copied from interface: ClientSynchronizer

Produces a Edit containing the changes between the updated ClientDocument and the ShadowDocument.

Calling the method is the first step in when starting a client side synchronization. We need to gather the changes between the updates made by the client and the shadow document. The produced Edit can then be passed to the server side.

Specified by:

serverDiff in interface ClientSynchronizer<com.fasterxml.jackson.databind.JsonNode,JsonPatchEdit>

Parameters:

document - the ClientDocument containing updates made by the client

shadowDocument - the ShadowDocument for the ClientDocument

Returns:

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

patchShadow

public ShadowDocument<com.fasterxml.jackson.databind.JsonNode> patchShadow(JsonPatchEdit edit,
                                                                           ShadowDocument<com.fasterxml.jackson.databind.JsonNode> shadowDocument)

Description copied from interface: ClientSynchronizer

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

Specified by:

patchShadow in interface ClientSynchronizer<com.fasterxml.jackson.databind.JsonNode,JsonPatchEdit>

Parameters:

edit - the Edit containing the diffs/patches

shadowDocument - the ShadowDocument to be patched

Returns:

ShadowDocument a new patched shadow document

patchDocument

public ClientDocument<com.fasterxml.jackson.databind.JsonNode> patchDocument(JsonPatchEdit edit,
                                                                             ClientDocument<com.fasterxml.jackson.databind.JsonNode> document)

Description copied from interface: ClientSynchronizer

Called when the document should be patched.

Specified by:

patchDocument in interface ClientSynchronizer<com.fasterxml.jackson.databind.JsonNode,JsonPatchEdit>

Parameters:

edit - the Edit containing the diffs/patches

document - the ClientDocument to be patched

Returns:

ClientDocument a new patched document.

createPatchMessage

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

Description copied from interface: ClientSynchronizer

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

Specified by:

createPatchMessage in interface ClientSynchronizer<com.fasterxml.jackson.databind.JsonNode,JsonPatchEdit>

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

public PatchMessage<JsonPatchEdit> patchMessageFromJson(String json)

Description copied from interface: ClientSynchronizer

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

Specified by:

patchMessageFromJson in interface ClientSynchronizer<com.fasterxml.jackson.databind.JsonNode,JsonPatchEdit>

Parameters:

json - the json representation of a PatchMessage

Returns:

PatchMessage the created {code PatchMessage}

addContent

public void addContent(com.fasterxml.jackson.databind.JsonNode content,
                       com.fasterxml.jackson.databind.node.ObjectNode objectNode,
                       String fieldName)

Description copied from interface: ClientSynchronizer

Adds the content of the passed in content to the ObjectNode.

When a client initially adds a document to the engine it will also be sent across the wire to the server. Before sending, the content of the document has to be added to the JSON message payload. Different implementation will require different content types that the engine can handle and this give them control over how the content is added to the JSON ObjectNode. For example, a ClientEngine that stores simple text will just add the contents as a String, but one that stores JsonNode object will want to add its content as an object.

Specified by:

addContent in interface ClientSynchronizer<com.fasterxml.jackson.databind.JsonNode,JsonPatchEdit>

Parameters:

content - the content to be added

objectNode - the ObjectNode to add the content to

fieldName - the name of the field

checksum

public static String checksum(com.fasterxml.jackson.databind.JsonNode content)