A B C D E F G I M N O P R S U V

A

addContent(T, ObjectNode, String) - Method in interface org.jboss.aerogear.sync.client.ClientSynchronizer

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

addDocument(ClientDocument<T>) - Method in interface org.jboss.aerogear.sync.client.SyncClient

Adds a ClientDocument to this SyncClient.

addPatchListener(PatchListener<T>) - Method in class org.jboss.aerogear.sync.client.DefaultPatchObservable

addPatchListener(PatchListener<T>) - Method in interface org.jboss.aerogear.sync.client.PatchObservable

Adds the specified PatchListener to the set of listeners.

addPatchListener(PatchListener<T>) - Method in interface org.jboss.aerogear.sync.client.SyncClient

Add an PatchListener that will be notified when a patch has been perfomed.

asJson() - Method in interface org.jboss.aerogear.sync.Payload

Transforms this payload to a JSON String representation.

B

BackupShadowDocument<T> - Interface in org.jboss.aerogear.sync

A backup of the ShadowDocument.

C

changed() - Method in class org.jboss.aerogear.sync.client.DefaultPatchObservable

changed() - Method in interface org.jboss.aerogear.sync.client.PatchObservable

Marks this PatchObservable as having been changed

channel() - Method in interface org.jboss.aerogear.sync.server.Subscriber

The channel that this subscriber uses to communicate.

checksum() - Method in interface org.jboss.aerogear.sync.Edit

A checksum of the opposing sides shadow document.

ClientDataStore<T,S extends Edit<? extends Diff>> - Interface in org.jboss.aerogear.sync.client

A client side DataStore implementation is responsible for storing and serving data for a Differential Synchronization implementation.

clientDiff(ShadowDocument<T>, ClientDocument<T>) - Method in interface org.jboss.aerogear.sync.client.ClientSynchronizer

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

clientDiff(Document<T>, ShadowDocument<T>) - Method in interface org.jboss.aerogear.sync.server.ServerSynchronizer

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

ClientDocument<T> - Interface in org.jboss.aerogear.sync

A client document is used on both the server and client side and associates a client identifier with a Document.

clientId() - Method in interface org.jboss.aerogear.sync.client.SyncClient

Returns the client identifier.

clientId() - Method in interface org.jboss.aerogear.sync.ClientDocument

Identifies a client or session to which this Document belongs.

clientId() - Method in interface org.jboss.aerogear.sync.PatchMessage

Identifies the client that this edit instance belongs to.

clientId() - Method in interface org.jboss.aerogear.sync.server.Subscriber

The client identifier of this subscriber

ClientSynchronizer<T,S extends Edit<? extends Diff>> - Interface in org.jboss.aerogear.sync.client

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

clientVersion() - Method in interface org.jboss.aerogear.sync.Edit

The client version that edit is related to.

clientVersion() - Method in interface org.jboss.aerogear.sync.ShadowDocument

Represents the latest client version that this shadow document was based on.

connect() - Method in interface org.jboss.aerogear.sync.client.SyncClient

Connects this client to a Sync Server.

content() - Method in interface org.jboss.aerogear.sync.Document

The content of a document.

countPatchListeners() - Method in class org.jboss.aerogear.sync.client.DefaultPatchObservable

countPatchListeners() - Method in interface org.jboss.aerogear.sync.client.PatchObservable

Returns the number of currently registered PatchListeners

countPatchListeners() - Method in interface org.jboss.aerogear.sync.client.SyncClient

Returns the number of currently registered PatchListeners

createPatchMessage(String, String, Queue<S>) - Method in interface org.jboss.aerogear.sync.client.ClientSynchronizer

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

createPatchMessage(String, String, Queue<S>) - Method in interface org.jboss.aerogear.sync.server.ServerSynchronizer

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

D

DataStore<T,S extends Edit<? extends Diff>> - Interface in org.jboss.aerogear.sync

A DataStore implementation is responsible for storing and serving data for a Differential Synchronization implementation.

DefaultPatchObservable<T> - Class in org.jboss.aerogear.sync.client

DefaultPatchObservable() - Constructor for class org.jboss.aerogear.sync.client.DefaultPatchObservable

deletePatchListener(PatchListener<T>) - Method in interface org.jboss.aerogear.sync.client.SyncClient

Removes the specified PatchListener from the list of listeners.

deletePatchListeners() - Method in interface org.jboss.aerogear.sync.client.SyncClient

Deletes all PatchListeners.

Diff - Interface in org.jboss.aerogear.sync

A marker interface that represents a diff or two versions of a document/object.

diff() - Method in interface org.jboss.aerogear.sync.Edit

The Diff for this edit.

diffAndSend(ClientDocument<T>) - Method in interface org.jboss.aerogear.sync.client.SyncClient

Diff the specified ClientDocument and send all edits to the sync server

disconnect() - Method in interface org.jboss.aerogear.sync.client.SyncClient

Disconnect from the sync server.

Document<T> - Interface in org.jboss.aerogear.sync

Represents the server side version of a document

document() - Method in interface org.jboss.aerogear.sync.ShadowDocument

The document itself.

documentFromJson(JsonNode) - Method in interface org.jboss.aerogear.sync.server.ServerSynchronizer

Converts the JsonNode into a Document instance.

documentId() - Method in interface org.jboss.aerogear.sync.PatchMessage

Identifies the document that this edit is related to

E

Edit<T extends Diff> - Interface in org.jboss.aerogear.sync

Represents a single edit.

edits() - Method in interface org.jboss.aerogear.sync.PatchMessage

The individual Edits.

F

from(String) - Static method in enum org.jboss.aerogear.sync.server.MessageType

fromJson(String) - Method in interface org.jboss.aerogear.sync.Payload

Transforms the passed in String JSON representation into this payloads type.

G

getBackupShadowDocument(String, String) - Method in interface org.jboss.aerogear.sync.DataStore

Retrieves the BackupShadowDocument matching the passed-in document documentId.

getClientDocument(String, String) - Method in interface org.jboss.aerogear.sync.client.ClientDataStore

Retrieves the Document matching the passed-in document documentId.

getDocument(String) - Method in interface org.jboss.aerogear.sync.server.ServerDataStore

Retrieves the Document matching the passed-in document documentId.

getEdits(String, String) - Method in interface org.jboss.aerogear.sync.DataStore

Retreives the queue of Edits for the specified document documentId.

getShadowDocument(String, String) - Method in interface org.jboss.aerogear.sync.DataStore

Retrieves the ShadowDocument matching the passed-in document documentId.

I

id() - Method in interface org.jboss.aerogear.sync.Document

The identifier for a document.

isConnected() - Method in interface org.jboss.aerogear.sync.client.SyncClient

Determines whether the client is currently connected to the sync server.

M

MessageType - Enum in org.jboss.aerogear.sync.server

N

notifyPatched(ClientDocument<T>) - Method in class org.jboss.aerogear.sync.client.DefaultPatchObservable

notifyPatched(ClientDocument<T>) - Method in interface org.jboss.aerogear.sync.client.PatchObservable

Notify all listeners that the ClientDocument has been patched.

O

org.jboss.aerogear.sync - package org.jboss.aerogear.sync

This package contains interfaces for AeroGear Sync.

org.jboss.aerogear.sync.client - package org.jboss.aerogear.sync.client

This package contains interfaces for AeroGear Sync Client API.

org.jboss.aerogear.sync.server - package org.jboss.aerogear.sync.server

This package contains interfaces for AeroGear Sync Server API.

P

patchDocument(S, ClientDocument<T>) - Method in interface org.jboss.aerogear.sync.client.ClientSynchronizer

Called when the document should be patched.

patchDocument(S, Document<T>) - Method in interface org.jboss.aerogear.sync.server.ServerSynchronizer

Called when the document should be patched.

patched(ClientDocument<T>) - Method in interface org.jboss.aerogear.sync.client.PatchListener

Is called when the ClientDocument has patched a document.

patched(PatchMessage<?>) - Method in interface org.jboss.aerogear.sync.server.Subscriber

Is called when this subscribers underlying document has been patched, allowing it to handle the PatchMessage.

PatchListener<T> - Interface in org.jboss.aerogear.sync.client

A listener/observer of patches.

PatchMessage<T extends Edit<? extends Diff>> - Interface in org.jboss.aerogear.sync

Represents a stack of changes made on the server of client side.

patchMessageFromJson(String) - Method in interface org.jboss.aerogear.sync.client.ClientSynchronizer

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

patchMessageFromJson(String) - Method in interface org.jboss.aerogear.sync.server.ServerSynchronizer

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

PatchObservable<T> - Interface in org.jboss.aerogear.sync.client

patchShadow(S, ShadowDocument<T>) - Method in interface org.jboss.aerogear.sync.client.ClientSynchronizer

Called when the shadow should be patched.

patchShadow(S, ShadowDocument<T>) - Method in interface org.jboss.aerogear.sync.server.ServerSynchronizer

Called when the shadow should be patched.

Payload<T> - Interface in org.jboss.aerogear.sync

Represents something that can be exchanged in JSON format.

R

removeEdit(S, String, String) - Method in interface org.jboss.aerogear.sync.DataStore

Removes the edit from the store.

removeEdits(String, String) - Method in interface org.jboss.aerogear.sync.DataStore

Removes all edits for the specific client and document pair.

removePatchListener(PatchListener<T>) - Method in class org.jboss.aerogear.sync.client.DefaultPatchObservable

removePatchListener(PatchListener<T>) - Method in interface org.jboss.aerogear.sync.client.PatchObservable

Remove the specified PatchListener from the set of listeners.

removePatchListeners() - Method in class org.jboss.aerogear.sync.client.DefaultPatchObservable

removePatchListeners() - Method in interface org.jboss.aerogear.sync.client.PatchObservable

Remove all PatchListeners.

S

saveBackupShadowDocument(BackupShadowDocument<T>) - Method in interface org.jboss.aerogear.sync.DataStore

Saves a backup shadow document

saveClientDocument(ClientDocument<T>) - Method in interface org.jboss.aerogear.sync.client.ClientDataStore

Saves a client document.

saveDocument(Document<T>) - Method in interface org.jboss.aerogear.sync.server.ServerDataStore

Saves a server document.

saveEdits(S, String, String) - Method in interface org.jboss.aerogear.sync.DataStore

Saves an Edit to the data store.

saveShadowDocument(ShadowDocument<T>) - Method in interface org.jboss.aerogear.sync.DataStore

Saves a shadow document.

ServerDataStore<T,S extends Edit<? extends Diff>> - Interface in org.jboss.aerogear.sync.server

A server side DataStore implementation is responsible for storing and serving data for a Differential Synchronization implementation.

serverDiff(ClientDocument<T>, ShadowDocument<T>) - Method in interface org.jboss.aerogear.sync.client.ClientSynchronizer

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

serverDiff(Document<T>, ShadowDocument<T>) - Method in interface org.jboss.aerogear.sync.server.ServerSynchronizer

The first step in a sync is to produce a an edit for the changes.

ServerSynchronizer<T,S extends Edit<? extends Diff>> - Interface in org.jboss.aerogear.sync.server

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

serverVersion() - Method in interface org.jboss.aerogear.sync.Edit

The server version that edit is related to.

serverVersion() - Method in interface org.jboss.aerogear.sync.ShadowDocument

Represents the latest server version that the this shadow document was based on.

shadow() - Method in interface org.jboss.aerogear.sync.BackupShadowDocument

The ShadowDocument that this instance is backing up.

ShadowDocument<T> - Interface in org.jboss.aerogear.sync

A shadow document for each client will exist on the client side and also on the server side.

Subscriber<T> - Interface in org.jboss.aerogear.sync.server

Represents a subscriber of patches.

SyncClient<T,S extends Edit<? extends Diff>> - Interface in org.jboss.aerogear.sync.client

U

updateDocument(Document<T>) - Method in interface org.jboss.aerogear.sync.server.ServerDataStore

Updates a server document.

V

valueOf(String) - Static method in enum org.jboss.aerogear.sync.server.MessageType

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.jboss.aerogear.sync.server.MessageType

Returns an array containing the constants of this enum type, in the order they are declared.

version() - Method in interface org.jboss.aerogear.sync.BackupShadowDocument

Represents the version of this backup shadow.

A B C D E F G I M N O P R S U V