GSManager: Geoserver REST API Manager

In geosapi: GeoServer REST API R Interface

Geoserver REST API Manager

Description

Geoserver REST API Manager

Geoserver REST API Manager

Format

R6Class object.

Value

Object of R6Class with methods for communication with the REST API of a GeoServer instance.

Methods

new(url, user, pwd, logger, keyring_backend)

logger(type, text)

Basic logger to report geosapi logs. Used internally

INFO(text)

Logger to report information. Used internally

WARN(text)

Logger to report warnings. Used internally

ERROR(text)

Logger to report errors. Used internally

getUrl()

Get the authentication URL

connect()

This methods attempts a connection to GeoServer REST API. User internally during initialization of GSManager.

reload()

Reloads the GeoServer catalog.

getSystemStatus()

Get system status

getClassName()

Retrieves the name of the class instance

getWorkspaceManager()

Retrieves an instance of workspace manager

getNamespaceManager()

Retrieves an instance of namespace manager

getDataStoreManager()

Retrieves an instance of datastore manager

Public fields

verbose.info

if geosapi logs have to be printed

verbose.debug

if curl logs have to be printed

loggerType

the type of logger

url

the Base url of GeoServer

version

the version of Geoserver. Handled as GSVersion object

Methods

Public methods

• GSManager$logger()

• GSManager$INFO()

• GSManager$WARN()

• GSManager$ERROR()

• GSManager$new()

• GSManager$getUrl()

• GSManager$connect()

• GSManager$reload()

• GSManager$getSystemStatus()

• GSManager$monitor()

• GSManager$getClassName()

• GSManager$getWorkspaceManager()

• GSManager$getNamespaceManager()

• GSManager$getDataStoreManager()

• GSManager$getCoverageStoreManager()

• GSManager$getServiceManager()

• GSManager$getStyleManager()

• GSManager$clone()

---

Method logger()

Prints a log message

Usage

GSManager$logger(type, text)

Arguments

type

type of log, "INFO", "WARN", "ERROR"

text

text

---

Method INFO()

Prints an INFO log message

Usage

GSManager$INFO(text)

Arguments

text

text

---

Method WARN()

Prints an WARN log message

Usage

GSManager$WARN(text)

Arguments

text

text

---

Method ERROR()

Prints an ERROR log message

Usage

GSManager$ERROR(text)

Arguments

text

text

---

Method new()

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.

The keyring_backend can be set to use a different backend for storing the Geoserver user password with keyring (Default value is 'env').

Usage

GSManager$new(url, user, pwd, logger = NULL, keyring_backend = "env")

Arguments

url

url

user

user

pwd

pwd

logger

logger

keyring_backend

keyring backend. Default is 'env'

---

Method getUrl()

Get URL

Usage

GSManager$getUrl()

Returns

the Geoserver URL

---

Method connect()

Connects to geoServer

Usage

GSManager$connect()

Returns

TRUE if connected, raises an error otherwise

---

Method reload()

Reloads the GeoServer catalog

Usage

GSManager$reload()

Returns

TRUE if reloaded, FALSE otherwise

---

Method getSystemStatus()

Get system status

Usage

GSManager$getSystemStatus()

Returns

an object of class data.frame given the date time and metrics value

---

Method monitor()

Monitors the Geoserver by launching a small shiny monitoring application

Usage

GSManager$monitor(file = NULL, append = FALSE, sleep = 1)

Arguments

file

file where to store monitoring results

append

whether to append results to existing files

sleep

sleeping interval to trigger a system status call

---

Method getClassName()

Get class name

Usage

GSManager$getClassName()

Returns

the self class name, as character

---

Method getWorkspaceManager()

Get Workspace manager

Usage

GSManager$getWorkspaceManager()

Returns

an object of class GSWorkspaceManager

---

Method getNamespaceManager()

Get Namespace manager

Usage

GSManager$getNamespaceManager()

Returns

an object of class GSNamespaceManager

---

Method getDataStoreManager()

Get Datastore manager

Usage

GSManager$getDataStoreManager()

Returns

an object of class GSDataStoreManager

---

Method getCoverageStoreManager()

Get Coverage store manager

Usage

GSManager$getCoverageStoreManager()

Returns

an object of class GSCoverageStoreManager

---

Method getServiceManager()

Get service manager

Usage

GSManager$getServiceManager()

Returns

an object of class GSServiceManager

---

Method getStyleManager()

Get style manager

Usage

GSManager$getStyleManager()

Returns

an object of class GSStyleManager

---

Method clone()

The objects of this class are cloneable with this method.

Usage

GSManager$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Author(s)

Emmanuel Blondel <[e-mail]>

Examples

## Not run: 
   GSManager$new("http://localhost:8080/geoserver", "admin", "geoserver")

## End(Not run)

geosapi documentation built on Oct. 4, 2023, 5:06 p.m.