-
Notifications
You must be signed in to change notification settings - Fork 0
Configuration Service
The Configuration service maintains configuration and most of the state information for a LOCKSS cluster. Only a few of the endpoints will be of interest to external clients - most are used for internal purposes by other LOCKSS components.
Many of the APIs here and in other services that access the content or operate on an AU require an AUID. Clients may obtain AUIDs from these two endpoints:
returns a (paged) list of the AuConfiguration for all active AUs.
calculates and returns the AUID corresponding to the specified plugin and AuConfiguration. The general case is to supply a pluginId and auConfig. For convenience when working with Named AUs, the handle may be supplied as the only argument. (In this case a pluginId may also be supplied, but it must be a subclass of NamedPlugin.)
- pluginId - optional
- auConfig - optional
- handle - optional
An AU is created by storing its configuration, deleted by deleting its configuration. (Deleting an AU doesn't remove any content already stored in the repository, it merely stops crawling, polling and most access activities.)
An AU's identity is determined by its plugin and configuration. The only parts of an AU's configuration that can be chanaged once it's created are non-defitional config params; anything else would change it into a different AU, which is not permitted.
stores an AuConfiguration
- auid - required.
- auconfiguration - required. Json representation of an auConfiguration object containing the AUID and a map with a value for each configuration key specified by the plugin.
returns the AuConfiguration for the AU with the specified AUID.
deletes the AU with the specified AUID.
[Remainder in progress]
[In progress] Most of the endpoints in this section are used to store or access various state information. They will be of most use to dashboard writers.