geosapi (version 0.8-1)

GSAccessControlListManager: Geoserver REST API Access Control List Manager

Description

Geoserver REST API Access Control List Manager

Geoserver REST API Access Control List Manager

Value

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

Format

R6Class object.

Author

Emmanuel Blondel <[e-mail]>

Super class

geosapi::GSManager -> GSAccessControlListManager

Methods

Public methods

• GSAccessControlListManager$setCatalogMode()

• GSAccessControlListManager$getCatalogMode()

• GSAccessControlListManager$getRules()

• GSAccessControlListManager$getLayerRules()

• GSAccessControlListManager$getServiceRules()

• GSAccessControlListManager$getRestRules()

• GSAccessControlListManager$getRule()

• GSAccessControlListManager$getLayerRule()

• GSAccessControlListManager$getServiceRule()

• GSAccessControlListManager$getRestRule()

• 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 getLayerRules()

Method to get the list of 'layers' rules

Usage

GSAccessControlListManager$getLayerRules()

Returns

the list of 'layers' rules

---

Method getServiceRules()

Method to get the list of 'services' rules

Usage

GSAccessControlListManager$getServiceRules()

Returns

the list of 'services' rules

---

Method getRestRules()

Method to get the list of 'rest' rules

Usage

GSAccessControlListManager$getRestRules()

Returns

the list of 'rest' rules

---

Method getRule()

Method to get a rule by resource

Usage

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

Arguments

domain

the access control domain

resource

resource

Returns

an object of class GSRule or NULL if no rule is found

---

Method getLayerRule()

Method to get a 'layers' rule

Usage

GSAccessControlListManager$getLayerRule(resource)

Arguments

resource

resource

Returns

an object of class GSLayerRule or NULL if no rule is found

---

Method getServiceRule()

Method to get a 'services' rule

Usage

GSAccessControlListManager$getServiceRule(resource)

Arguments

resource

resource

Returns

an object of class GSServiceRule or NULL if no rule is found

---

Method getRestRule()

Method to get a 'rest' rule

Usage

GSAccessControlListManager$getRestRule(resource)

Arguments

resource

resource

Returns

an object of class GSRestRule or NULL if no rule is found

---

Method addRule()

Generic method to add an access control rule

Usage

GSAccessControlListManager$addRule(rule, position = c("first", "last"))

Arguments

rule

object of class GSRule

position

position with the list of rules, either "first" or "last". The position is especially true to capture to the order of priority. For priority, put 'first'.

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, roles)

Arguments

pattern

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

methods

HTTP method(s)

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, position = c("first", "last"))

Arguments

rule

object of class GSRule

position

position with the list of rules, either "first" or "last". The position is especially true to capture to the order of priority. For priority, put 'first'.

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

if (FALSE) {
   GSAccessControlListManager$new("http://localhost:8080/geoserver", "admin", "geoserver")
 }