Private Readonly accessorPrivate Readonly auxiliaryPrivate Readonly identifierProtected Readonly loggerPrivate Readonly metadataPrivate addGenerates activity metadata for a resource and adds it to the ChangeMap
ChangeMap to update.
Identifier of the resource being changed.
Which activity is taking place.
Private addGenerates activity metadata specifically for Add/Remove events on a container.
ChangeMap to update.
Identifier of the container.
If there is a resource being added (true) or removed (false).
The object that is being added/removed.
Creates a new resource in the container.
Container in which to create a resource.
Representation of the new resource
Optional conditions: ConditionsOptional conditions under which to proceed.
A ChangeMap.
Protected cleanProtected createCreate containers starting from the root until the given identifier corresponds to an existing container. Will throw errors if the identifier of the last existing "container" corresponds to an existing document.
Identifier of the container which will need to exist.
Protected createGenerate a valid URI to store a new Resource in the given container. URI will be based on the slug header if there is one and is guaranteed to not exist yet.
Identifier of the target container.
Metadata of the new resource.
Protected createURIGenerates a new URI for a resource in the given container, potentially using the given slug.
Solid, §5.3: "Servers MUST allow creating new resources with a POST request to URI path ending /.
Servers MUST create a resource with URI path ending /{id} in container /.
Servers MUST create a container with URI path ending /{id}/ in container / for requests
including the HTTP Link header with rel="type" targeting a valid LDP container type."
https://solid.github.io/specification/protocol#writing-resources
Parent container of the new URI.
Does the new URI represent a container?
Optional slug: stringSlug to use for the new URI.
Deletes a resource.
Identifier of resource to delete.
Optional conditions: ConditionsOptional conditions under which to proceed.
A ChangeMap.
Protected getReturns the metadata matching the identifier, ignoring the presence of a trailing slash or not.
Solid, §3.1: "If two URIs differ only in the trailing slash, and the server has associated a resource with one of them, then the other URI MUST NOT correspond to another resource." https://solid.github.io/specification/protocol#uri-slash-semantics
First the identifier gets requested and if no result is found the identifier with differing trailing slash is requested.
Identifier that needs to be checked.
Retrieves a representation of a resource.
Identifier of the resource to read.
A representation corresponding to the identifier.
Protected getReturns the result of getNormalizedMetadata or undefined if a 404 error is thrown.
Protected handleWarns when the representation has data and removes the content-type from the metadata.
Container representation.
Protected hasProtected hasChecks if the given container has any non-auxiliary resources.
Check if a resource exists in this ResourceSet.
Identifier of resource to check.
A promise resolving if the resource already exists.
Protected isChecks if the given metadata represents a (potential) container, based on the metadata.
Metadata of the (new) resource.
Protected isVerifies if this is the metadata of a root storage container.
Sets or updates the representation of a resource, creating a new resource and intermediary containers as needed.
Identifier of resource to update.
Description of which parts to update.
Optional conditions: ConditionsOptional conditions under which to proceed.
A ChangeMap.
Protected removeRemoves all generated data from metadata to prevent it from being stored permanently.
Protected safelyDeletes the given array of auxiliary identifiers. Does not throw an error if something goes wrong.
Sets or replaces the representation of a resource, creating a new resource and intermediary containers as needed.
Identifier of resource to update.
New representation of the resource.
Optional conditions: ConditionsOptional conditions under which to proceed.
A ChangeMap.
Protected updateUpdates the last modified date of the given container
Protected validateVerify if the given metadata matches the conditions.
Optional conditions: ConditionsOptional metadata: RepresentationMetadataProtected validateVerify if the given identifier matches the stored base.
Protected validateValidates if the slug and headers are valid. Errors if slug exists, ends on slash, but ContainerType Link header is NOT present
Is the slug supposed to represent a container?
Optional slug: stringIs the requested slug (if any).
Protected writeWrite the given resource to the DataAccessor. Metadata will be updated with necessary triples.
In case of containers handleContainerData will be used to verify the data.
Identifier of the resource.
Corresponding Representation.
Is the incoming resource a container?
Should parent containers (potentially) be created?
If the resource already exists.
Identifiers of resources that were possibly modified.
Protected writeWrite the given metadata resource to the DataAccessor.
Identifier of the metadata.
Corresponding Representation.
Identifiers of resources that were possibly modified.
ResourceStore which uses a DataAccessor for backend access.
The DataAccessor interface provides elementary store operations such as read and write. This DataAccessorBasedStore uses those elementary store operations to implement the more high-level ResourceStore contact, abstracting all common functionality such that new stores can be added by implementing the more simple DataAccessor contract. DataAccessorBasedStore thereby provides behaviours for reuse across different stores, such as:
Currently "metadata" is seen as something that is not directly accessible. That means that a consumer can't write directly to the metadata of a resource, only indirectly through headers. (Except for containers where data and metadata overlap).
The one thing this store does not take care of (yet?) are containment triples for containers
Work has been done to minimize the number of required calls to the DataAccessor, but the main disadvantage is that sometimes multiple calls are required where a specific store might only need one.