org.trellisldp.api

Interface MutableDataService<U>

Type Parameters:

U - the type of resource that can be persisted by this service

All Superinterfaces:

RetrievalService<U>

All Known Subinterfaces:

ResourceService

All Known Implementing Classes:

JoiningResourceService, TriplestoreResourceService

public interface MutableDataService<U>
extends RetrievalService<U>

A service that persists resources by replacing their records.

Method Summary

Modifier and Type	Method and Description
default CompletionStage<Void>	create(Metadata metadata, Dataset dataset) Create a resource in the server.
CompletionStage<Void>	delete(Metadata metadata) Delete a resource from the server.
CompletionStage<Void>	replace(Metadata metadata, Dataset dataset) Replace a resource in the server.

Methods inherited from interface org.trellisldp.api.RetrievalService

get

Method Detail

create

default CompletionStage<Void> create(Metadata metadata,
                                     Dataset dataset)

Create a resource in the server.

Parameters:

metadata - metadata for the new resource

dataset - the dataset to be persisted

Returns:

a new completion stage that, when the stage completes normally, indicates that the supplied data were successfully created in the corresponding persistence layer. In the case of an unsuccessful write operation, the CompletionStage will complete exceptionally and can be handled with CompletionStage.handle(java.util.function.BiFunction<? super T, java.lang.Throwable, ? extends U>), CompletionStage.exceptionally(java.util.function.Function<java.lang.Throwable, ? extends T>) or similar methods.

Implementation Requirements:

the default implementation of this method is to proxy create requests to the replace(org.trellisldp.api.Metadata, org.apache.commons.rdf.api.Dataset) method.

replace

CompletionStage<Void> replace(Metadata metadata,
                              Dataset dataset)

Replace a resource in the server.

Parameters:

metadata - metadata for the resource

dataset - the dataset to be persisted

Returns:

a new completion stage that, when the stage completes normally, indicates that the supplied data were successfully stored in the corresponding persistence layer. In the case of an unsuccessful write operation, the CompletionStage will complete exceptionally and can be handled with CompletionStage.handle(java.util.function.BiFunction<? super T, java.lang.Throwable, ? extends U>), CompletionStage.exceptionally(java.util.function.Function<java.lang.Throwable, ? extends T>) or similar methods.

delete

CompletionStage<Void> delete(Metadata metadata)

Delete a resource from the server.

Parameters:

metadata - metadata for the resource

Returns:

a new completion stage that, when the stage completes normally, indicates that the resource was successfully deleted from the corresponding persistence layer. In the case of an unsuccessful delete operation, the CompletionStage will complete exceptionally and can be handled with CompletionStage.handle(java.util.function.BiFunction<? super T, java.lang.Throwable, ? extends U>), CompletionStage.exceptionally(java.util.function.Function<java.lang.Throwable, ? extends T>) or similar methods.