OWSHttpRequest: OWSHttpRequest

In eblondel/ows4R: Interface to OGC Web-Services (OWS)

OWSHttpRequest

Description

OWSHttpRequest

OWSHttpRequest

Format

R6Class object.

Value

Object of R6Class for modelling a generic OWS http request

Super class

ows4R::OGCAbstractObject -> OWSHttpRequest

Methods

Public methods

• OWSHttpRequest$new()

• OWSHttpRequest$execute()

• OWSHttpRequest$getCapabilities()

• OWSHttpRequest$getRequest()

• OWSHttpRequest$getRequestHeaders()

• OWSHttpRequest$getStatus()

• OWSHttpRequest$getResponse()

• OWSHttpRequest$getException()

• OWSHttpRequest$hasException()

• OWSHttpRequest$getResult()

• OWSHttpRequest$setResult()

• OWSHttpRequest$clone()

Inherited methods

• ows4R::OGCAbstractObject$ERROR()
• ows4R::OGCAbstractObject$INFO()
• ows4R::OGCAbstractObject$WARN()
• ows4R::OGCAbstractObject$encode()
• ows4R::OGCAbstractObject$getClass()
• ows4R::OGCAbstractObject$getClassName()
• ows4R::OGCAbstractObject$getNamespaceDefinition()
• ows4R::OGCAbstractObject$isFieldInheritedFrom()
• ows4R::OGCAbstractObject$logger()
• ows4R::OGCAbstractObject$print()

---

Method new()

Initializes an OWS HTTP request

Usage

OWSHttpRequest$new(
  element,
  namespacePrefix,
  capabilities,
  op,
  type,
  url,
  request,
  user = NULL,
  pwd = NULL,
  token = NULL,
  headers = c(),
  config = httr::config(),
  namedParams = NULL,
  attrs = NULL,
  contentType = "text/xml",
  mimeType = "text/xml",
  skipXmlComments = TRUE,
  logger = NULL,
  ...
)

Arguments

element

element

namespacePrefix

namespace prefix

capabilities

object of class or extending OWSCapabilities

op

object of class OWSOperation

type

type of request, eg. GET, POST

url

url

request

request name

user

user

pwd

password

token

token

headers

headers

config

config

namedParams

a named list

attrs

attributes

contentType

content type. Default value is "text/xml"

mimeType

mime type. Default value is "text/xml"

skipXmlComments

Skip XML comments from response

logger

logger

...

any other parameter

---

Method execute()

Executes the request

Usage

OWSHttpRequest$execute()

---

Method getCapabilities()

Get capabilities

Usage

OWSHttpRequest$getCapabilities()

Returns

an object of class or extending OWSCapabilities

---

Method getRequest()

Get request

Usage

OWSHttpRequest$getRequest()

Returns

the request

---

Method getRequestHeaders()

Get request headers

Usage

OWSHttpRequest$getRequestHeaders()

Returns

the request headers

---

Method getStatus()

get status code

Usage

OWSHttpRequest$getStatus()

Returns

the request status code

---

Method getResponse()

get request response

Usage

OWSHttpRequest$getResponse()

Returns

the request response

---

Method getException()

get request exception

Usage

OWSHttpRequest$getException()

Returns

the request exception

---

Method hasException()

Indicates if it has an exception

Usage

OWSHttpRequest$hasException()

Returns

TRUE if it has an exception, FALSE otherwise

---

Method getResult()

Get the result TRUE if the request is successful, FALSE otherwise

Usage

OWSHttpRequest$getResult()

Returns

the result, object of class logical

---

Method setResult()

Set the result

Usage

OWSHttpRequest$setResult(result)

Arguments

result

object of class logical

---

Method clone()

The objects of this class are cloneable with this method.

Usage

OWSHttpRequest$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Note

Abstract class used internally by ows4R

Author(s)

Emmanuel Blondel <[e-mail]>

eblondel/ows4R documentation built on April 1, 2024, 8:18 a.m.