Package io.objectbox.sync

Class SyncClientImpl

java.lang.Object

io.objectbox.sync.SyncClientImpl

All Implemented Interfaces:

SyncClient, Closeable, AutoCloseable

@Internal
public final class SyncClientImpl
extends Object
implements SyncClient

Internal sync client implementation. Use SyncClient to access functionality, this class may change without notice.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SyncClientImpl.ObjectsMessageBuilderImpl

Method Summary

Modifier and Type	Method	Description
void	applyFilterVariables()	Applies all pending Sync filter variable updates (from SyncClient.putFilterVariable(java.lang.String, java.lang.String) and SyncClient.removeFilterVariable(java.lang.String) calls).
boolean	awaitFirstLogin(long millisToWait)	Waits until the sync client receives a response to its first (connection and) login attempt or until the given time has expired.
boolean	cancelUpdates()	Asks the server to pause sync updates.
void	close()	Closes and cleans up all resources used by this sync client.
protected void	finalize()	Users of this class should explicitly call close() instead to avoid expensive finalization.
long	getLastLoginCode()	Response code of last login attempt.
long	getRoundtripTimeNanos()	Returns the estimated roundtrip time in nanoseconds to the server and back.
long	getServerTimeDiffNanos()	Returns the estimated difference in nanoseconds between the server time and the local timestamp.
long	getServerTimeNanos()	Estimates the current server timestamp in nanoseconds based on the last known server time.
String	getServerUrl()	Gets the sync server URL this client is connected to.
SyncState	getSyncState()	Gets the current state of this sync client.
List<String>	getUrls()	Gets the sync server URLs this client may connect to.
boolean	isLoggedIn()	Flag indicating if the sync client was started.
boolean	isStarted()	Flag indicating if the sync client was started.
void	notifyConnectionAvailable()	Lets the sync client know that a working network connection is available.
void	putFilterVariable(String name, String value)	Adds or replaces a Sync filter variable value for the given name.
void	removeAllFilterVariables()	Removes all previously added Sync filter variable values.
void	removeFilterVariable(String name)	Removes a previously added Sync filter variable value.
boolean	requestFullSync()	Temporary only, try not to use it.
boolean	requestFullSyncAndUpdates()	Temporary only, try not to use it.
boolean	requestUpdates()	Asks the sync server to resume sync updates.
boolean	requestUpdatesOnce()	Asks the server to send sync updates until this sync client is up-to-date, then pauses sync updates again.
void	setLoginCredentials(SyncCredentials credentials)	Sets credentials to authenticate the client with the server.
void	setLoginCredentials(SyncCredentials[] multipleCredentials)	Like SyncClient.setLoginCredentials(SyncCredentials), but accepts an array of credentials.
void	setLoginCredentials(List<SyncCredentials> credentials)	Like SyncClient.setLoginCredentials(SyncCredentials), but accepts a list of credentials.
void	setSyncChangeListener(SyncChangeListener changesListener)	Sets a SyncChangeListener.
void	setSyncCompletedListener(SyncCompletedListener listener)	Sets a listener to observe Sync completed events.
void	setSyncConnectionListener(SyncConnectionListener listener)	Sets a listener to observe Sync connection events.
void	setSyncListener(SyncListener listener)	Sets a listener to observe all Sync events.
void	setSyncLoginListener(SyncLoginListener listener)	Sets a listener to observe login events.
void	setSyncTimeListener(SyncTimeListener timeListener)	Sets a SyncTimeListener.
void	start()	Starts the client.
ObjectsMessageBuilder	startObjectsMessage(long flags, String topic)	Experimental.
void	stop()	Stops the client.

Methods inherited from class java.lang.Object

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

Method Details

getServerUrl

public String getServerUrl()

Description copied from interface: SyncClient

Gets the sync server URL this client is connected to.

Specified by:

getServerUrl in interface SyncClient

getUrls

public List<String> getUrls()

Description copied from interface: SyncClient

Gets the sync server URLs this client may connect to.

See SyncBuilder.url(String) for notes on multiple URLs.

Specified by:

getUrls in interface SyncClient

getLastLoginCode

public long getLastLoginCode()

Description copied from interface: SyncClient

Response code of last login attempt. One of SyncLoginCodes.

Specified by:

getLastLoginCode in interface SyncClient

isLoggedIn

public boolean isLoggedIn()

Description copied from interface: SyncClient

Flag indicating if the sync client was started. Logged in clients can sync with the sync destination to exchange data.

Specified by:

isLoggedIn in interface SyncClient

getServerTimeNanos

public long getServerTimeNanos()

Description copied from interface: SyncClient

Estimates the current server timestamp in nanoseconds based on the last known server time.

Specified by:

getServerTimeNanos in interface SyncClient

Returns:

unix timestamp in nanoseconds (since epoch); or 0 if there has not been a server contact yet and thus the server's time is unknown

getServerTimeDiffNanos

public long getServerTimeDiffNanos()

Description copied from interface: SyncClient

Returns the estimated difference in nanoseconds between the server time and the local timestamp. urns the difference in nanoseconds between the current local time of this client Equivalent to calculating SyncClient.getServerTimeNanos() - "current time" (nanos since epoch), except for when the server time is unknown, then the result is zero.

Specified by:

getServerTimeDiffNanos in interface SyncClient

Returns:

time difference in nanoseconds; e.g. positive if server time is ahead of local time; or 0 if there has not been a server contact yet and thus the server's time is unknown

getRoundtripTimeNanos

public long getRoundtripTimeNanos()

Description copied from interface: SyncClient

Returns the estimated roundtrip time in nanoseconds to the server and back. This is measured during login.

Specified by:

getRoundtripTimeNanos in interface SyncClient

Returns:

roundtrip time in nanoseconds; or 0 if there has not been a server contact yet and thus the roundtrip time could not be estimated

getSyncState

public SyncState getSyncState()

Gets the current state of this sync client. Throws if close() was called.

setSyncLoginListener

public void setSyncLoginListener(@Nullable
 SyncLoginListener listener)

Description copied from interface: SyncClient

Sets a listener to observe login events. Replaces a previously set listener. Set to null to remove the listener.

Specified by:

setSyncLoginListener in interface SyncClient

setSyncCompletedListener

public void setSyncCompletedListener(@Nullable
 SyncCompletedListener listener)

Description copied from interface: SyncClient

Sets a listener to observe Sync completed events. Replaces a previously set listener. Set to null to remove the listener.

Specified by:

setSyncCompletedListener in interface SyncClient

setSyncChangeListener

public void setSyncChangeListener(@Nullable
 SyncChangeListener changesListener)

Description copied from interface: SyncClient

Sets a SyncChangeListener. Replaces a previously set listener. Set to null to remove the listener.

Specified by:

setSyncChangeListener in interface SyncClient

setSyncTimeListener

public void setSyncTimeListener(@Nullable
 SyncTimeListener timeListener)

Description copied from interface: SyncClient

Sets a SyncTimeListener. Replaces a previously set listener. Set to null to remove the listener.

Specified by:

setSyncTimeListener in interface SyncClient

setSyncConnectionListener

public void setSyncConnectionListener(@Nullable
 SyncConnectionListener listener)

Description copied from interface: SyncClient

Sets a listener to observe Sync connection events. Replaces a previously set listener. Set to null to remove the listener.

Specified by:

setSyncConnectionListener in interface SyncClient

setSyncListener

public void setSyncListener(@Nullable
 SyncListener listener)

Description copied from interface: SyncClient

Sets a listener to observe all Sync events. Replaces all other previously set listeners, except a SyncChangeListener. Set to null to remove the listener.

Specified by:

setSyncListener in interface SyncClient

putFilterVariable

public void putFilterVariable(String name,
 String value)

Description copied from interface: SyncClient

Adds or replaces a Sync filter variable value for the given name.

Note: If the client is already logged in, this change is not applied until SyncClient.applyFilterVariables() is called. This allows to put or remove multiple variables before applying all changes. Filter variables set before login (before calling SyncClient.start()) are automatically applied.

Eventually, existing values for the same name are replaced.

Sync client filter variables can be used in server-side Sync filters to filter out objects that do not match the filter.

Specified by:

putFilterVariable in interface SyncClient

See Also:

• SyncClient.removeFilterVariable(java.lang.String)
• SyncClient.removeAllFilterVariables()
• SyncClient.applyFilterVariables()

removeFilterVariable

public void removeFilterVariable(String name)

Description copied from interface: SyncClient

Removes a previously added Sync filter variable value.

Note: If the client is already logged in, this change is not applied until SyncClient.applyFilterVariables() is called. See SyncClient.putFilterVariable(java.lang.String, java.lang.String) for details.

Specified by:

removeFilterVariable in interface SyncClient

See Also:

• SyncClient.putFilterVariable(java.lang.String, java.lang.String)
• SyncClient.removeAllFilterVariables()

removeAllFilterVariables

public void removeAllFilterVariables()

Description copied from interface: SyncClient

Removes all previously added Sync filter variable values.

Note: If the client is already logged in, this change is not applied until SyncClient.applyFilterVariables() is called. See SyncClient.putFilterVariable(java.lang.String, java.lang.String) for details.

Specified by:

removeAllFilterVariables in interface SyncClient

See Also:

• SyncClient.putFilterVariable(java.lang.String, java.lang.String)
• SyncClient.removeFilterVariable(java.lang.String)

applyFilterVariables

public void applyFilterVariables()

Description copied from interface: SyncClient

Applies all pending Sync filter variable updates (from SyncClient.putFilterVariable(java.lang.String, java.lang.String) and SyncClient.removeFilterVariable(java.lang.String) calls).

If the client is connected, sends the updated variables to the server. If the client is not connected, the updated variables will be included in the next login message.

Specified by:

applyFilterVariables in interface SyncClient

See Also:

• SyncClient.putFilterVariable(java.lang.String, java.lang.String)
• SyncClient.removeFilterVariable(java.lang.String)
• SyncClient.removeAllFilterVariables()

setLoginCredentials

public void setLoginCredentials(List<SyncCredentials> credentials)

Description copied from interface: SyncClient

Like SyncClient.setLoginCredentials(SyncCredentials), but accepts a list of credentials.

Specified by:

setLoginCredentials in interface SyncClient

Parameters:

credentials - a list of credentials where each element is created using a SyncCredentials factory method, for example SyncCredentials.jwtIdToken(idToken).

setLoginCredentials

public void setLoginCredentials(SyncCredentials credentials)

Description copied from interface: SyncClient

Sets credentials to authenticate the client with the server.

Any credentials that were set before are replaced.

Usually, credentials are passed via SyncBuilder.credentials(SyncCredentials), but this can be used to update them later, such as when a token expires.

The accepted credentials type depends on your Sync server configuration.

Specified by:

setLoginCredentials in interface SyncClient

Parameters:

credentials - credentials created using a SyncCredentials factory method, for example SyncCredentials.jwtIdToken(idToken).

See Also:

• SyncClient.setLoginCredentials(List)

setLoginCredentials

public void setLoginCredentials(SyncCredentials[] multipleCredentials)

Description copied from interface: SyncClient

Like SyncClient.setLoginCredentials(SyncCredentials), but accepts an array of credentials.

Specified by:

setLoginCredentials in interface SyncClient

Parameters:

multipleCredentials - an array of credentials where each element is created using a SyncCredentials factory method, for example SyncCredentials.jwtIdToken(idToken).

awaitFirstLogin

public boolean awaitFirstLogin(long millisToWait)

Description copied from interface: SyncClient

Waits until the sync client receives a response to its first (connection and) login attempt or until the given time has expired. Use SyncClient.isLoggedIn() or SyncClient.getLastLoginCode() afterwards to determine if login was successful. Starts the sync if it is not already.

Specified by:

awaitFirstLogin in interface SyncClient

Returns:

true if a response was received in the given time window.

start

public void start()

Description copied from interface: SyncClient

Starts the client. It will connect to the server, log in (authenticate) and start syncing.

Specified by:

start in interface SyncClient

isStarted

public boolean isStarted()

Description copied from interface: SyncClient

Flag indicating if the sync client was started. Started clients try to connect, login, and sync with the sync destination.

Specified by:

isStarted in interface SyncClient

stop

public void stop()

Description copied from interface: SyncClient

Stops the client. Does nothing if the sync client is already stopped.

Specified by:

stop in interface SyncClient

close

public void close()

Description copied from interface: SyncClient

Closes and cleans up all resources used by this sync client. It can no longer be used afterwards, build a new sync client instead. Does nothing if this sync client has already been closed.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface SyncClient

finalize

protected void finalize()
                 throws Throwable

Users of this class should explicitly call close() instead to avoid expensive finalization.

Overrides:

finalize in class Object

Throws:

Throwable

requestFullSync

@Experimental
public boolean requestFullSync()

Temporary only, try not to use it.

Specified by:

requestFullSync in interface SyncClient

Returns:

'true' if the request was likely sent (e.g. the sync client is in "logged in" state) or 'false' if the request was not sent (and will not be sent in the future).

requestFullSyncAndUpdates

@Experimental
public boolean requestFullSyncAndUpdates()

Temporary only, try not to use it.

requestUpdates

public boolean requestUpdates()

Description copied from interface: SyncClient

Asks the sync server to resume sync updates. This is useful if sync updates were turned off with requestUpdatesMode(MANUAL).

Specified by:

requestUpdates in interface SyncClient

Returns:

'true' if the request was likely sent (e.g. the sync client is in "logged in" state) or 'false' if the request was not sent (and will not be sent in the future)

See Also:

• SyncClient.cancelUpdates()

requestUpdatesOnce

public boolean requestUpdatesOnce()

Description copied from interface: SyncClient

Asks the server to send sync updates until this sync client is up-to-date, then pauses sync updates again. This is useful if sync updates were turned off with requestUpdatesMode(MANUAL).

Specified by:

requestUpdatesOnce in interface SyncClient

Returns:

'true' if the request was likely sent (e.g. the sync client is in "logged in" state) or 'false' if the request was not sent (and will not be sent in the future)

cancelUpdates

public boolean cancelUpdates()

Description copied from interface: SyncClient

Asks the server to pause sync updates.

Specified by:

cancelUpdates in interface SyncClient

Returns:

'true' if the request was likely sent (e.g. the sync client is in "logged in" state) or 'false' if the request was not sent (and will not be sent in the future)

See Also:

• SyncClient.requestUpdates()

notifyConnectionAvailable

public void notifyConnectionAvailable()

Description copied from interface: SyncClient

Lets the sync client know that a working network connection is available.

This can help speed up reconnecting to the sync server.

Specified by:

notifyConnectionAvailable in interface SyncClient

startObjectsMessage

public ObjectsMessageBuilder startObjectsMessage(long flags,
 @Nullable
 String topic)

Description copied from interface: SyncClient

Experimental. This API might change or be removed in the future.

Start building a message of Objects with optional flags (set to 0) and topic (set to null).

Use like

 syncClient.startObjectsMessage(0, "some-topic")
     .addString(1, "Hello!")
     .addBytes(2, "Hello!".getBytes(StandardCharsets.UTF_8), false)
     .send();
 

Specified by:

startObjectsMessage in interface SyncClient