Module com.esri.arcgisruntime
Package com.esri.arcgisruntime.tasks.tilecache

Class ExportTileCacheTask

java.lang.Object
com.esri.arcgisruntime.tasks.tilecache.ExportTileCacheTask
All Implemented Interfaces:
ApiKeyResource, RemoteResource, Loadable
public final class ExportTileCacheTask extends Object implements Loadable, RemoteResource, ApiKeyResource
A task used to export a tile cache (.tpk or .tpkx). Use this in conjunction with a map or image service to generate and download tile packages.

To confirm whether a map or image service supports exporting tiles, check:

See TileCache for information on creating a layer from a local tile cache.

When using Esri provided imagery basemaps (such as the BasemapStyle.ARCGIS_IMAGERY), an alternative service that supports exporting tiles may be used instead. For example, the World Imagery Service will be exported using a corresponding export-enabled service: Map Server.

Similarly, when using elevation data from Esri (such as Terrain 3D), an alternative service that supports exporting tiles may be used instead. For example, the WorldElevation3D/Terrain3D, will be exported using a corresponding export-enabled service: Image Server. The resulting tile cache can then be used to create an offline ArcGISTiledElevationSource in a scene.

Note that these export-enabled services are not intended for use as an online basemap and should only be used for exporting tiles for offline use. The export enabled services require authentication to export tiles.

Since:
100.0.0
See Also:

  • Property Details

  • Field Details

  • Constructor Details

    • ExportTileCacheTask

      public ExportTileCacheTask(String url)
      Creates an ExportTileCacheTask from a URL to an ArcGIS Map Service or Image Service.
      Parameters:
      url - a URL to an ArcGIS Map Service or Image Service
      Throws:
      IllegalArgumentException - if the url is null or empty
      Since:
      100.0.0

  • Method Details

    • getCredential

      public Credential getCredential()
      Description copied from interface: RemoteResource
      Gets the Credential that is set on the network-enabled resource.

      Only applicable if the resource is secured.

      Specified by:
      getCredential in interface RemoteResource
      Returns:
      the Credential, or null if there is none

    • setCredential

      public void setCredential(Credential credential)
      Description copied from interface: RemoteResource
      Sets a Credential to be used by the network-enabled resource in the event of an authentication challenge. The default credential is null.

      Only applicable if the resource is secured.

      Specified by:
      setCredential in interface RemoteResource
      Parameters:
      credential - the Credential to be used for authentication

    • getRequestConfiguration

      public RequestConfiguration getRequestConfiguration()
      Description copied from interface: RemoteResource
      Gets the RequestConfiguration used to modify the parameters of network requests made by this RemoteResource.
      Specified by:
      getRequestConfiguration in interface RemoteResource
      Returns:
      the RequestConfiguration used to modify network requests

    • setRequestConfiguration

      public void setRequestConfiguration(RequestConfiguration requestConfiguration)
      Description copied from interface: RemoteResource
      Sets the RequestConfiguration used to modify the parameters of network requests made by this RemoteResource. If not set, the global RequestConfiguration will be used (see RequestConfiguration.getGlobalRequestConfiguration()).
      Specified by:
      setRequestConfiguration in interface RemoteResource
      Parameters:
      requestConfiguration - the RequestConfiguration used to modify network requests

    • getUri

      public String getUri()
      Description copied from interface: RemoteResource
      Gets the URI of this RemoteResource. Typically this is the URI used to instantiate the object.
      Specified by:
      getUri in interface RemoteResource
      Returns:
      the URI of this RemoteResource

    • getMapServiceInfo

      public ArcGISMapServiceInfo getMapServiceInfo()
      Gets the task's map service info. If the ExportTileCacheTask instance is created with a URL, this property will be populated after the task has been loaded.

      In the case of Esri provided image basemaps or elevation sources, the meta-data will be for the exported-enabled version of the service.

      Returns:
      the task's map service info
      Since:
      100.0.0

    • estimateTileCacheSize

      public EstimateTileCacheSizeJob estimateTileCacheSize(ExportTileCacheParameters exportTileCacheParameters)
      Returns a new EstimateTileCacheSizeJob.

      Note - you need to call Job.start() to start the job.

      Parameters:
      exportTileCacheParameters - export tile cache parameters to be used in estimating
      Returns:
      an EstimateTileCacheSizeJob representing the async operation of estimating a tile cache size, the result will be an EstimateTileCacheSizeResult object if completed successfully
      Throws:
      IllegalArgumentException - if exportTileCacheParameters is null
      Since:
      100.4.0

    • exportTileCache

      public ExportTileCacheJob exportTileCache(ExportTileCacheParameters exportTileCacheParameters, String fileNameWithPath)
      Return a new export tile cache job.

      The resulting job will export tiles from the service, which is referenced by the getUri() property (or its export-enabled alternative), to a local tile cache at the fileNameWithPath. The format of the tile cache is determined by the file extension supplied in the fileNameWithPath parameter.

      • If the download file path ends with ".tpk", the tile cache will use the legacy compact format.
      • If the download file path ends with ".tpkx", the tile cache will use the current compact version 2 format.
      The job will fail if the service does not support exporting tiles, and if a .tpkx format was requested but the format is not supported by the service. The precise reason for failure is reported by ArcGISRuntimeException.getErrorCode().
      Parameters:
      exportTileCacheParameters - export tile cache parameters to be used in exporting
      fileNameWithPath - downloaded tile cache file path that ends with .tpk or .tpkx, depending on the desired format.
      Throws:
      IllegalArgumentException - if exportTileCacheParameters is null
      IllegalArgumentException - if fileNameWithPath is null
      Since:
      100.4.0
      See Also:

    • createDefaultExportTileCacheParametersAsync

      public ListenableFuture<ExportTileCacheParameters> createDefaultExportTileCacheParametersAsync(Geometry areaOfInterest, double minScale, double maxScale)
      Creates a default set of export tile cache parameters asynchronously.

      This function is asynchronous because it makes use of the service metadata to build a ExportTileCacheParameters object. Calling the function will trigger load of the ExportTileCacheTask, unless it's already loaded.

      The supported geometry types for the area of interest are Envelope and Polygon. The area of interest must have a spatial reference. When a Polygon is supplied, tiles will be filtered according to the polygon geometry, which can help reduce the size of the resulting tile package. Note that the filtered set of tiles may vary, depending on the underlying service.

      The value of min_scale must be larger than the value of max_scale, unless they are 0. A min_scale value of 0 will result in this method choosing the services smallest level number, typically level 0.

      Similarly, a max_scale of 0 will result in the services largest level number being used, representing the closest in view being visible when taken offline. If min_scale is between the scales of tile levels the previous smallest level is used.

      If max_scale is between tile levels the next level is taken to ensure it is displayed. For example a simple service has 4 levels: level 0 scale 2000000; level 1 scale 1000000; level 2 scale 500000; level 3 scale 250000.

      A min_scale of 0 and max_scale of 0 selects all levels 0,1,2,3.

      A min_scale of 750000 (between levels 1 and 2) and a max_scale of 25000 (at level 3) will select levels 1,2,3.

      A min_scale of 0 and a max_scale 750000 (between 1 and 2) will select levels 0,1,2.

      A min_scale of 1000000 and a max_scale of 0 will select all levels from 1 onwards 1,2,3.

      Be careful when combining a large extent or a wide range of scales, this can result in the export failing due to exceeding the services maximum export tile count.

      Parameters:
      areaOfInterest - the geometry specifying the area to be exported, must be an Envelope or a Polygon
      minScale - the map scale '1:minScale' above which LODs should be exported, can be 0 in which case this parameter is ignored
      maxScale - the map scale '1:maxScale' below which LODs should be exported, can be 0 in which case this parameter is ignored
      Returns:
      a ListenableFuture containing the ExportTileCacheParameters object being created asynchronously
      Throws:
      IllegalArgumentException - if areaOfInterest is null or anything other than an Envelope or a Polygon
      Since:
      100.0.0

    • getApiKey

      public String getApiKey()
      Description copied from interface: ApiKeyResource
      Gets the API key to access API key enabled services and resources in ArcGIS Online.

      An API key is a unique long-lived access token that is used to authenticate and monitor requests to ArcGIS location services and private portal items. You can create and manage an API key using your portal when you sign in with an ArcGIS Location Platform account or an ArcGIS Online account with administrator access or a custom role that has the Generate API keys privilege. To learn how to create and manage API keys, go to the Create an API Key tutorial. You must ensure that your API key has the correct privileges to access secure resources.

      In addition to setting an API key at a global level for your application using ArcGISRuntimeEnvironment.setApiKey(String), you can call ApiKeyResource.setApiKey(String) on any class that implements ApiKeyResource. When you call setApiKey(String) on an APIKeyResource, it will override the default key at the global level (the key returned by ArcGISRuntimeEnvironment.getApiKey(), in other words), enabling more granular usage telemetry and management for ArcGIS Online resources used by your app.

      Classes that expose an API key property by implementing APIKeyResource include:

      Specified by:
      getApiKey in interface ApiKeyResource
      Returns:
      the API key to access API key enabled services and resources in ArcGIS Online
      See Also:

    • setApiKey

      public void setApiKey(String apiKey)
      Description copied from interface: ApiKeyResource
      Sets the API key to access API key enabled services and resources in ArcGIS Online.

      An API key is a unique key used to authorize access to specific services and resources in ArcGIS Online. It is also used to monitor access to those services. An API key is created and managed in the ArcGIS developer dashboard and is tied to a specific ArcGIS account.

      In addition to setting an API key at a global level for your application using ArcGISRuntimeEnvironment.setApiKey(String), you can call setApiKey(String) on any class that implements ApiKeyResource. When you call setApiKey(String) on an APIKeyResource, it will override the default key at the global level (the key returned by ArcGISRuntimeEnvironment.getApiKey(), in other words), enabling more granular usage telemetry and management for ArcGIS Online resources used by your app.

      Classes that expose an API key property by implementing APIKeyResource include:

      Specified by:
      setApiKey in interface ApiKeyResource
      Parameters:
      apiKey - the API key to access API key enabled services and resources in ArcGIS Online
      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: