GSRule

<p>This class models a GeoServer access control list 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

GSRule 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>GSRule</code></p>

Super class


<div class="section" id="public-methods">
<h3>Public methods</h3><p></p><p><ul>
<li><p><a href="/link/GSRule%24new()?package=geosapi&version=0.8-1" data-mini-rdoc="geosapi::GSRule$new()"><code>GSRule$new()</code></a></p></li>
<li><p><a href="/link/GSRule%24encode()?package=geosapi&version=0.8-1" data-mini-rdoc="geosapi::GSRule$encode()"><code>GSRule$encode()</code></a></p></li>
<li><p><a href="/link/GSRule%24decode()?package=geosapi&version=0.8-1" data-mini-rdoc="geosapi::GSRule$decode()"><code>GSRule$decode()</code></a></p></li>
<li><p><a href="/link/GSRule%24clone()?package=geosapi&version=0.8-1" data-mini-rdoc="geosapi::GSRule$clone()"><code>GSRule$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>
</ul>
</details></p><p><hr>
<a id="method-GSRule-new"></a></p><div class="section" id="method-new-">
<h3>Method <code>new()</code></h3>
<p>Initializes a GSRule</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>GSRule$new(xml = NULL)</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>
</p><p></p>
<p></p><p></p><p><hr>
<a id="method-GSRule-encode"></a></p><div class="section" id="method-encode-">
<h3>Method <code>encode()</code></h3>
<p>Encodes as XML</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>GSRule$encode()</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="returns">
<h4>Returns</h4>
<p>an object of class <a href="http://xml2.r-lib.org/reference/oldclass.html">xml_node-class</a></p>
</div></p><p></p><p><hr>
<a id="method-GSRule-decode"></a></p><div class="section" id="method-decode-">
<h3>Method <code>decode()</code></h3>
<p>Decodes from XML</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>GSRule$decode(xml)</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>
</p><p></p>
<p></p><p></p><p><hr>
<a id="method-GSRule-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>GSRule$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 rule — GSRule

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


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

<ul>
<li><p><a href='#method-GSRule-new'><code>GSRule$new()</code></a></p></li>
<li><p><a href='#method-GSRule-encode'><code>GSRule$encode()</code></a></p></li>
<li><p><a href='#method-GSRule-decode'><code>GSRule$decode()</code></a></p></li>
<li><p><a href='#method-GSRule-clone'><code>GSRule$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>
</ul>
</details>

<hr>
<a id="method-GSRule-new"></a></p><div class='section' id='method-new-'>
<h3>Method <code>new()</code></h3>
<p>Initializes a GSRule</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>GSRule$new(xml = NULL)</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>


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

</div><p><hr>
<a id="method-GSRule-encode"></a></p><div class='section' id='method-encode-'>
<h3>Method <code>encode()</code></h3>
<p>Encodes as XML</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>GSRule$encode()</code></pre><p></div></p>
</div>

<div class='section' id='returns'>
<h4>Returns</h4>
<p>an object of class <a href='http://xml2.r-lib.org/reference/oldclass.html'>xml_node-class</a></p>
</div>

</div><p><hr>
<a id="method-GSRule-decode"></a></p><div class='section' id='method-decode-'>
<h3>Method <code>decode()</code></h3>
<p>Decodes from XML</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>GSRule$decode(xml)</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>


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

</div><p><hr>
<a id="method-GSRule-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>GSRule$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>


GSRule: A GeoServer access control list rule

Description

Arguments

Value

Format

Author

Super class

Methods

Public methods

Method `new()`

Usage

Arguments

Method `encode()`

Usage

Returns

Method `decode()`

Usage

Arguments

Method `clone()`

Usage

Arguments

Details

Description

Arguments

Value

Format

Author

Super class

Methods

Public methods

Method new()

Usage

Arguments

Method encode()

Usage

Returns

Method decode()

Usage

Arguments

Method clone()

Usage

Arguments

Details

Method `new()`

Method `encode()`

Method `decode()`

Method `clone()`