Geoserver REST API Service Manager

Geoserver REST API Service Manager

Geoserver REST API Service Manager

Format

R6Class object.

Value

Object of R6Class with methods for managing GeoServer services

Author

Emmanuel Blondel <emmanuel.blondel1@gmail.com>

Super class

geosapi::GSManager -> GSServiceManager

Methods

Public methods

• GSServiceManager$getServiceSettings()

• GSServiceManager$getWmsSettings()

• GSServiceManager$getWfsSettings()

• GSServiceManager$getWcsSettings()

• GSServiceManager$updateServiceSettings()

• GSServiceManager$deleteServiceSettings()

• GSServiceManager$updateWmsSettings()

• GSServiceManager$updateWfsSettings()

• GSServiceManager$updateWcsSettings()

• GSServiceManager$enableWMS()

• GSServiceManager$enableWFS()

• GSServiceManager$enableWCS()

• GSServiceManager$disableServiceSettings()

• GSServiceManager$disableWMS()

• GSServiceManager$disableWFS()

• GSServiceManager$disableWCS()

• GSServiceManager$clone()

Inherited methods

• geosapi::GSManager$ERROR()
• geosapi::GSManager$INFO()
• geosapi::GSManager$WARN()
• geosapi::GSManager$connect()
• geosapi::GSManager$getClassName()
• geosapi::GSManager$getCoverageStoreManager()
• geosapi::GSManager$getDataStoreManager()
• geosapi::GSManager$getNamespaceManager()
• geosapi::GSManager$getServiceManager()
• geosapi::GSManager$getStyleManager()
• geosapi::GSManager$getSystemStatus()
• geosapi::GSManager$getUrl()
• geosapi::GSManager$getWorkspaceManager()
• geosapi::GSManager$initialize()
• geosapi::GSManager$logger()
• geosapi::GSManager$monitor()
• geosapi::GSManager$reload()

---

Method getServiceSettings()

Get the service settings. To get the service settings for a specific workspace, specify the workspace name as ws parameter, otherwise global settings are retrieved.

Usage

GSServiceManager$getServiceSettings(service, ws = NULL)

Arguments

service

service

ws

workspace name

Returns

an object of class GSServiceSettings

---

Method getWmsSettings()

Get WMS settings. To get the WMS settings for a specific workspace, specify the workspace name as ws parameter, otherwise global settings are retrieved.

Usage

GSServiceManager$getWmsSettings(ws = NULL)

Arguments

ws

workspace name

Returns

an object of class GSServiceSettings

---

Method getWfsSettings()

Get WFS settings. To get the WFS settings for a specific workspace, specify the workspace name as ws parameter, otherwise global settings are retrieved.

Usage

GSServiceManager$getWfsSettings(ws = NULL)

Arguments

ws

workspace name

Returns

an object of class GSServiceSettings

---

Method getWcsSettings()

Get WCS settings. To get the WCS settings for a specific workspace, specify the workspace name as ws parameter, otherwise global settings are retrieved.

Usage

GSServiceManager$getWcsSettings(ws = NULL)

Arguments

ws

workspace name

Returns

an object of class GSServiceSettings

---

Method updateServiceSettings()

Updates the service settings with an object of class GSServiceSettings. An optional workspace name ws can be specified to update service settings applying to a workspace.

Usage

GSServiceManager$updateServiceSettings(serviceSettings, service, ws = NULL)

Arguments

serviceSettings

serviceSettings object of class GSServiceSettings

service

service

ws

workspace name

Returns

TRUE if updated, FALSE otherwise

---

Method deleteServiceSettings()

Deletes the service settings. This method is used internally by geosapi for disabling a service setting at workspace level.

Usage

GSServiceManager$deleteServiceSettings(service, ws = NULL)

Arguments

service

service

ws

workspace name

Returns

TRUE if deleted, FALSE otherwise

---

Method updateWmsSettings()

Updates the WMS settings with an object of class GSServiceSettings. An optional workspace name ws can be specified to update WMS settings applying to a workspace.

Usage

GSServiceManager$updateWmsSettings(serviceSettings, ws = NULL)

Arguments

serviceSettings

service settings object of class GSServiceSettings

ws

workspace name

Returns

TRUE if deleted, FALSE otherwise

---

Method updateWfsSettings()

Updates the WFS settings with an object of class GSServiceSettings. An optional workspace name ws can be specified to update WFS settings applying to a workspace.

Usage

GSServiceManager$updateWfsSettings(serviceSettings, ws = NULL)

Arguments

serviceSettings

service settings object of class GSServiceSettings

ws

workspace name

Returns

TRUE if deleted, FALSE otherwise

---

Method updateWcsSettings()

Updates the WCS settings with an object of class GSServiceSettings. An optional workspace name ws can be specified to update WCS settings applying to a workspace.

Usage

GSServiceManager$updateWcsSettings(serviceSettings, ws = NULL)

Arguments

serviceSettings

service settings object of class GSServiceSettings

ws

workspace name

Returns

TRUE if deleted, FALSE otherwise

---

Method enableWMS()

Enables WMS service settings

Usage

GSServiceManager$enableWMS(ws = NULL)

Arguments

ws

workspace name

Returns

TRUE if enabled, FALSE otherwise

---

Method enableWFS()

Enables WFS service settings

Usage

GSServiceManager$enableWFS(ws = NULL)

Arguments

ws

workspace name

Returns

TRUE if enabled, FALSE otherwise

---

Method enableWCS()

Enables WCS service settings

Usage

GSServiceManager$enableWCS(ws = NULL)

Arguments

ws

workspace name

Returns

TRUE if enabled, FALSE otherwise

---

Method disableServiceSettings()

Disables service settings

Usage

GSServiceManager$disableServiceSettings(service, ws = NULL)

Arguments

service

service

ws

workspace name

Returns

TRUE if disabled, FALSE otherwise

---

Method disableWMS()

Disables WMS service settings

Usage

GSServiceManager$disableWMS(ws = NULL)

Arguments

ws

workspace name

Returns

TRUE if disabled, FALSE otherwise

---

Method disableWFS()

Disables WFS service settings

Usage

GSServiceManager$disableWFS(ws = NULL)

Arguments

ws

workspace name

Returns

TRUE if disabled, FALSE otherwise

---

Method disableWCS()

Disables WCS service settings

Usage

GSServiceManager$disableWCS(ws = NULL)

Arguments

ws

workspace name

Returns

TRUE if disabled, FALSE otherwise

---

Method clone()

The objects of this class are cloneable with this method.

Usage

GSServiceManager$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

# \dontrun{
   GSServiceManager$new("http://localhost:8080/geoserver", "admin", "geoserver")
#> Error in curl::curl_fetch_memory(url, handle = handle): Failed to connect to localhost port 8080 after 0 ms: Connection refused
 # }