Package io.objectbox.sync

Class Sync

java.lang.Object

io.objectbox.sync.Sync

public final class Sync
extends Object

ObjectBox Sync makes data available on other devices.

Use the static methods to build a Sync client or embedded server.

Method Summary

Modifier and Type	Method	Description
static SyncBuilder	client(BoxStore boxStore)	Starts building a SyncClient for the given BoxStore.
static SyncBuilder	client(BoxStore boxStore, String url, SyncCredentials credentials)	Deprecated. Use client(BoxStore), SyncBuilder.url(String) and SyncBuilder.credentials(SyncCredentials) instead.
static SyncBuilder	client(BoxStore boxStore, String url, SyncCredentials[] multipleCredentials)	Deprecated. Use client(BoxStore), SyncBuilder.url(String) and SyncBuilder.credentials(SyncCredentials) instead.
static SyncHybridBuilder	hybrid(BoxStoreBuilder storeBuilder, String url, SyncCredentials authenticatorCredentials)	Starts building a SyncHybrid, a client/server hybrid typically used for embedded cluster setups.
static boolean	isAvailable()	Returns true if the included native (JNI) ObjectBox library supports Sync.
static boolean	isHybridAvailable()	Returns true if the included native (JNI) ObjectBox library supports Sync hybrids (server and client).
static boolean	isServerAvailable()	Returns true if the included native (JNI) ObjectBox library supports Sync server.
static SyncServerBuilder	server(BoxStore boxStore, String url, SyncCredentials authenticatorCredentials)	Starts building a SyncServer.
static SyncServerBuilder	server(BoxStore boxStore, String url, SyncCredentials[] multipleAuthenticatorCredentials)	Like server(BoxStore, String, SyncCredentials), but supports passing a set of authentication methods for clients and peers.

Methods inherited from class java.lang.Object

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

Method Details

isAvailable

public static boolean isAvailable()

Returns true if the included native (JNI) ObjectBox library supports Sync.

isServerAvailable

public static boolean isServerAvailable()

Returns true if the included native (JNI) ObjectBox library supports Sync server.

isHybridAvailable

public static boolean isHybridAvailable()

Returns true if the included native (JNI) ObjectBox library supports Sync hybrids (server and client).

client

public static SyncBuilder client(BoxStore boxStore)

Starts building a SyncClient for the given BoxStore.

This does not initiate any connection attempts yet: call SyncBuilder.buildAndStart() to do so. Before, you must configure the server URL via SyncBuilder.url(String) and add credentials via SyncBuilder.credentials(SyncCredentials).

By default, a Sync client automatically receives updates from the server once login succeeded. To configure this differently, call SyncBuilder.requestUpdatesMode(SyncBuilder.RequestUpdatesMode) with the wanted mode.

Parameters:

boxStore - The BoxStore the client should use.

Returns:

a builder to configure the Sync client

client

@Deprecated
public static SyncBuilder client(BoxStore boxStore,
 String url,
 SyncCredentials credentials)

Deprecated.

Use client(BoxStore), SyncBuilder.url(String) and SyncBuilder.credentials(SyncCredentials) instead.

Starts building a SyncClient. Once done, complete with build().

Parameters:

boxStore - The BoxStore the client should use.

url - The URL of the Sync server on which the Sync protocol is exposed. This is typically a WebSockets URL starting with ws:// or wss:// (for encrypted connections), for example ws://127.0.0.1:9999.

credentials - SyncCredentials to authenticate with the server.

client

@Deprecated
public static SyncBuilder client(BoxStore boxStore,
 String url,
 SyncCredentials[] multipleCredentials)

Deprecated.

Use client(BoxStore), SyncBuilder.url(String) and SyncBuilder.credentials(SyncCredentials) instead.

Like client(BoxStore, String, SyncCredentials), but supports passing a set of authentication methods.

Parameters:

multipleCredentials - An array of SyncCredentials to be used to authenticate with the server.

server

public static SyncServerBuilder server(BoxStore boxStore,
 String url,
 SyncCredentials authenticatorCredentials)

Starts building a SyncServer. Once done, complete with build().

Note: when also using Admin, make sure it is started before the server.

Parameters:

boxStore - The BoxStore the server should use.

url - The URL of the Sync server on which the Sync protocol is exposed. This is typically a WebSockets URL starting with ws:// or wss:// (for encrypted connections), for example ws://0.0.0.0:9999.

authenticatorCredentials - An authentication method available to Sync clients and peers. Additional authenticator credentials can be supplied using the returned builder. For the embedded server, currently only SyncCredentials.sharedSecret(java.lang.String), any JWT method like SyncCredentials.jwtIdTokenServer() as well as SyncCredentials.none() are supported.

server

public static SyncServerBuilder server(BoxStore boxStore,
 String url,
 SyncCredentials[] multipleAuthenticatorCredentials)

Like server(BoxStore, String, SyncCredentials), but supports passing a set of authentication methods for clients and peers.

hybrid

public static SyncHybridBuilder hybrid(BoxStoreBuilder storeBuilder,
 String url,
 SyncCredentials authenticatorCredentials)

Starts building a SyncHybrid, a client/server hybrid typically used for embedded cluster setups.

Unlike client(BoxStore, String, SyncCredentials) and server(BoxStore, String, SyncCredentials), the client Store is not built before. Instead, a Store builder must be passed. The client and server Store will be built internally when calling this method.

To configure client and server use the methods on SyncHybridBuilder.

Parameters:

storeBuilder - The BoxStoreBuilder to use for building the client store.

url - The URL of the Sync server on which the Sync protocol is exposed. This is typically a WebSockets URL starting with ws:// or wss:// (for encrypted connections), for example ws://0.0.0.0:9999.

authenticatorCredentials - An authentication method available to Sync clients and peers. The client of the hybrid is pre-configured with them. Additional credentials can be supplied using the client and server builder of the returned builder. For the embedded server, currently only SyncCredentials.sharedSecret(java.lang.String), any JWT method like SyncCredentials.jwtIdTokenServer() as well as SyncCredentials.none() are supported.

Returns:

An instance of SyncHybridBuilder.