GeoServer WMS Stores

A WMS store is a store whose source is another WMS. Also known as "Cascading WMS" or "Exernal WMS".
More information: http://geoserver.org/comm/
Contact Info: geoserver-users@sourceforge.net
Version: 1.0.0
BasePath:/geoserver/rest
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

Methods

[ Jump to Models ]

Table of Contents

WMSStores

WMSStores

Up
delete /workspaces/{workspace}/wmsstores/{store}
Delete WMS store (deleteWMSStore)
Deletes a WMS store

Path parameters

workspace (required)
Path Parameter — Name of the workspace containing the WMS store.
store (required)
Path Parameter — Name of the WMS store

Query parameters

recurse (optional)
Query Parameter — When set to true all resources contained in the store are also removed. default: false

Responses

200

OK

401

Unauthorized

Up
delete /workspaces/{workspace}/wmsstores
(deleteWMSStores)
Invalid. Use /workspaces/{workspace}/wmsstores/{wmsstore} instead.

Responses

401

Unauthorized

405

Method Not Allowed

Up
get /workspaces/{workspace}/wmsstores/{store}
Retrieve a WMS store in a given workspace (getWMSStore)
Displays a representation of the WMS store. Use the "Accept:" header to specify format or append an extension to the endpoint (example "/workspaces/{workspace}/wmsstores/{store}.xml" for XML). Defaults to HTML representation.

Path parameters

workspace (required)
Path Parameter — The name of the workspace containing the WMS store.
store (required)
Path Parameter — The name of the store to be retrieved

Query parameters

quietOnNotFound (optional)
Query Parameter — When set to true, avoids to log an Exception when the WMS store is not present. Note that 404 status code will be returned anyway.

Return type

WMSStoreInfo

Example data

Content-Type: application/json
"{\"wmsStore\": {\n  \"name\":\"altgs\",\n  \"type\":\"WMS\",\n  \"enabled\":true,\n  \"workspace\": {\"name\":\"cite\", \"href\":\"http://localhost:8080/geoserver/rest/workspaces/cite.json\"},\n  \"metadata\": {\"entry\":{\"@key\":\"useConnectionPooling\",\"$\":\"true\"}},\n  \"_default\":false,\n  \"capabilitiesURL\":\"http://localhost:8081/geoserver/wms?request=GetCapabilities\",\n  \"maxConnections\":6,\n  \"readTimeout\":60,\n  \"connectTimeout\":30,\n  \"wmsLayers\":\"http://localhost:8080/geoserver/rest/workspaces/cite/wmsstores/altgs/wmslayers.json\"}}\n"

Example data

Content-Type: application/xml
"\n  altgs\n  WMS\n  true\n  \n    cite\n    \n  \n  \n    true\n  \n  <__default>false\n  http://localhost:8081/geoserver/wms?request=GetCapabilities\n  6\n  60\n  30\n  \n    \n  \n\n"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK WMSStoreInfo

Example data

Content-Type: application/json
{"wmsStore": {
  "name":"altgs",
  "type":"WMS",
  "enabled":true,
  "workspace": {"name":"cite", "href":"http://localhost:8080/geoserver/rest/workspaces/cite.json"},
  "metadata": {"entry":{"@key":"useConnectionPooling","$":"true"}},
  "_default":false,
  "capabilitiesURL":"http://localhost:8081/geoserver/wms?request=GetCapabilities",
  "maxConnections":6,
  "readTimeout":60,
  "connectTimeout":30,
  "wmsLayers":"http://localhost:8080/geoserver/rest/workspaces/cite/wmsstores/altgs/wmslayers.json"}}

Example data

Content-Type: application/xml

  altgs
  WMS
  true
  
    cite
    
  
  
    true
  
  <__default>false
  http://localhost:8081/geoserver/wms?request=GetCapabilities
  6
  60
  30
  
    
  

401

Unauthorized

Up
get /workspaces/{workspace}/wmsstores
Get a list of WMS stores (getWMSStores)
Displays a list of all WMS stores on the server. Use the "Accept:" header to specify format or append an extension to the endpoint (example "/rest/workspaces/{workspace}/wmsstores.xml" for XML).

Return type

WMSStoresList

Example data

Content-Type: application/xml
"\n  \n    altgs\n    \n  \n\n"

Example data

Content-Type: application/json
"{\"wmsStores\":\n  {\"wmsStore\": [\n    {\"name\":\"altgs\",\n     \"href\":\"http://localhost:8080/geoserver/rest/workspaces/cite/wmsstores/altgs.json\"}]}}\n"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK WMSStoresList

Example data

Content-Type: application/xml

  
    altgs
    
  

Example data

Content-Type: application/json
{"wmsStores":
  {"wmsStore": [
    {"name":"altgs",
     "href":"http://localhost:8080/geoserver/rest/workspaces/cite/wmsstores/altgs.json"}]}}

Up
post /workspaces/{workspace}/wmsstores/{store}
(postWMSStore)
Invalid. Use POST on /workspaces/{workspace}/WMSstores for adding a new WMS store, or PUT on /workspaces/{workspace}/WMSstores/{store} to edit/upload an existing WMS store.

Responses

401

Unauthorized

405

Method Not Allowed

Up
post /workspaces/{workspace}/wmsstores
Add a new WMS store (postWMSStores)
Adds a new WMS store entry to the server.

Path parameters

workspace (required)
Path Parameter — Name of the worskpace containing the WMS store.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

WMSStoreBody WMSStoreInfo (required)
Body Parameter

WMS store body information to upload.

Examples:

  • application/xml:

    <wmsStore>
      <name>remote</name>
      <capabilitiesUrl>http://demo.geoserver.org/geoserver/wms?SERVICE=WMS&VERSION=1.1.1&REQUEST=GetCapabilities</capabilitiesUrl>
    </wmsStore>
    
  • application/json:

    {
      "wmsStore": {
        "name": "remote",
        "capabilitiesUrl": "http://demo.geoserver.org/geoserver/wms?SERVICE=WMS&VERSION=1.1.1&REQUEST=GetCapabilities"
      }
    }
    

Responses

201

Created

401

Unauthorized

Up
put /workspaces/{workspace}/wmsstores/{store}
Modify a single WMS store. (putWMSStore)
Modifies a single WMS store. Use the "Accept:" header to specify format or append an extension to the endpoint (example "{store}.xml" for XML).

Path parameters

workspace (required)
Path Parameter — The name of the worskpace containing the WMS stores.
store (required)
Path Parameter — The name of the store to be retrieved

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

WMSStoreBody WMSStoreInfo (required)
Body Parameter

WMS store body information to upload. For a PUT, only values which should be changed need to be included.

Examples:

  • application/xml:

    <wmsStore>
      <description>A wms store</description>
      <enabled>true</enabled>
      <__default>true</__default>
      <capabilitiesUrl>http://demo.geoserver.org/geoserver/wms?SERVICE=WMS&VERSION=1.1.1&REQUEST=GetCapabilities</capabilitiesUrl>
      <user>admin</user>
      <password>geoserver</password>
      <maxConnections>6</maxConnections>
      <readTimeout>60</readTimeout>
      <connectTimeout>30</connectTimeout>
    </wmsStore>
    
  • application/json:

    {
      "wmsStore": {
        "description": "A wms store",
        "enabled": "true",
        "_default": "true",
        "capabilitiesUrl": "http://demo.geoserver.org/geoserver/wms?SERVICE=WMS&VERSION=1.1.1&REQUEST=GetCapabilities",
        "user": "admin",
        "password": "geoserver",
        "maxConnections": "6",
        "readTimeout": "60",
        "connectTimeout": "30"
      }
    }
    

Responses

200

The WMS store was successfully updated.

401

Unauthorized

Up
put /workspaces/{workspace}/wmsstores
(putWMSStores)
Invalid. Use POST for adding a new WMS store, or PUT on /workspaces/{workspace}/wmsstores/{wmsstore} to edit an existing WMS store.

Responses

401

Unauthorized

405

Method Not Allowed

Models

[ Jump to Methods ]

Table of Contents

  1. WMSStoreInfo - wmsStore
  2. WMSStoreInfo_metadata -
  3. WMSStoreInfo_metadata_entry -
  4. WMSStoreInfo_wmsLayers -
  5. WMSStoreInfo_workspace -
  6. WMSStoresList - wmsStores
  7. WMSStoresListItem - wmsStore

WMSStoreInfo - wmsStore Up

name (optional)
String Name of the WMS store
description (optional)
String Description of the WMS store
type (optional)
String Type of store. Set to WMS.
enabled (optional)
Boolean Whether the store is enabled
workspace (optional)
metadata (optional)
__default__ (optional)
Boolean Whether the store is the default store of the workspace
capabilitiesURL (optional)
String Location of the WMS capabilities URL where the store originates
user (optional)
String User name to use when connecting to the remote WMS
password (optional)
String Password or hash to use when connecting to the remote WMS
maxConnections (optional)
BigDecimal Maximum number of simultaneous connections to use
readTimeout (optional)
String Time in seconds before read time out
connectTimeout (optional)
String Time in seconds before connection time out
wmsLayers (optional)

WMSStoreInfo_metadata - Up

Miscellaneous configuration details about the WMS store
entry (optional)

WMSStoreInfo_metadata_entry - Up

@key (optional)
String Set to useConnectionPooling
Enum:
useConnectionPooling
text (optional)
Boolean Whether connection pooling is enabled

WMSStoreInfo_wmsLayers - Up

link (optional)
String Link to the WMS layers representation

WMSStoreInfo_workspace - Up

Workspace containing the store
name
String Name of the workspace
link (optional)
String Link to the workspace representation

WMSStoresList - wmsStores Up

WMSStoresListItem - wmsStore Up

name (optional)
String Name of WMS Store
link (optional)
String URL to WMS store representation