com.softwareag.mobile.runtime.toolkit.operations

Class SyncClient

java.lang.Object

com.softwareag.mobile.runtime.toolkit.operations.SyncClient

All Implemented Interfaces:

IOperationDelegate, Observer

public final class SyncClient
extends java.lang.Object
implements Observer, IOperationDelegate

The SyncClient enables clients to synchronize JSON-based data with Software AGs Integration Server. The Mobile Data Sync Package allows bidirectional synchronization. Local data is stored in a SQLite table to enable offline support.

Call start() to trigger a synchronization process. This method does the following:

1. Loads data which is stored in the underlying SQLite table
2. Starts a new download operation (download()), if the local data is empty, or
3. Starts a new sync operation (sync()), if local data is stored.

After the client receives data from the SQLite table or from the remote host, all registered datasources will be notified. This forces given Views to reload.

The client only starts if all necessary credentials has been set. Those are

• appname,
• version,
• hostname,
• port,
• mscAlias.

Use the public constructor or the correspondent set-methods to change the credentials. If the provided username or password is empty, the client will try to use the Credentials registered with the shared Session . The download or sync operation's are only executed, if all credentials are set. Calling start() before all credentials are set does not trigger to start the process. In this case, the client waits for all credentials and restarts if all credentials are not empty.
Please be aware that updates on the shared Credentials are not automatically published to the SyncClient.

The current synchronization process can be monitored by registering ISyncClientListeners. Therefore, each registered ISyncClientListener is informed on status changes and ongoing operations.

In addition to this, any implementation of IListDatasource can be registered. The datasources are updated if the underlying data changes. Be aware that the datasource must understand JSON.

This class is extensible. By subclassing, the AbstractXXXApplicationControllerImpl#createSyncClient method must be overwritten to publish the custom SyncClient.

Version:

9.7.0.0000-0116

Constructor Summary

Constructors

Constructor and Description
SyncClient(java.lang.String appname, java.lang.String version, java.lang.String mscAlias, java.lang.String hostname, java.lang.String port) Creates a new instance by passing all required properties and an update interval of 60000L.
SyncClient(java.lang.String appname, java.lang.String version, java.lang.String mscAlias, java.lang.String hostname, java.lang.String port, long updateInterval) Creates a new instance by passing all required properties.

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(ISyncClientListener listener) Adds the passed ISyncClientListener.
void	download() Starts a new download.
java.lang.String	getAppname() Sets the app name.
java.lang.String	getDeviceType() Returns the device type.
java.lang.String	getHostname() Returns the host name.
java.lang.String	getMscAlias() Returns the msc alias.
java.lang.String	getPassword() Returns the password.
java.lang.String	getPort() Returns the port.
ISQLiteConnector	getSQLStore() Returns the ISQLiteConnector.
long	getUpdateInterval() Returns the update interval for the SyncOperation.
java.lang.String	getUsername() Returns the user name.
java.lang.String	getVersion() Returns the version number.
void	onOperationFailed(IOperation operation) Notifies this listener that the watched IOperation failed.
void	onOperationFinished(IOperation operation) Notifies this listener that the watched IOperation finished.
void	registerDatasource(IListDatasource datasource) Adds a new datasource to be observed on data set changes.
void	removeListener(ISyncClientListener listener) Removes the passed ISyncClientListener.
void	setAppname(java.lang.String appname) Sets the app name.
void	setDeviceType(java.lang.String deviceType) Sets the device type.
void	setHostname(java.lang.String hostname) Sets the host name.
void	setMscAlias(java.lang.String mscAlias) Sets the msc alias.
void	setPassword(java.lang.String password) Sets the password.
void	setPort(java.lang.String port) Sets the port.
void	setUpdateInterval(long updateInterval) Sets the update interval for the SyncOperation.
void	setUseHttps(boolean usesHttps) Sets a boolean value indicating if a secure connection should be used.
void	setUsername(java.lang.String username) Sets the user name.
void	setVersion(java.lang.String version) Sets the version number.
void	start() Starts a new synchronization process: Calls handleReceivedData() and {link #sync()}, if the underlying SQLite table has at least one item Calls download(), if the underlying SQLite table has no item
void	stop() Stops the ongoing synchronization.
void	sync() Starts a new synchronization.
void	unregisterDatasource(IListDatasource datasource) Removes a datasource.
void	update(Observable observable, java.lang.Object object) Empty implementation of Observer.update(Observable, Object) to allow subclasses to watch on Observer changes.
void	updateCredentials() Validates the credentials and passes them to Context#setInitializeConf(String, String, String, String, String, String) if all required properties are not empty.
boolean	usesHttps() Returns a boolean value indicating if a secure connection is used.
boolean	usesSharedSession() Returns true indicating that the credentials are used from the current Session.

Methods inherited from class java.lang.Object

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

Constructor Detail

SyncClient

public SyncClient(java.lang.String appname,
          java.lang.String version,
          java.lang.String mscAlias,
          java.lang.String hostname,
          java.lang.String port)

Creates a new instance by passing all required properties and an update interval of 60000L.

Parameters:

appname - Name of the application that is registered with the mobile sync component.

version - Version of the application that is registered with the mobile sync component.

mscAlias -

hostname -

port -

updateInterval -

SyncClient

public SyncClient(java.lang.String appname,
          java.lang.String version,
          java.lang.String mscAlias,
          java.lang.String hostname,
          java.lang.String port,
          long updateInterval)

Creates a new instance by passing all required properties.

Parameters:

appname - Name of the application that is registered with the mobile sync component.

version - Version of the application that is registered with the mobile sync component.

mscAlias -

hostname -

port -

updateInterval -

Method Detail

updateCredentials

public void updateCredentials()

Validates the credentials and passes them to Context#setInitializeConf(String, String, String, String, String, String) if all required properties are not empty.
The following properties must be set:

• username
• password
• hostname
• port

The synchronization can only be started if all of them are set.

registerDatasource

public void registerDatasource(IListDatasource datasource)

Adds a new datasource to be observed on data set changes.

Parameters:

datasource -

unregisterDatasource

public void unregisterDatasource(IListDatasource datasource)

Removes a datasource.
The passed datasource won't be updated on data set changes after the removal.

Parameters:

datasource -

start

public void start()

Starts a new synchronization process:

• Calls handleReceivedData() and {link #sync()}, if the underlying SQLite table has at least one item
• Calls download(), if the underlying SQLite table has no item

stop

public void stop()

Stops the ongoing synchronization.
The process can be restarted by calling start().

download

public void download()

Starts a new download.
The DownloadOperation is only been created if:

• no synchronization is ongoing,
• stop() was not called and
• all credentials are passed.

sync

public void sync()

Starts a new synchronization.
The SyncOperation is only been created if:

• no synchronization is ongoing,
• stop() was not called and
• all credentials are passed.

onOperationFailed

public void onOperationFailed(IOperation operation)

Description copied from interface: IOperationDelegate

Notifies this listener that the watched IOperation failed. This only indicates an exception during the execution and is independent from the operation's result code.

Specified by:

onOperationFailed in interface IOperationDelegate

Parameters:

operation - The watched IOperation.

onOperationFinished

public void onOperationFinished(IOperation operation)

Description copied from interface: IOperationDelegate

Notifies this listener that the watched IOperation finished.
Use the IOperation.getResultCode() to validate the success of the operation. E.g. for a remote operation:

 switch (operation.getResultCode()) {
 case HttpConnection.HTTP_OK:
        break;
 case HttpConnection.HTTP_FORBIDDEN:
        break;
 }
 

Specified by:

onOperationFinished in interface IOperationDelegate

Parameters:

operation - The watched IOperation.

setAppname

public void setAppname(java.lang.String appname)

Sets the app name.
Calls updateCredentials() to update the Context.

Parameters:

port -

See Also:

updateCredentials()

setVersion

public void setVersion(java.lang.String version)

Sets the version number.
Calls updateCredentials() to update the Context.

Parameters:

port -

See Also:

updateCredentials()

setMscAlias

public void setMscAlias(java.lang.String mscAlias)

Sets the msc alias.
Calls updateCredentials() to update the Context.

Parameters:

port -

See Also:

updateCredentials()

setUsername

public void setUsername(java.lang.String username)

Sets the user name.
Calls updateCredentials() to update the Context.

Parameters:

port -

See Also:

updateCredentials()

setPassword

public void setPassword(java.lang.String password)

Sets the password.
Calls updateCredentials() to update the Context.

Parameters:

port -

See Also:

updateCredentials()

setHostname

public void setHostname(java.lang.String hostname)

Sets the host name.
Calls updateCredentials() to update the Context.

Parameters:

port -

See Also:

updateCredentials()

setPort

public void setPort(java.lang.String port)

Sets the port.
Calls updateCredentials() to update the Context.

Parameters:

port -

See Also:

updateCredentials()

setDeviceType

public void setDeviceType(java.lang.String deviceType)

Sets the device type.
The default value is the property value for mobiledesigner.device.name. Calls updateCredentials() to update the Context.

Parameters:

deviceType -

See Also:

updateCredentials()

setUpdateInterval

public void setUpdateInterval(long updateInterval)

Sets the update interval for the SyncOperation.

Parameters:

updateInterval -

setUseHttps

public void setUseHttps(boolean usesHttps)

Sets a boolean value indicating if a secure connection should be used.

Parameters:

useHttps -

getAppname

public java.lang.String getAppname()

Sets the app name.

Returns:

getVersion

public java.lang.String getVersion()

Returns the version number.

Returns:

getMscAlias

public java.lang.String getMscAlias()

Returns the msc alias.

Returns:

getUsername

public java.lang.String getUsername()

Returns the user name.

Returns:

getPassword

public java.lang.String getPassword()

Returns the password.

Returns:

getHostname

public java.lang.String getHostname()

Returns the host name.

Returns:

getPort

public java.lang.String getPort()

Returns the port.

Returns:

getDeviceType

public java.lang.String getDeviceType()

Returns the device type.

getUpdateInterval

public long getUpdateInterval()

Returns the update interval for the SyncOperation.

Returns:

usesHttps

public boolean usesHttps()

Returns a boolean value indicating if a secure connection is used.

Returns:

getSQLStore

public ISQLiteConnector getSQLStore()

Returns the ISQLiteConnector.
On overwriting, be sure to return a subclass of SyncClientSQLiteConnectorImpl.

Returns:

update

public void update(Observable observable,
          java.lang.Object object)

Empty implementation of Observer.update(Observable, Object) to allow subclasses to watch on Observer changes.

Specified by:

update in interface Observer

Parameters:

observable -

object -

addListener

public void addListener(ISyncClientListener listener)

Adds the passed ISyncClientListener.

Parameters:

listener -

removeListener

public void removeListener(ISyncClientListener listener)

Removes the passed ISyncClientListener.

Parameters:

listener -

usesSharedSession

public boolean usesSharedSession()

Returns true indicating that the credentials are used from the current Session.

Returns:

See Also:

Session.get(), Session.getCredentials()