Module com.esri.arcgisruntime
Package com.esri.arcgisruntime.tasks.offlinemap

Class OfflineMapSyncTask

java.lang.Object
com.esri.arcgisruntime.tasks.offlinemap.OfflineMapSyncTask
All Implemented Interfaces:
RemoteResource, Loadable
public final class OfflineMapSyncTask extends Object implements Loadable, RemoteResource
A task to synchronize an offline map's geodatabases with its originating sync-enabled ArcGIS feature services.

You can take a map offline from a web map using the OfflineMapTask. This can be an offline map created ahead-of-time or an on-demand map. For more information, see the Ahead-of-time vs on-demand workflows. The offline map is stored on the device so its data can be displayed, queried, and edited whilst the device is offline.

You can update the data content by synchronizing the offline map with its source web map. Edits to offline feature data can be posted to the source web map, and any edits to the source web map's feature data content can be downloaded and applied to the offline map. This brings the source web map content and the offline map content into alignment. Edits to features, non-spatial data, related data, and attachments can be synchronized. A network connection must be present for synchronization. Here are typical steps to synchronize data between the offline map and its source web map:

If there are attribute or geometry level conflicts on a feature during synchronization, the most recently synchronized edit will be applied. For example, if both user A and user B edit the same feature while offline, if user A synchronizes their edits first, after which user B synchronizes their edits, then the updated feature will represent the edits made by user B.

Synchronization errors typically occur because of network connectivity issues during the sync process. The synchronization mechanism is robust to these types of errors, however, and they can be resolved by synchronizing again when a reliable network connection becomes available.

If you created the offline map using the ahead-of-time workflow, it may support a synchronization workflow known as update packages. Update packages optimize updating the data contents of a downloaded offline map to the latest contents of the source web map. For more information, see Update packages.

If you want to download and synchronize individual feature services to a single offline geodatabase, instead of taking a map offline, then you can use the GeodatabaseSyncTask.

Since:
100.1.0

  • Property Details

  • Constructor Details

    • OfflineMapSyncTask

      public OfflineMapSyncTask(ArcGISMap map)
      Constructs an OfflineMapSyncTask for synchronizing the geodatabases used by the given map.
      Parameters:
      map - an ArcGISMap to be synchronized
      Throws:
      IllegalArgumentException - if map is null
      Since:
      100.1.0

  • Method Details

    • setCredential

      public void setCredential(Credential credential)
      Sets the credential used to authenticate the user with this task.
      Specified by:
      setCredential in interface RemoteResource
      Parameters:
      credential - the credential used to authenticate the user with this task
      Since:
      100.1.0

    • getCredential

      public Credential getCredential()
      Gets the credential used to authenticate the user with this task.
      Specified by:
      getCredential in interface RemoteResource
      Returns:
      the credential, or null if there is none
      Since:
      100.1.0

    • setRequestConfiguration

      public void setRequestConfiguration(RequestConfiguration requestConfiguration)
      Sets configuration parameters used for network requests sent using this task. The global RequestConfiguration is used if no RequestConfiguration is set.
      Specified by:
      setRequestConfiguration in interface RemoteResource
      Parameters:
      requestConfiguration - contains the configuration parameters to use
      Since:
      100.1.0

    • getRequestConfiguration

      public RequestConfiguration getRequestConfiguration()
      Gets the RequestConfiguration object in use by this task.
      Specified by:
      getRequestConfiguration in interface RemoteResource
      Returns:
      the RequestConfiguration object, or null if none has been set
      Since:
      100.1.0
      See Also:

    • getUri

      public String getUri()
      Throws an UnsupportedOperationException because OfflineMapSyncTask doesn't have a URI.
      Specified by:
      getUri in interface RemoteResource
      Returns:
      the URI of this RemoteResource
      Throws:
      UnsupportedOperationException - always
      Since:
      100.1.0

    • getMap

      public ArcGISMap getMap()
      Gets the map associated with this task.
      Returns:
      the map
      Since:
      100.1.0

    • getUpdateCapabilities

      public OfflineMapUpdateCapabilities getUpdateCapabilities()
      Gets a description of the methods that can be used to obtain updates to the offline map.

      You can use this property to determine whether an offline map is configured to use the update packages (see OfflineMapUpdateCapabilities.isSupportsScheduledUpdatesForFeatures()) or to sync directly with feature services (see OfflineMapUpdateCapabilities.isSupportsSyncWithFeatureServices())). If the offline map was created using PreplannedUpdateMode.DOWNLOAD_SCHEDULED_UPDATES_AND_UPLOAD_NEW_FEATURES, it will support both update modes, but you will only be able to upload newly created features.

      Returns:
      the update capabilities, or null if this OfflineMapSyncTask is not loaded
      Since:
      100.6.0

    • checkForUpdatesAsync

      public ListenableFuture<OfflineMapUpdatesInfo> checkForUpdatesAsync()
      Retrieves OfflineMapUpdatesInfo for the offline map that was used to construct this task.

      The returned OfflineMapUpdatesInfo provides high level information on what updates are available for this offline map. Information is provided on:

      • Online changes that can be applied to update your offline map
      • Local changes from your offline map that can be sent back to the online services

      Calling this method provides high-level information on the available updates. It can help you to determine whether to call syncOfflineMap(OfflineMapSyncParameters) immediately, based upon factors such as current disk space and network availability. Examine these properties before starting the potentially time-consuming offline map sync process.

      The resulting OfflineMapUpdatesInfo provides a snap-shot of available updates when this method was called. To check for new updates you need to call this method again.

      Returns:
      a ListenableFuture for tracking when the operation is done and getting the result; also allows cancellation
      Since:
      100.6.0

    • createDefaultOfflineMapSyncParametersAsync

      public ListenableFuture<OfflineMapSyncParameters> createDefaultOfflineMapSyncParametersAsync()
      This populates the parameters with values appropriate for synchronizing the feature data in this offline map.

      The default parameters will reflect the mobile geodatabases used by the offline map.

      Returns:
      a ListenableFuture of OfflineMapSyncParameters
      Since:
      100.6.0
      See Also:

    • syncOfflineMap

      public OfflineMapSyncJob syncOfflineMap(OfflineMapSyncParameters parameters)
      Returns a job to synchronize an offline map's geodatabases with their originating services.

      You should not execute more than one sync on a particular geodatabase at the same time. This includes any operations that export or import deltas from the local Geodatabase:

      Parameters:
      parameters - parameters controlling the offline map synchronization
      Returns:
      the OfflineMapSyncJob; note you must call Job.start() to start the Job
      Throws:
      IllegalArgumentException - if parameters is null
      Since:
      100.1.0
      See Also:

    • getLoadStatus

      public LoadStatus getLoadStatus()
      Gets the value of the loadStatus property.
      Specified by:
      getLoadStatus in interface Loadable
      Property description:
      Returns:
      the value of the loadStatus property
      See Also:

    • getLoadError

      public ArcGISRuntimeException getLoadError()
      Gets the value of the loadError property.
      Specified by:
      getLoadError in interface Loadable
      Property description:
      Returns:
      the value of the loadError property
      See Also:

    • cancelLoad

      public void cancelLoad()
      Description copied from interface: Loadable
      Cancels loading metadata for the object.

      Cancels loading the metadata if the object is loading, and always invokes the done loading listener.

      A load operation that is in progress (LoadStatus.LOADING state) can be cancelled by calling this method and the resource will transition from LoadStatus.LOADING to LoadStatus.FAILED_TO_LOAD state. If the load operation was successfully cancelled, a CancellationException will be returned from Loadable.getLoadError().

      Cancellation should be used carefully because all enqueued done loading listeners for that resource instance will get invoked with an error stating that the operation was cancelled. Thus, one component in the application can cancel the load operation initiated by other components.

      This method does nothing if the resource is not in LoadStatus.LOADING state.

      Specified by:
      cancelLoad in interface Loadable

    • loadAsync

      public void loadAsync()
      Description copied from interface: Loadable
      Loads the metadata of the loadable resource asynchronously.

      The load status changes from LoadStatus.NOT_LOADED to LoadStatus.LOADING. A listener can be added via Loadable.addDoneLoadingListener(java.lang.Runnable) that is invoked upon completion of the asynchronous load operation.

      If the load operation completes successfully, the load status will be LoadStatus.LOADED, which means the resource has loaded its metadata.

      If the load operation failed, the load status will be LoadStatus.FAILED_TO_LOAD and the error can be retrieved by calling Loadable.getLoadError().

      This method can be called concurrently and repeatedly, but only one attempt is ever made to perform the load operation. If a load operation is already in progress (LoadStatus.LOADING state) when loadAsync is called, it simply piggy-backs on the outstanding operation and the done loading listener added to the loadable resource is enqueued to be invoked when that operation completes. If the operation has already completed (LoadStatus.LOADED or LoadStatus.FAILED_TO_LOAD state) when loadAsync is called, the done loading listener is immediately invoked when added to the loadable resource.

      If a loadable resource has failed to load, calling loadAsync on it subsequently will not change its state. The done loading listener will be invoked immediately when added to the loadable resource. In order to retry loading the resource, Loadable.retryLoadAsync() needs to be used.

      A load operation that is in progress (LoadStatus.LOADING state) can be cancelled by calling Loadable.cancelLoad().

      Specified by:
      loadAsync in interface Loadable

    • retryLoadAsync

      public void retryLoadAsync()
      Description copied from interface: Loadable
      Loads or retries loading metadata for the object asynchronously.

      Will retry loading the metadata if the object's load status is LoadStatus.FAILED_TO_LOAD. Will load the object if it is not loaded. Will not retry to load the object if the object is loaded.

      For more details on the load process see Loadable.loadAsync().

      Specified by:
      retryLoadAsync in interface Loadable

    • addDoneLoadingListener

      public void addDoneLoadingListener(Runnable listener)
      Description copied from interface: Loadable
      Adds a listener to the loadable resource that is invoked when loading has completed.

      The listener may be added at any point, whether the loadable resource has already completed loading or not.

      • For resources that are not loaded when the listener is added (LoadStatus is NOT_LOADED or LOADING): When the resource completes loading, the listener will be invoked on the UI thread if it is added from the UI thread, otherwise it is not guaranteed on which thread the listener is invoked.
      • For resources that are already loaded when the listener is added (LoadStatus is LOADED or FAILED_TO_LOAD): The listener will be called immediately, on the current thread.

      Alternatively, to be notified when there is any change in the load status, add a listener to the Loadable.loadStatusProperty() instead.

      Specified by:
      addDoneLoadingListener in interface Loadable
      Parameters:
      listener - a Runnable that is invoked upon completion of the load operation

    • removeDoneLoadingListener

      public boolean removeDoneLoadingListener(Runnable listener)
      Description copied from interface: Loadable
      Removes a done loading listener from the loadable resource.
      Specified by:
      removeDoneLoadingListener in interface Loadable
      Parameters:
      listener - the listener to be removed
      Returns:
      true if the listener was removed, otherwise false

    • addLoadStatusChangedListener

      public void addLoadStatusChangedListener(LoadStatusChangedListener listener)
      Description copied from interface: Loadable
      Adds a LoadStatusChangedListener to the loadable resource that is invoked whenever the load status changes.

      Adding this listener on the UI thread will cause it to be invoked on the UI thread, otherwise it is not guaranteed on which thread the listener is invoked.

      The listener will not be called if added to a loadable resource that has already completed loading. To be notified when a loadable resource has completed loading, including if the resource is already loaded when the listener is added, use the Loadable.addDoneLoadingListener(Runnable) method.

      Specified by:
      addLoadStatusChangedListener in interface Loadable
      Parameters:
      listener - the LoadStatusChangedListener to be added

    • removeLoadStatusChangedListener

      public boolean removeLoadStatusChangedListener(LoadStatusChangedListener listener)
      Description copied from interface: Loadable
      Removes a LoadStatusChangedListener from the loadable resource.
      Specified by:
      removeLoadStatusChangedListener in interface Loadable
      Parameters:
      listener - the LoadStatusChangedListener to be removed
      Returns:
      true if the listener was removed, otherwise false

    • loadStatusProperty

      public ReadOnlyObjectProperty<LoadStatus> loadStatusProperty()
      Description copied from interface: Loadable
      The load status.
      Specified by:
      loadStatusProperty in interface Loadable
      Returns:
      the loadStatus property
      See Also:

    • loadErrorProperty

      public ReadOnlyObjectProperty<ArcGISRuntimeException> loadErrorProperty()
      Description copied from interface: Loadable
      The load error.
      Specified by:
      loadErrorProperty in interface Loadable
      Returns:
      the loadError property
      See Also: