GSServiceManager: Geoserver REST API Service Manager
In geosapi: GeoServer REST API R Interface
GSServiceManager R Documentation
Geoserver REST API Service Manager
Description
Geoserver REST API Service Manager
Geoserver REST API Service Manager
Format
R6Class object.
Value
Object of R6Class with methods for managing GeoServer services
Constructor
new(url, user, pwd, logger)-
This method is used to instantiate a GSManager with the url of the
GeoServer and credentials to authenticate (user/pwd). By default,
the logger argument will be set to NULL (no logger). This argument
accepts two possible values: INFO: to print only geosapi logs,
DEBUG: to print geosapi and CURL logs
getServiceSettings(service, ws)-
getWmsSettings(ws)-
Get WMS settings. To get the WMS settings for a specific workspace,
specify the workspace name as ws parameter, otherwise global settings are
retrieved.
getWfsSettings(ws)-
Get WFS settings. To get the WFS settings for a specific workspace,
specify the workspace name as ws parameter, otherwise global settings are
retrieved.
getWcsSettings(ws)-
Get WCS settings. To get the WCS settings for a specific workspace,
specify the workspace name as ws parameter, otherwise global settings are
retrieved.
updateServiceSettings(serviceSettings, service, ws)-
Updates the service settings with an object of class GSServiceSetting.
An optional workspace name ws can be specified to update service settings
applying to a workspace.
deleteServiceSettings(service, ws)-
Deletes the service settings. This method is used internally by geosapi
for disabling a service setting at workspace level.
updateWmsSettings(serviceSettings, ws)-
Updates the WMS settings with an object of class GSServiceSetting.
An optional workspace name ws can be specified to update WMS settings
applying to a workspace.
updateWfsSettings(serviceSettings, ws)-
Updates the WFS settings with an object of class GSServiceSetting.
An optional workspace name ws can be specified to update WFS settings
applying to a workspace.
updateWcsSettings(serviceSettings, ws)-
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.
enableWMS(ws)-
Enables the WMS, either globally, or for a given workspace (optional)
enableWFS(ws)-
Enables the WFS, either globally, or for a given workspace (optional)
enableWCS(ws)-
Enables the WCS, either globally, or for a given workspace (optional)
disableServiceSettings(service, ws)-
Disables a service, either globally, or for a given workspace (optional).
For a global service setting, an UPDATE operation will be applied, while
for a workspace service setting, a DELETE operation is applied.
disableWMS(ws)-
Disables the WMS, either globally, or for a given workspace (optional)
disableWFS(ws)-
Disables the WFS, either globally, or for a given workspace (optional)
disableWCS(ws)-
Disables the WCS, either globally, or for a given workspace (optional)
Super class
geosapi::GSManager -> GSServiceManager
Methods
Public methods
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
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
serviceservice
wsworkspace 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
wsworkspace 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
wsworkspace 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
wsworkspace 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
serviceSettingsserviceSettings object of class GSServiceSettings
serviceservice
wsworkspace 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
serviceservice
wsworkspace 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
serviceSettingsservice settings object of class GSServiceSettings
wsworkspace 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
serviceSettingsservice settings object of class GSServiceSettings
wsworkspace 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
serviceSettingsservice settings object of class GSServiceSettings
wsworkspace name
Returns
TRUE if deleted, FALSE otherwise
Method enableWMS()
Enables WMS service settings
Usage
GSServiceManager$enableWMS(ws = NULL)
Arguments
wsworkspace name
Returns
TRUE if enabled, FALSE otherwise
Method enableWFS()
Enables WFS service settings
Usage
GSServiceManager$enableWFS(ws = NULL)
Arguments
wsworkspace name
Returns
TRUE if enabled, FALSE otherwise
Method enableWCS()
Enables WCS service settings
Usage
GSServiceManager$enableWCS(ws = NULL)
Arguments
wsworkspace name
Returns
TRUE if enabled, FALSE otherwise
Method disableServiceSettings()
Disables service settings
Usage
GSServiceManager$disableServiceSettings(service, ws = NULL)
Arguments
serviceservice
wsworkspace name
Returns
TRUE if disabled, FALSE otherwise
Method disableWMS()
Disables WMS service settings
Usage
GSServiceManager$disableWMS(ws = NULL)
Arguments
wsworkspace name
Returns
TRUE if disabled, FALSE otherwise
Method disableWFS()
Disables WFS service settings
Usage
GSServiceManager$disableWFS(ws = NULL)
Arguments
wsworkspace name
Returns
TRUE if disabled, FALSE otherwise
Method disableWCS()
Disables WCS service settings
Usage
GSServiceManager$disableWCS(ws = NULL)
Arguments
wsworkspace 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
deepWhether to make a deep clone.
Author(s)
Emmanuel Blondel <emmanuel.blondel1@gmail.com>
Examples
## Not run:
GSServiceManager$new("http://localhost:8080/geoserver", "admin", "geoserver")
## End(Not run)
geosapi documentation built on Oct. 4, 2023, 5:06 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| GSServiceManager | R Documentation |
Geoserver REST API Service Manager
Description
Geoserver REST API Service Manager
Geoserver REST API Service Manager
Format
R6Class object.
Value
Object of R6Class with methods for managing GeoServer services
Constructor
new(url, user, pwd, logger)-
This method is used to instantiate a GSManager with the
urlof the GeoServer and credentials to authenticate (user/pwd). By default, theloggerargument will be set toNULL(no logger). This argument accepts two possible values:INFO: to print only geosapi logs,DEBUG: to print geosapi and CURL logs getServiceSettings(service, ws)getWmsSettings(ws)-
Get WMS settings. To get the WMS settings for a specific workspace, specify the workspace name as
wsparameter, otherwise global settings are retrieved. getWfsSettings(ws)-
Get WFS settings. To get the WFS settings for a specific workspace, specify the workspace name as
wsparameter, otherwise global settings are retrieved. getWcsSettings(ws)-
Get WCS settings. To get the WCS settings for a specific workspace, specify the workspace name as
wsparameter, otherwise global settings are retrieved. updateServiceSettings(serviceSettings, service, ws)-
Updates the service settings with an object of class
GSServiceSetting. An optional workspace namewscan be specified to update service settings applying to a workspace. deleteServiceSettings(service, ws)-
Deletes the service settings. This method is used internally by geosapi for disabling a service setting at workspace level.
updateWmsSettings(serviceSettings, ws)-
Updates the WMS settings with an object of class
GSServiceSetting. An optional workspace namewscan be specified to update WMS settings applying to a workspace. updateWfsSettings(serviceSettings, ws)-
Updates the WFS settings with an object of class
GSServiceSetting. An optional workspace namewscan be specified to update WFS settings applying to a workspace. updateWcsSettings(serviceSettings, ws)-
Updates the WCS settings with an object of class
GSServiceSettings. An optional workspace namewscan be specified to update WCS settings applying to a workspace. enableWMS(ws)-
Enables the WMS, either globally, or for a given workspace (optional)
enableWFS(ws)-
Enables the WFS, either globally, or for a given workspace (optional)
enableWCS(ws)-
Enables the WCS, either globally, or for a given workspace (optional)
disableServiceSettings(service, ws)-
Disables a service, either globally, or for a given workspace (optional). For a global service setting, an UPDATE operation will be applied, while for a workspace service setting, a DELETE operation is applied.
disableWMS(ws)-
Disables the WMS, either globally, or for a given workspace (optional)
disableWFS(ws)-
Disables the WFS, either globally, or for a given workspace (optional)
disableWCS(ws)-
Disables the WCS, either globally, or for a given workspace (optional)
Super class
geosapi::GSManager -> GSServiceManager
Methods
Public methods
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
serviceservice
wsworkspace 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
wsworkspace 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
wsworkspace 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
wsworkspace 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
serviceSettingsserviceSettings object of class GSServiceSettings
serviceservice
wsworkspace 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
serviceservice
wsworkspace 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
serviceSettingsservice settings object of class GSServiceSettings
wsworkspace 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
serviceSettingsservice settings object of class GSServiceSettings
wsworkspace 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
serviceSettingsservice settings object of class GSServiceSettings
wsworkspace name
Returns
TRUE if deleted, FALSE otherwise
Method enableWMS()
Enables WMS service settings
Usage
GSServiceManager$enableWMS(ws = NULL)
Arguments
wsworkspace name
Returns
TRUE if enabled, FALSE otherwise
Method enableWFS()
Enables WFS service settings
Usage
GSServiceManager$enableWFS(ws = NULL)
Arguments
wsworkspace name
Returns
TRUE if enabled, FALSE otherwise
Method enableWCS()
Enables WCS service settings
Usage
GSServiceManager$enableWCS(ws = NULL)
Arguments
wsworkspace name
Returns
TRUE if enabled, FALSE otherwise
Method disableServiceSettings()
Disables service settings
Usage
GSServiceManager$disableServiceSettings(service, ws = NULL)
Arguments
serviceservice
wsworkspace name
Returns
TRUE if disabled, FALSE otherwise
Method disableWMS()
Disables WMS service settings
Usage
GSServiceManager$disableWMS(ws = NULL)
Arguments
wsworkspace name
Returns
TRUE if disabled, FALSE otherwise
Method disableWFS()
Disables WFS service settings
Usage
GSServiceManager$disableWFS(ws = NULL)
Arguments
wsworkspace name
Returns
TRUE if disabled, FALSE otherwise
Method disableWCS()
Disables WCS service settings
Usage
GSServiceManager$disableWCS(ws = NULL)
Arguments
wsworkspace 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
deepWhether to make a deep clone.
Author(s)
Emmanuel Blondel <emmanuel.blondel1@gmail.com>
Examples
## Not run:
GSServiceManager$new("http://localhost:8080/geoserver", "admin", "geoserver")
## End(Not run)
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.