OccurrencesApiProvider

JSKOS Occurrences API.

This class provides access to concept occurrences via JSKOS API in JSKOS format.

To use it in a registry, specify provider as "OccurrencesApi" and provide the API base URL as api:

{
 "uri": "http://coli-conc.gbv.de/registry/occurrences",
 "provider": "OccurrencesApi",
 "api": "https://coli-conc.gbv.de/occurrences/api/"
}

Additionally, the following JSKOS properties can be provided: prefLabel, notation, definition

Constructor

new OccurrencesApiProvider()

Source

Extends

Members

(readonly) has :Object

A dictionary with functionality of the registry (e.g. registry.has.schemes).

Type:
  • Object
Inherited From
Source

languages :Array.<string>

A list of RFC 3066 language tags in lowercase in order of priority.

Type:
  • Array.<string>
Inherited From
Source

Methods

(async) deleteMappings(config) → {Array.<Object>}

DELETEs multiple mappings. Do not override in subclass!

Parameters:
NameTypeDescription
configObject
Properties
NameTypeDescription
mappingsArray

array of mapping objects

Inherited From
Source
Returns:

array of results (true if successful); in case of failure, consult the _errors property on the array at the index of the failed request

Type: 
Array.<Object>

getCancelTokenSource() → {Object}

Returns a source for a axios cancel token.

Inherited From
Source
Returns:

axios cancel token source

Type: 
Object

(async) getMappings(config) → {Array.<Object>}

Wrapper around getOccurrences that converts occurrences into mappings.

Parameters:
NameTypeDescription
configObject

config object for getOccurrences request

Source
Returns:

array of JSKOS mapping objects

Type: 
Array.<Object>

(async) getOccurrences(config) → {Array.<Object>}

Returns a list of occurrences.

Parameters:
NameTypeDescription
configObject
Properties
NameTypeAttributesDescription
fromObject<optional>

JSKOS concept to load occurrences for (from side)

toObject<optional>

JSKOS concept to load occurrences for (to side)

conceptsArray.<Object><optional>

list of JSKOS concepts to load occurrences for

Source
Returns:

array of JSKOS occurrence objects

Type: 
Array.<Object>

(async) init() → {Promise}

Load data about registry via the status endpoint.

Inherited From
Source
Returns:

Promise that resolves when initialization is complete.

Type: 
Promise

isAuthorizedFor(options) → {boolean}

Returns whether a user is authorized for a certain request.

Parameters:
NameTypeDescription
optionsObject
Properties
NameTypeAttributesDescription
typestring

type of item (e.g. mappings)

actionstring

action to be performed (read/create/update/delete)

userObject

user object

crossUserboolean<optional>

whether the request is a crossUser request (i.e. updading/deleting another user's item)

Inherited From
Source
Returns:
Type: 
boolean

(async) postMappings(config) → {Array.<Object>}

POSTs multiple mappings. Do not override in subclass!

Parameters:
NameTypeDescription
configObject
Properties
NameTypeDescription
mappingsArray

array of mapping objects

Inherited From
Source
Returns:

array of created mapping objects; in case of failure, consult the _errors property on the array at the index of the failed request

Type: 
Array.<Object>

setAuth(options)

Sets authentication credentials.

Parameters:
NameTypeDescription
optionsObject
Properties
NameTypeDescription
keystring

public key of login-server instance the user is authorized for

bearerTokenstring

token that is sent with each request

Inherited From
Source

setRetryConfig(config)

Sets retry configuration.

Parameters:
NameTypeDescription
configObject
Properties
NameTypeAttributesDefaultDescription
methodsArray.<string><optional>
["get", "head", "options"]

HTTP methods to retry (lowercase)

statusCodesArray.<number><optional>
[401, 403]

status codes to retry

countnumber<optional>
3

maximum number of retries

delaynumber | function<optional>
300*count

a delay in ms or a function that takes the number of current retries and returns a delay in ms

Inherited From
Source

supportsScheme(scheme) → {boolean}

Returns a boolean whether a certain target scheme is supported or not.

Parameters:
NameTypeDescription
schemeObject
Inherited From
Source
Returns:
Type: 
boolean