ArcGIS Runtime SDK for Java

WMS Layer (URL)

Shows how to display a WMS layer from a URL.

How it works

To create a WMSLayer from a URL and display it:

  1. Create a WmsLayer specifying the URL of the service and the layer names you want new WmsLayer(url, names).
  2. To display it, add it to the map as an operational layer map.getOperationalLayers().add(wmsLayer).


 * Copyright 2017 Esri.
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.

package com.esri.samples.ogc.wms_layer_url;

import java.util.Collections;
import java.util.List;

import javafx.application.Application;
import javafx.geometry.Pos;
import javafx.scene.Scene;
import javafx.scene.control.Alert;
import javafx.scene.control.ProgressIndicator;
import javafx.scene.layout.StackPane;
import javafx.stage.Stage;

import com.esri.arcgisruntime.layers.WmsLayer;
import com.esri.arcgisruntime.loadable.LoadStatus;
import com.esri.arcgisruntime.mapping.ArcGISMap;
import com.esri.arcgisruntime.mapping.Basemap;
import com.esri.arcgisruntime.mapping.Viewpoint;
import com.esri.arcgisruntime.mapping.view.MapView;

public class WmsLayerUrlSample extends Application {

  private MapView mapView;

  public void start(Stage stage) {

    try {
      // create stack pane and application scene
      StackPane stackPane = new StackPane();
      Scene scene = new Scene(stackPane);

      // set title, size, and add scene to stage
      stage.setTitle("WMS Layer URL Sample");

      // create a map and add it to the map view
      ArcGISMap map = new ArcGISMap(Basemap.createImagery());
      mapView = new MapView();

      ProgressIndicator progressIndicator = new ProgressIndicator();
      progressIndicator.setMaxSize(25, 25);

      // create a WMS layer
      List<String> wmsLayerNames = Collections.singletonList("0");
      String url = "";
      WmsLayer wmsLayer = new WmsLayer(url, wmsLayerNames);
      // load the layer and add it as an operational layer
      wmsLayer.addDoneLoadingListener(() -> {
        if (wmsLayer.getLoadStatus() == LoadStatus.LOADED) {
          mapView.setViewpoint(new Viewpoint(wmsLayer.getFullExtent()));
        } else {
          Alert alert = new Alert(Alert.AlertType.ERROR, "Failed to load WMS layer");

      // add the map view to stack pane
      stackPane.getChildren().addAll(mapView, progressIndicator);
      StackPane.setAlignment(progressIndicator, Pos.CENTER);
    } catch (Exception e) {
      // on any error, display the stack trace.

   * Stops and releases all resources used in application.
  public void stop() {

    if (mapView != null) {

   * Opens and runs application.
   * @param args arguments passed to this application
  public static void main(String[] args) {



In this topic
  1. How it works
  2. Code