GSServiceSettings: A GeoServer service settings resource

GSServiceSettingsR Documentation

A GeoServer service settings resource

Description

This class models a GeoServer OWS service settings.

Format

R6Class object.

Details

Geoserver REST API Service Setting

Value

Object of R6Class for modelling a GeoServer OWS service setting

Methods

new(rootName, xml)

This method is used to instantiate a GSServiceSettings. This settings object is required to model/manipulate an OGC service configuration, using the method GSManager$updateServiceSettings or derivates.

decode(xml)

This method is used to decode a GSServiceSettings from XML

encode()

This method is used to encode a GSServiceSettings to XML. Inherited from the generic GSRESTResource encoder

setEnabled(enabled)

Sets if the service is enabled (TRUE) or not (FALSE)

setCiteCompliant(citeCompliant)

Sets if the service is compliant with CITE (TRUE) or not (FALSE)

setName(name)

Sets the service name

setTitle(title)

Sets the service title

setAbstract(abstract)

Sets the service abstract

setMaintainer(maintainer)

Sets the service maintainer

setKeywords(keywords)

Sets a list of keywords

addKeyword(keyword)

Sets a keyword. Returns TRUE if set, FALSE otherwise

delKeyword(keyword)

Deletes a keyword. Returns TRUE if deleted, FALSE otherwise

setOnlineResource(onlineResource)

Sets the online resource

setSchemaBaseURL(schemaBaseURL)

Sets the schema base URL. Default is http://schemas.opengis.net

setVerbose(verbose)

Sets verbose

Super class

geosapi::GSRESTResource -> GSServiceSettings

Public fields

enabled

is service enabled or not?

citeCompliant

is service cite compliant?

name

service name

title

service title

maintainer

service maintainer

abstrct

service abastract

accessConstraints

service access constraints

fees

service fees

keywords

services keywords

onlineResource

service online resource

schemaBaseURL

service schema base URL

verbose

service verbose or not?

Methods

Public methods

Inherited methods

Method new()

Initializes an object of class GSServiceSettings

Usage
GSServiceSettings$new(xml = NULL, service)
Arguments
xml

object of class XMLInternalNode-class

service

service service acronym


Method decode()

Decodes from XML

Usage
GSServiceSettings$decode(xml)
Arguments
xml

object of class XMLInternalNode-class


Method setEnabled()

Set enabled

Usage
GSServiceSettings$setEnabled(enabled)
Arguments
enabled

enabled


Method setCiteCompliant()

Set cite compliant

Usage
GSServiceSettings$setCiteCompliant(citeCompliant)
Arguments
citeCompliant

cite compliant


Method setName()

Set name

Usage
GSServiceSettings$setName(name)
Arguments
name

name


Method setTitle()

Set title

Usage
GSServiceSettings$setTitle(title)
Arguments
title

title


Method setMaintainer()

Set maintainer

Usage
GSServiceSettings$setMaintainer(maintainer)
Arguments
maintainer

maintainer


Method setAbstract()

Set abstract

Usage
GSServiceSettings$setAbstract(abstract)
Arguments
abstract

abstract


Method setAccessConstraints()

Set access constraints

Usage
GSServiceSettings$setAccessConstraints(accessConstraints)
Arguments
accessConstraints

access constraints


Method setFees()

Set fees

Usage
GSServiceSettings$setFees(fees)
Arguments
fees

fees


Method setKeywords()

Set keywords

Usage
GSServiceSettings$setKeywords(keywords)
Arguments
keywords

keywords


Method addKeyword()

Adds a keyword

Usage
GSServiceSettings$addKeyword(keyword)
Arguments
keyword

keyword

Returns

TRUE if added, FALSE otherwise


Method delKeyword()

Deletes a keyword

Usage
GSServiceSettings$delKeyword(keyword)
Arguments
keyword

keyword

Returns

TRUE if deleted, FALSE otherwise


Method clone()

The objects of this class are cloneable with this method.

Usage
GSServiceSettings$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Author(s)

Emmanuel Blondel <emmanuel.blondel1@gmail.com>

Examples

settings <- GSServiceSettings$new(service = "WMS")
settings$setEnabled(TRUE)


geosapi documentation built on May 2, 2022, 5:05 p.m.