Module com.esri.arcgisruntime
Package com.esri.arcgisruntime.tasks.geoprocessing

Class GeoprocessingTask

java.lang.Object
com.esri.arcgisruntime.tasks.geoprocessing.GeoprocessingTask
All Implemented Interfaces:
RemoteResource, Loadable
public final class GeoprocessingTask extends Object implements RemoteResource, Loadable

The GeoprocessingTask class is used to run a geoprocessing task that is published as a web service.

Geoprocessing task is the main component when running geoprocessing tasks. The task might be published through ArcGIS Server or Local server (on the platforms that supports it) using either synchronous execute or asynchronous submit execution type. When GeoprocessingParameters is created it is important to match GeoprocessingParameters.ExecutionType to the value on the service.

Since:
100.0.0

  • Property Details

  • Constructor Details

    • GeoprocessingTask

      public GeoprocessingTask(String url)
      Creates an instance of a task.
      Parameters:
      url - the URL of the task.
      Since:
      100.0.0

  • Method Details

    • createJob

      public GeoprocessingJob createJob(GeoprocessingParameters parameters)
      Returns a geoprocessing job based on the supplied parameters. You must call start on the job to start it executing. It is not recommended to re-use these parameters to create another job as the values maybe be updated on job completion e.g. GeoprocessingDataFile parameters created with a local file path will be updated with an upload ID.
      Parameters:
      parameters - the parameters
      Returns:
      the job
      Throws:
      IllegalArgumentException - if parameters is null
      Since:
      100.0.0

    • createDefaultParametersAsync

      public ListenableFuture<GeoprocessingParameters> createDefaultParametersAsync()
      Asynchronously generates default parameters for a geoprocessing task. This will populate the parameters with default values for all of the input parameters. The correct execution type for this task will also be set.
      Returns:
      a listenable future that will be done when the default parameters have been generated
      Since:
      100.1.0

    • getGeoprocessingTaskInfo

      public GeoprocessingTaskInfo getGeoprocessingTaskInfo()
      Gets the task's geoprocessing service info.
      Returns:
      the task's info
      Since:
      100.1.0

    • getCredential

      public Credential getCredential()
      Gets the credential used to authenticate the user with the geoprocessing service.
      Specified by:
      getCredential in interface RemoteResource
      Returns:
      the credential used for authentication
      Since:
      100.0.0

    • setCredential

      public void setCredential(Credential credential)
      Sets the credential used to authenticate the user with the geoprocessing service.
      Specified by:
      setCredential in interface RemoteResource
      Parameters:
      credential - the credential used for authentication
      Since:
      100.0.0

    • getRequestConfiguration

      public RequestConfiguration getRequestConfiguration()
      Gets the RequestConfiguration object that contains parameters used when making a request by this task.
      Specified by:
      getRequestConfiguration in interface RemoteResource
      Returns:
      the RequestConfiguration object or default values if nothing was set
      Since:
      100.0.0
      See Also:

    • setRequestConfiguration

      public void setRequestConfiguration(RequestConfiguration requestConfiguration)
      Sets the configuration parameters used for sending a network request using this task object. The global RequestConfiguration is used if no RequestConfiguration is set which contains the default values from the getter/setter methods.
      Specified by:
      setRequestConfiguration in interface RemoteResource
      Parameters:
      requestConfiguration - contains the parameters to use
      Since:
      100.0.0
      See Also:

    • getUri

      public String getUri()
      Gets the web address of the geoprocessing resource referenced by this task.
      Specified by:
      getUri in interface RemoteResource
      Returns:
      the URI of the geoprocessing service
      Since:
      100.0.0

    • 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: