SwordClient: SwordClient class

In atom4R: Tools to Handle and Publish Metadata as 'Atom' XML Format

SwordClient class

Description

This class models an Sword service client

Format

R6Class object.

Details

SwordClient

Value

Object of R6Class for modelling an Sword client

Super classes

atom4R::atom4RLogger -> atom4R::AtomPubClient -> SwordClient

Methods

Public methods

• SwordClient$new()

• SwordClient$getServiceDocument()

• SwordClient$getCollectionMembers()

• SwordClient$clone()

Inherited methods

• atom4R::atom4RLogger$ERROR()
• atom4R::atom4RLogger$INFO()
• atom4R::atom4RLogger$WARN()
• atom4R::atom4RLogger$getClass()
• atom4R::atom4RLogger$getClassName()
• atom4R::atom4RLogger$logger()
• atom4R::AtomPubClient$getPwd()
• atom4R::AtomPubClient$getToken()
• atom4R::AtomPubClient$getUser()
• atom4R::AtomPubClient$listCollections()

---

Method new()

This method is to instantiate an Sword Client. By default the version is set to "2".

The keyring_backend can be set to use a different backend for storing the SWORD API user token with keyring (Default value is 'env').

The logger allows to specify the level of log (default is NULL), either "INFO" for atom4R logs or "DEBUG" for verbose HTTP client (curl) logs.

Usage

SwordClient$new(
  url,
  version = "2",
  user = NULL,
  pwd = NULL,
  token = NULL,
  logger = NULL,
  keyring_backend = "env"
)

Arguments

url

url

version

version. Default is "2"

user

user

pwd

pwd

token

token

logger

logger

keyring_backend

keyring backend. Default is 'env'

---

Method getServiceDocument()

Get service document

Usage

SwordClient$getServiceDocument(force = FALSE)

Arguments

force

force Force getting/refreshing of service document

Returns

object of class SwordServiceDocument

---

Method getCollectionMembers()

Get collection members. Unimplemented abstract method at SwordClient level

Usage

SwordClient$getCollectionMembers()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

SwordClient$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Note

Abstract class

Author(s)

Emmanuel Blondel <[e-mail]>

atom4R documentation built on Sept. 1, 2025, 5:09 p.m.