GSLayerRule

<p>This class models a GeoServer access control list layer rule</p>

control

access

Rule

geoserver

rest

Provides an R interface to the GeoServer REST API, allowing to upload
and publish data in a GeoServer web-application and expose data to OGC Web-Services.
The package currently supports all CRUD (Create,Read,Update,Delete) operations
on GeoServer workspaces, namespaces, datastores (stores of vector data), featuretypes,
layers, styles, as well as vector data upload operations. For more information about
the GeoServer REST API, see <https://docs.geoserver.org/main/en/user/rest/>.

Emmanuel Blondel

geosapi

GeoServer REST API R Interface

GSLayerRule function

<p><code><a href="https://r6.r-lib.org/reference/R6Class.html">R6Class</a></code> object.</p>

Format

<p>Emmanuel Blondel &lt;emmanuel.blondel1@gmail.com&gt;</p>

Author

<p><code>geosapi::GSRESTResource</code> -&gt; <code>geosapi::GSRule</code> -&gt; <code>GSLayerRule</code></p>

Super classes

<p><div class="r6-fields"></div></p><dl>
<dt><code>roles</code></dt>
<dd><p>one or more roles</p></dd><p></p><p>
</p></dl><p></p>

Public fields


<div class="section" id="public-methods">
<h3>Public methods</h3><p></p><p><ul>
<li><p><a href="/link/GSLayerRule%24new()?package=geosapi&version=0.8-1" data-mini-rdoc="geosapi::GSLayerRule$new()"><code>GSLayerRule$new()</code></a></p></li>
<li><p><a href="/link/GSLayerRule%24clone()?package=geosapi&version=0.8-1" data-mini-rdoc="geosapi::GSLayerRule$clone()"><code>GSLayerRule$clone()</code></a></p></li>
</ul></p><p></p></div><p><details open><summary>Inherited methods</summary>
<ul>
<li><span class="pkg-link" data-pkg="geosapi" data-topic="GSRESTResource" data-id="getClassName"><a href="/link/geosapi%3A%3AGSRESTResource%24getClassName()?package=geosapi&version=0.8-1" data-mini-rdoc="geosapi::geosapi::GSRESTResource$getClassName()"><code>geosapi::GSRESTResource$getClassName()</code></a></span></li>
<li><span class="pkg-link" data-pkg="geosapi" data-topic="GSRESTResource" data-id="print"><a href="/link/geosapi%3A%3AGSRESTResource%24print()?package=geosapi&version=0.8-1" data-mini-rdoc="geosapi::geosapi::GSRESTResource$print()"><code>geosapi::GSRESTResource$print()</code></a></span></li>
<li><span class="pkg-link" data-pkg="geosapi" data-topic="GSRule" data-id="decode"><a href="/link/geosapi%3A%3AGSRule%24decode()?package=geosapi&version=0.8-1" data-mini-rdoc="geosapi::geosapi::GSRule$decode()"><code>geosapi::GSRule$decode()</code></a></span></li>
<li><span class="pkg-link" data-pkg="geosapi" data-topic="GSRule" data-id="encode"><a href="/link/geosapi%3A%3AGSRule%24encode()?package=geosapi&version=0.8-1" data-mini-rdoc="geosapi::geosapi::GSRule$encode()"><code>geosapi::GSRule$encode()</code></a></span></li>
</ul>
</details></p><p><hr>
<a id="method-GSLayerRule-new"></a></p><div class="section" id="method-new-">
<h3>Method <code>new()</code></h3>
<p>Initializes a GSLayerRule</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>GSLayerRule$new(
  xml = NULL,
  ws = NULL,
  lyr,
  permission = c("r", "w", "a"),
  roles
)</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>xml</code></dt>
<dd><p>an object of class <a href="http://xml2.r-lib.org/reference/oldclass.html">xml_node-class</a></p></dd></dl></div></p><p>
<dt><code>ws</code></dt>
<dd><p>the resource workspace. Default is <code>NULL</code></p></dd></p><p>
<dt><code>lyr</code></dt>
<dd><p>the target layer to which the access control should be added</p></dd></p><p>
<dt><code>permission</code></dt>
<dd><p>the rule permission, either <code>r</code> (read), <code>w</code> (write) or <code>a</code> (administer)</p></dd></p><p>
<dt><code>roles</code></dt>
<dd><p>one or more roles to add for the rule</p></dd></p><p>
</p><p></p>
<p></p><p></p><p><hr>
<a id="method-GSLayerRule-clone"></a></p><div class="section" id="method-clone-">
<h3>Method <code>clone()</code></h3>
<p>The objects of this class are cloneable with this method.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>GSLayerRule$clone(deep = FALSE)</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>deep</code></dt>
<dd><p>Whether to make a deep clone.</p></dd></dl></div></p><p>
</p><p></p>
<p></p><p>
</p>

Methods

A GeoServer access control list layer rule — GSLayerRule

<p><code><a href='https://r6.r-lib.org/reference/R6Class.html'>R6Class</a></code> object.</p>

<p><div class="r6-fields"></p><dl>
<dt><code>roles</code></dt>
<dd><p>one or more roles</p></dd>


</dl><p></div></p>


<div class='section' id='public-methods'>
<h3>Public methods</h3>

<ul>
<li><p><a href='#method-GSLayerRule-new'><code>GSLayerRule$new()</code></a></p></li>
<li><p><a href='#method-GSLayerRule-clone'><code>GSLayerRule$clone()</code></a></p></li>
</ul>

</div><p><details open><summary>Inherited methods</summary>
<ul>
<li><span class="pkg-link" data-pkg="geosapi" data-topic="GSRESTResource" data-id="getClassName"><a href='../../geosapi/html/GSRESTResource.html#method-GSRESTResource-getClassName'><code>geosapi::GSRESTResource$getClassName()</code></a></span></li>
<li><span class="pkg-link" data-pkg="geosapi" data-topic="GSRESTResource" data-id="print"><a href='../../geosapi/html/GSRESTResource.html#method-GSRESTResource-print'><code>geosapi::GSRESTResource$print()</code></a></span></li>
<li><span class="pkg-link" data-pkg="geosapi" data-topic="GSRule" data-id="decode"><a href='../../geosapi/html/GSRule.html#method-GSRule-decode'><code>geosapi::GSRule$decode()</code></a></span></li>
<li><span class="pkg-link" data-pkg="geosapi" data-topic="GSRule" data-id="encode"><a href='../../geosapi/html/GSRule.html#method-GSRule-encode'><code>geosapi::GSRule$encode()</code></a></span></li>
</ul>
</details>

<hr>
<a id="method-GSLayerRule-new"></a></p><div class='section' id='method-new-'>
<h3>Method <code>new()</code></h3>
<p>Initializes a GSLayerRule</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>GSLayerRule$new(
  xml = NULL,
  ws = NULL,
  lyr,
  permission = c("r", "w", "a"),
  roles
)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>xml</code></dt>
<dd><p>an object of class <a href='http://xml2.r-lib.org/reference/oldclass.html'>xml_node-class</a></p></dd>


<dt><code>ws</code></dt>
<dd><p>the resource workspace. Default is <code>NULL</code></p></dd>


<dt><code>lyr</code></dt>
<dd><p>the target layer to which the access control should be added</p></dd>


<dt><code>permission</code></dt>
<dd><p>the rule permission, either <code>r</code> (read), <code>w</code> (write) or <code>a</code> (administer)</p></dd>


<dt><code>roles</code></dt>
<dd><p>one or more roles to add for the rule</p></dd>


</dl><p></div></p>
</div>

</div><p><hr>
<a id="method-GSLayerRule-clone"></a></p><div class='section' id='method-clone-'>
<h3>Method <code>clone()</code></h3>
<p>The objects of this class are cloneable with this method.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>GSLayerRule$clone(deep = FALSE)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>deep</code></dt>
<dd><p>Whether to make a deep clone.</p></dd>


</dl><p></div></p>
</div>

</div>


GSLayerRule: A GeoServer access control list layer rule

Description

Arguments

Value

Format

Author

Super classes

Public fields

Methods

Public methods

Method `new()`

Usage

Arguments

Method `clone()`

Usage

Arguments

Details

Description

Arguments

Value

Format

Author

Super classes

Public fields

Methods

Public methods

Method new()

Usage

Arguments

Method clone()

Usage

Arguments

Details

Method `new()`

Method `clone()`