Geoserver REST API Access Control List Manager

Geoserver REST API Access Control List Manager

Geoserver REST API Access Control List Manager

Format

R6Class object.

Value

Object of R6Class with methods for managing GeoServer Access Control List (ACL) operations.

Author

Emmanuel Blondel <emmanuel.blondel1@gmail.com>

Super class

geosapi::GSManager -> GSAccessControlListManager

Methods

Public methods

• GSAccessControlListManager$setCatalogMode()

• GSAccessControlListManager$getCatalogMode()

• GSAccessControlListManager$getRules()

• GSAccessControlListManager$addRule()

• GSAccessControlListManager$addLayerRule()

• GSAccessControlListManager$addServiceRule()

• GSAccessControlListManager$addRestRule()

• GSAccessControlListManager$modifyRule()

• GSAccessControlListManager$deleteRule()

• GSAccessControlListManager$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 setCatalogMode()

Set the catalog mode

Usage

GSAccessControlListManager$setCatalogMode(
  mode = c("HIDE", "MIXED", "CHALLENGE")
)

Arguments

mode

mode

Returns

TRUE if set, FALSE otherwise

---

Method getCatalogMode()

Get the catalog mode

Usage

GSAccessControlListManager$getCatalogMode()

Returns

the mode either HIDE, MIXED or CHALLENGE

---

Method getRules()

Get rules

Usage

GSAccessControlListManager$getRules(domain = c("layers", "services", "rest"))

Arguments

domain

the access control domain

Returns

the list of rules for a given domain

---

Method addRule()

Generic method to add an access control rule

Usage

GSAccessControlListManager$addRule(rule)

Arguments

rule

object of class GSRule

Returns

TRUE if added, FALSE otherwise

---

Method addLayerRule()

Adds an access control layer rule

Usage

GSAccessControlListManager$addLayerRule(
  ws = NULL,
  lyr,
  permission = c("r", "w", "a"),
  roles
)

Arguments

ws

the resource workspace. Default is NULL

lyr

the target layer to which the access control should be added

permission

the rule permission, either r (read), w (write) or a (administer)

roles

one or more roles to add for the rule

Returns

TRUE if added, FALSE otherwise

---

Method addServiceRule()

Adds an access control service rule

Usage

GSAccessControlListManager$addServiceRule(
  service,
  method,
  permission = c("r", "w", "a"),
  roles
)

Arguments

service

service subject to the access control rule, eg. 'wfs'

method

service method subject to the access control rule, eg. 'GetFeature'

permission

the rule permission, either r (read), w (write) or a (administer)

roles

one or more roles to add for the rule

Returns

TRUE if added, FALSE otherwise

---

Method addRestRule()

Adds an access control rest rule

Usage

GSAccessControlListManager$addRestRule(
  pattern,
  methods,
  permission = c("r", "w", "a"),
  roles
)

Arguments

pattern

a URL Ant pattern, only applicable for domain rest. Default is /**

methods

HTTP method(s)

permission

the rule permission, either r (read), w (write) or a (administer)

roles

one or more roles to add for the rule

Returns

TRUE if added, FALSE otherwise

---

Method modifyRule()

Generic method to modify an access control rule

Usage

GSAccessControlListManager$modifyRule(rule)

Arguments

rule

object of class GSRule

Returns

TRUE if modified, FALSE otherwise

---

Method deleteRule()

Generic method to delete an access control rule

Usage

GSAccessControlListManager$deleteRule(rule)

Arguments

rule

object of class GSRule

Returns

TRUE if deleted, FALSE otherwise

---

Method clone()

The objects of this class are cloneable with this method.

Usage

GSAccessControlListManager$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

# \dontrun{
   GSAccessControlListManager$new("http://localhost:8080/geoserver", "admin", "geoserver")
#> <GSAccessControlListManager>
#>   Inherits from: <GSManager>
#>   Public:
#>     ERROR: function (text) 
#>     INFO: function (text) 
#>     WARN: function (text) 
#>     addLayerRule: function (ws = NULL, lyr, permission = c("r", "w", "a"), roles) 
#>     addRestRule: function (pattern, methods, permission = c("r", "w", "a"), roles) 
#>     addRule: function (rule) 
#>     addServiceRule: function (service, method, permission = c("r", "w", "a"), roles) 
#>     clone: function (deep = FALSE) 
#>     connect: function () 
#>     deleteRule: function (rule) 
#>     getCatalogMode: function () 
#>     getClassName: function () 
#>     getCoverageStoreManager: function () 
#>     getDataStoreManager: function () 
#>     getNamespaceManager: function () 
#>     getRules: function (domain = c("layers", "services", "rest")) 
#>     getServiceManager: function () 
#>     getStyleManager: function () 
#>     getSystemStatus: function () 
#>     getUrl: function () 
#>     getWorkspaceManager: function () 
#>     initialize: function (url, user, pwd, logger = NULL, keyring_backend = "env") 
#>     logger: function (type, text) 
#>     loggerType: NULL
#>     modifyRule: function (rule) 
#>     monitor: function (file = NULL, append = FALSE, sleep = 1) 
#>     reload: function () 
#>     setCatalogMode: function (mode = c("HIDE", "MIXED", "CHALLENGE")) 
#>     url: http://localhost:8080/geoserver/rest
#>     verbose.debug: FALSE
#>     verbose.info: FALSE
#>     version: NULL
#>   Private:
#>     keyring_backend: backend_env, backend, R6
#>     keyring_service: geosapi@http://localhost:8080/geoserver
#>     user: admin
 # }