Package io.objectbox.sync

Class SyncBuilder

java.lang.Object

io.objectbox.sync.SyncBuilder

public final class SyncBuilder
extends Object

A builder to create a SyncClient; the builder itself should be created via Sync.client(BoxStore, String, SyncCredentials).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SyncBuilder.RequestUpdatesMode

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final BoxStore	boxStore
(package private) SyncChangeListener	changeListener
(package private) SyncCompletedListener	completedListener
(package private) SyncConnectionListener	connectionListener
(package private) final List<SyncCredentials>	credentials
(package private) SyncListener	listener
(package private) SyncLoginListener	loginListener
(package private) final Platform	platform
(package private) SyncBuilder.RequestUpdatesMode	requestUpdatesMode
(package private) SyncTimeListener	timeListener
(package private) String[]	trustedCertPaths
(package private) boolean	uncommittedAcks
(package private) String	url

Constructor Summary

Constructors

Constructor	Description
SyncBuilder(BoxStore boxStore, SyncCredentials credentials)
SyncBuilder(BoxStore boxStore, SyncCredentials[] multipleCredentials)
SyncBuilder(BoxStore boxStore, String url, SyncCredentials credentials)
SyncBuilder(BoxStore boxStore, String url, SyncCredentials[] multipleCredentials)

Method Summary

Modifier and Type	Method	Description
SyncClient	build()	Builds and returns a Sync client ready to SyncClient.start().
SyncClient	buildAndStart()	Builds, starts and returns a Sync client.
SyncBuilder	changeListener(SyncChangeListener changeListener)	Sets a listener to observe fine granular changes happening during sync.
private void	checkNotNull(Object object, String message)
private static void	checkSyncFeatureAvailable()
SyncBuilder	completedListener(SyncCompletedListener completedListener)	Sets a listener to only observe Sync completed events.
SyncBuilder	connectionListener(SyncConnectionListener connectionListener)	Sets a listener to only observe Sync connection events.
SyncBuilder	listener(SyncListener listener)	Sets a listener to observe all Sync events like login or sync completion.
SyncBuilder	loginListener(SyncLoginListener loginListener)	Sets a listener to only observe Sync login events.
SyncBuilder	requestUpdatesMode(SyncBuilder.RequestUpdatesMode requestUpdatesMode)	Configure automatic sync updates from the server.
(package private) SyncBuilder	serverUrl(String url)	Allows internal code to set the Sync server URL after creating this builder.
SyncBuilder	timeListener(SyncTimeListener timeListener)	Sets a listener to only observe Sync time events.
SyncBuilder	trustedCertificates(String[] paths)	Configures a custom set of directory or file paths to search for trusted certificates in.
SyncBuilder	uncommittedAcks()	Turns on sending of uncommitted acks.

Methods inherited from class java.lang.Object

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

Field Details

platform

final Platform platform

boxStore

final BoxStore boxStore

url

String url

credentials

final List<SyncCredentials> credentials

loginListener

@Nullable
SyncLoginListener loginListener

completedListener

@Nullable
SyncCompletedListener completedListener

changeListener

@Nullable
SyncChangeListener changeListener

connectionListener

@Nullable
SyncConnectionListener connectionListener

timeListener

@Nullable
SyncTimeListener timeListener

listener

@Nullable
SyncListener listener

trustedCertPaths

@Nullable
String[] trustedCertPaths

uncommittedAcks

boolean uncommittedAcks

requestUpdatesMode

SyncBuilder.RequestUpdatesMode requestUpdatesMode

Constructor Details

SyncBuilder

@Internal
public SyncBuilder(BoxStore boxStore,
 SyncCredentials credentials)

SyncBuilder

@Internal
public SyncBuilder(BoxStore boxStore,
 SyncCredentials[] multipleCredentials)

SyncBuilder

@Internal
public SyncBuilder(BoxStore boxStore,
 String url,
 SyncCredentials credentials)

SyncBuilder

@Internal
public SyncBuilder(BoxStore boxStore,
 String url,
 SyncCredentials[] multipleCredentials)

Method Details

checkSyncFeatureAvailable

private static void checkSyncFeatureAvailable()

serverUrl

@Internal
SyncBuilder serverUrl(String url)

Allows internal code to set the Sync server URL after creating this builder.

trustedCertificates

public SyncBuilder trustedCertificates(String[] paths)

Configures a custom set of directory or file paths to search for trusted certificates in. The first path that exists will be used.

Using this option is not recommended in most cases, as by default the sync client uses the certificate authorities trusted by the host platform.

requestUpdatesMode

public SyncBuilder requestUpdatesMode(SyncBuilder.RequestUpdatesMode requestUpdatesMode)

Configure automatic sync updates from the server. If automatic sync updates are turned off, they will need to be requested using the sync client.

See Also:

• SyncClient.requestUpdates()
• SyncClient.requestUpdatesOnce()

uncommittedAcks

public SyncBuilder uncommittedAcks()

Turns on sending of uncommitted acks.

loginListener

public SyncBuilder loginListener(SyncLoginListener loginListener)

Sets a listener to only observe Sync login events.

This listener can also be set or removed on the Sync client directly.

completedListener

public SyncBuilder completedListener(SyncCompletedListener completedListener)

Sets a listener to only observe Sync completed events.

This listener can also be set or removed on the Sync client directly.

changeListener

public SyncBuilder changeListener(SyncChangeListener changeListener)

Sets a listener to observe fine granular changes happening during sync.

This listener can also be set or removed on the Sync client directly.

timeListener

public SyncBuilder timeListener(SyncTimeListener timeListener)

Sets a listener to only observe Sync time events.

This listener can also be set or removed on the Sync client directly.

connectionListener

public SyncBuilder connectionListener(SyncConnectionListener connectionListener)

Sets a listener to only observe Sync connection events.

This listener can also be set or removed on the Sync client directly.

listener

public SyncBuilder listener(SyncListener listener)

Sets a listener to observe all Sync events like login or sync completion.

Note: this will replace any login, completed or connection listener.

This listener can also be set or removed on the Sync client directly.

build

public SyncClient build()

Builds and returns a Sync client ready to SyncClient.start().

buildAndStart

public SyncClient buildAndStart()

Builds, starts and returns a Sync client.

checkNotNull

private void checkNotNull(Object object,
 String message)