GeoWebCache Seeding and Truncating

A layer is a published resource (feature type or coverage).
More information: http://geoserver.org/comm/
Contact Info: geoserver-users@sourceforge.net
Version: 1.0.0
BasePath:/geoserver/gwc/rest
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

Methods

[ Jump to Models ]

Table of Contents

GwcSeed

GwcSeed

Up
get /seed/{layer}.{format}
Query's the currently running GWC task for a given layer (layerSeedGet)
Returns HTML of the GeoWebCache Seed ui page or a json array of the status for currently running task of a given layer if using json extension. The json array contains a set of long in the following order:[tiles processed, total number of tiles to process, number of remaining tiles, Task ID, Task status]

Path parameters

layer (required)
Path Parameter — The name of the layer to query GWC task.
format (required)
Path Parameter — Based on format, the request will return an application/html or application/json response.

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

Example data

Content-Type: application/json
{"long-array-array":[
  [364832,2761733810,998564,16,1],
  [373472,2761733810,975448,17,1],
]}

Example data

Content-Type: text/html

  GWC Seed Form
   {contents of GeoWebCache Seed Form} 

400

Bad Request

Up
post /seed/{layer}.{format}
Issue a seed, reseed or truncate task request (layerSeedPost)
Executes an issue to seed, reseed or truncate task request for a layer and returns HTML UI page of running GWC tasks and tasks to execute.

Path parameters

layer (required)
Path Parameter — The name of the layer to query GWC task.

Consumes

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

Request body

requestBody seedRequest (optional)
Body Parameter — The updated layer definition.

Responses

201

Successfully created seed, reseed, or truncate request

400

Bad Request

Up
get /seed.json
Query's currently running GWC task (seedGet)
Query's and returns a json array of the status for all currently running task. Requires json extension in the request. The array contains a set of long in the following order:[tiles processed, total number of tiles to process, number of remaining tiles, Task ID, Task status]. The returned task status will be one of -1 = ABORTED, 0 = PENDING, 1 = RUNNING, 2 = DONE

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

Example data

Content-Type: application/json
{"long-array-array":[
  [364832,2761733810,998564,16,1],
  [373472,2761733810,975448,17,1],
  [363760,2761733810,1001509,18,1]
]}

Models

[ Jump to Methods ]

Table of Contents

  1. seedRequest - seedRequest
  2. seedRequest_bounds -
  3. seedRequest_parameters -
  4. seedRequest_parameters_entry -

seedRequest - seedRequest Up

name (optional)
String name of the layer to seed, reseed, or truncate.
bounds (optional)
gridSetId (optional)
String The projection used for the layer.
zoomStart (optional)
Integer The zoom level to start seeding.
zoomStop (optional)
Integer The zoom level to stop seeding.
type (optional)
String Type can be seed (add tiles), reseed (replace tiles), or truncate (remove tiles).
Enum:
seed
reseed
truncate
threadCount (optional)
Integer Number of seeding threads to run in parallel. If type is truncate only one thread will be used regardless of this parameter.
parameters (optional)

seedRequest_bounds - Up

A set of coordinates describing the bounds of the seed layer.
coords (optional)

seedRequest_parameters - Up

The filter parameters used for the requested layer
entry (optional)

seedRequest_parameters_entry - Up

A set of strings used to describe what filters to use
string (optional)