OWSClient: OWSClient

OWSClientR Documentation

OWSClient

Description

OWSClient

OWSClient

Format

R6Class object.

Value

Object of R6Class with methods for interfacing a Common OGC web-service.

Super class

ows4R::OGCAbstractObject -> OWSClient

Public fields

url

Base url of the OWS service

version

version of the OWS service

capabilities

object giving the OWS service capabilities

Methods

Public methods

Inherited methods

Method new()

This method is used to instantiate a OWSClient with the url of the OGC service. Authentication is supported using basic auth (using user/pwd arguments), bearer token (using token argument), or custom (using headers argument). By default, the logger argument will be set to NULL (no logger). This argument accepts two possible values: INFO: to print only ows4R logs, DEBUG: to print more verbose logs

Usage
OWSClient$new(
  url,
  service,
  serviceVersion,
  user = NULL,
  pwd = NULL,
  token = NULL,
  headers = c(),
  config = httr::config(),
  cas_url = NULL,
  logger = NULL
)
Arguments
url

url

service

service name

serviceVersion

CSW service version

user

user

pwd

password

token

token

headers

headers

config

config

cas_url

Central Authentication Service (CAS) URL

logger

logger


Method getUrl()

Get URL

Usage
OWSClient$getUrl()
Returns

the url of the service, object of class character


Method getVersion()

Get version

Usage
OWSClient$getVersion()
Returns

the version of the service, object of class character


Method getCapabilities()

Get capabilities

Usage
OWSClient$getCapabilities()
Returns

the capabilities, object of class OWSCapabilities


Method getUser()

Get user

Usage
OWSClient$getUser()
Returns

the user, object of class character


Method getPwd()

Get password

Usage
OWSClient$getPwd()
Returns

the password, object of class character


Method getToken()

Get token

Usage
OWSClient$getToken()
Returns

the token, object of class character


Method getHeaders()

Get headers

Usage
OWSClient$getHeaders()
Returns

the headers, object of class character


Method getConfig()

Get httr config

Usage
OWSClient$getConfig()
Returns

the httr config, if any


Method getCASUrl()

Get CAS URL

Usage
OWSClient$getCASUrl()
Returns

a CAS URL


Method clone()

The objects of this class are cloneable with this method.

Usage
OWSClient$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Note

Abstract class used internally by ows4R

Author(s)

Emmanuel Blondel <emmanuel.blondel1@gmail.com>


ows4R documentation built on June 26, 2024, 5:09 p.m.