java.lang.Object
- com.esri.arcgisruntime.ogc.wmts.WmtsService

All Implemented Interfaces:

RemoteResource, Loadable
```
public final class WmtsService
extends Object
implements Loadable, RemoteResource
```
Represents the service for a Web Map Tile Service (WMTS). This is used to obtain WmtsServiceInfo.

Since:

100.1.0

See Also:

WmtsServiceInfo

Constructor Summary

Constructors
Constructor Description

WmtsService(String url)
Creates an instance of WmtsService from a URL.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addDoneLoadingListener(Runnable listener)`	Adds a listener to the loadable resource that is invoked when loading has completed.
`void`	`addLoadStatusChangedListener(LoadStatusChangedListener listener)`	Adds a `LoadStatusChangedListener` to the loadable resource that is invoked whenever the load status changes.
`void`	`cancelLoad()`	Cancels loading metadata for the object.
`Credential`	`getCredential()`	Gets the `Credential` that is set on the network-enabled resource.
`Map<String,String>`	`getCustomParameters()`	Gets a `Map` containing custom parameters that are applied to all GetCapabilities and GetTile requests related to this service.
`ArcGISRuntimeException`	`getLoadError()`	Returns the most recent error that was encountered when the loadable resource transitioned to the `LoadStatus.FAILED_TO_LOAD` state, either due to calling the `Loadable.loadAsync()` or `Loadable.retryLoadAsync()` method.
`LoadStatus`	`getLoadStatus()`	Returns the `LoadStatus` of the loadable resource.
`RequestConfiguration`	`getRequestConfiguration()`	Gets the `RequestConfiguration` used to modify the parameters of network requests made by this `RemoteResource`.
`WmtsServiceInfo`	`getServiceInfo()`	Gets the service info.
`String`	`getUri()`	Gets the URL of the WMTS.
`void`	`loadAsync()`	Loads the metadata of the loadable resource asynchronously.
`boolean`	`removeDoneLoadingListener(Runnable listener)`	Removes a done loading listener from the loadable resource.
`boolean`	`removeLoadStatusChangedListener(LoadStatusChangedListener listener)`	Removes a `LoadStatusChangedListener` from the loadable resource.
`void`	`retryLoadAsync()`	Loads or retries loading metadata for the object asynchronously.
`void`	`setCredential(Credential credential)`	Sets a `Credential` to be used by the network-enabled resource in the event of an authentication challenge.
`void`	`setRequestConfiguration(RequestConfiguration requestConfiguration)`	Sets the `RequestConfiguration` used to modify the parameters of network requests made by this `RemoteResource`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - WmtsService
```
public WmtsService(String url)
```
    Creates an instance of WmtsService from a URL.
    
    Parameters:
    
    url - the WMTS service URL
    
    Throws:
    
    IllegalArgumentException - if the URL is null or empty
    
    Since:
    
    100.1.0
- Method Detail
  - getServiceInfo
```
public WmtsServiceInfo getServiceInfo()
```
    Gets the service info.
    
    Returns:
    
    the service info
    
    Since:
    
    100.1.0
  - getCustomParameters
```
public Map<String,String> getCustomParameters()
```
    Gets a Map containing custom parameters that are applied to all GetCapabilities and GetTile requests related to this service. Modify this Map to change the parameters that are used. These values will be overridden if used together with a WmtsLayer that specifies different values for the same parameters. Parameters intended for GetCapabilities requests should be set before the service is loaded.
    
    Returns:
    
    a modifiable Map; the keys are parameters names and the values are parameters values
    
    Since:
    
    100.6.0
  - getLoadStatus
```
public LoadStatus getLoadStatus()
```
    Description copied from interface: Loadable
    
    Returns the LoadStatus of the loadable resource.
    
    Specified by:
    
    getLoadStatus in interface Loadable
    
    Returns:
    
    the LoadStatus of the loadable resource
  - getLoadError
```
public ArcGISRuntimeException getLoadError()
```
    Description copied from interface: Loadable
    
    Returns the most recent error that was encountered when the loadable resource transitioned to the LoadStatus.FAILED_TO_LOAD state, either due to calling the Loadable.loadAsync() or Loadable.retryLoadAsync() method.
    If the resource subsequently transitions to LoadStatus.LOADED (for example, if a call to retryLoadAsync completes successfully) the error is cleared out.
    
    Specified by:
    
    getLoadError in interface Loadable
    
    Returns:
    
    the most recent error that was encountered when the loadable resource transitioned to the LoadStatus.FAILED_TO_LOAD state.
  - 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, use the Loadable.addLoadStatusChangedListener(LoadStatusChangedListener) method 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
  - getUri
```
public String getUri()
```
    Gets the URL of the WMTS.
    
    Specified by:
    
    getUri in interface RemoteResource
    
    Returns:
    
    the URL of the WMTS
    
    Since:
    
    100.1.0
  - 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

Class WmtsService

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WmtsService

Method Detail

getServiceInfo

getCustomParameters

getLoadStatus

getLoadError

cancelLoad

loadAsync

retryLoadAsync

addDoneLoadingListener

removeDoneLoadingListener

addLoadStatusChangedListener

removeLoadStatusChangedListener

getUri

getCredential

setCredential

getRequestConfiguration

setRequestConfiguration