GeoWebCache DiskQuota

The REST API for Disk Quota management provides a RESTful interface through which clients can configure the disk usage limits and expiration policies for a GeoWebCache instance through simple HTTP calls. Since disk usage increases geometrically by zoom level, one single seeding task could fill up an entire storage device. Because of this, GeoWebCache employs a disk quota system where one can specify the maximum amount of disk space to use for a particular layer, as well as logic on how to proceed when that quota is reached. There are two different policies for managing the disk quotas - Least Frequently Used (LFU) and Least Recently Used (LRU).
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

GwcDiskQuota

GwcDiskQuota

Up
get /diskquota
Returns the gwc Quota configuration (diskQuotaGet)
Returns the GeoWebCache DiskQuota configurations which include disk usage limits and expritation policies for a gwc instance.

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/xml

  true
  2048
  5
  SECONDS
  5
  LRU
  
    100
    MiB
  
  

Example data

Content-Type: appliction/json
{
  "org.geowebcache.diskquota.DiskQuotaConfig": {
    "enabled": false,
    "cacheCleanUpFrequency": 10,
    "cacheCleanUpUnits": "SECONDS",
    "maxConcurrentCleanUps": 2,
    "globalExpirationPolicyName": "LFU",
    "globalQuota": {
      "id": 0,
      "bytes": 524288000
    }
  }
}

Up
put /diskquota
Modify properties of a gwc instance disk quota configuration. (diskQuotaPut)
The request body for PUT should contain desired properties to be modified.

Consumes

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

Request body

requestBody DiskQuota (optional)
Body Parameter — The diskquota configuration with modified property values.

Responses

200

OK

Models

[ Jump to Methods ]

Table of Contents

  1. DiskQuota - gwcQuotaConfiguration
  2. DiskQuota_globalQuota -
  3. DiskQuota_layerQuota -
  4. DiskQuota_layerQuota_quota -

DiskQuota - gwcQuotaConfiguration Up

enabled (optional)
Boolean Determines if Disk Quota is to be used.
diskBlockSize (optional)
BigDecimal The number of bytes allocated to Disk Quota.
cacheCleanUpFrequency (optional)
BigDecimal GeoWebCache will not truncate the cache as soon as the disk quota is exceeded. Instead, it polls the store at given intervals, with this time interval set.
cacheCleanUpUnits (optional)
String The time unit used to describe the number in cacheCleanUpFrequency.
Enum:
SECONDS
MINUTES
HOURS
DAYS
maxConcurrentCleanUps (optional)
BigDecimal The amount of threads to use when processing the disk quota.
globalExpirationPolicyName (optional)
String When a disk quota is reached, further tiles will be saved at the expense of other tiles which will be truncated. The Least Frequently Used (LFU) policy will analyze the disk quota page store and delete the pages of tiles that have been accessed the least often. The Least Recently Used (LRU) policy will analyze the diskquota page store and delete the tiles that haven’t been accessed in the longest amount of time.
Enum:
LRU
LSU
globalQuota (optional)
layerQuota (optional)

DiskQuota_globalQuota - Up

When the global quota is exceeded, first any explicitly configured quota is enforced, and then the global quota is enforced acting upon all the remaining layers until the global quota is reached back.
value (optional)
BigDecimal Numeric value for global quota.
units (optional)
String The type of unit quantified by value.
Enum:
B
KiB
MiB
GiB
TiB

DiskQuota_layerQuota - Up

When a layer's disk quota is reached, further tiles will be saved at the expense of other tiles which will be truncated.
layer (optional)
String The layer name.
expirationPolicyName (optional)
String When a disk quota is reached, further tiles will be saved at the expense of other tiles which will be truncated. The Least Frequently Used (LFU) policy will analyze the disk quota page store and delete the pages of tiles that have been accessed the least often. The Least Recently Used (LRU) policy will analyze the diskquota page store and delete the tiles that haven’t been accessed in the longest amount of time.
Enum:
LRU
LSU
quota (optional)

DiskQuota_layerQuota_quota - Up

Container for quota value and units
value (optional)
BigDecimal Numeric value for global quota.
units (optional)
String The type of unit quantified by value.
Enum:
B
KiB
MiB
GiB
TiB