org.trellisldp.api

Interface BinaryService

All Superinterfaces:

RetrievalService<Binary>

All Known Implementing Classes:

FileBinaryService

public interface BinaryService
extends RetrievalService<Binary>

The BinaryService provides methods for retrieving, modifying and checking the validity of binary content.

Method Summary

Modifier and Type	Method and Description
CompletionStage<MessageDigest>	calculateDigest(IRI identifier, MessageDigest algorithm) Calculate the digest for a binary object.
String	generateIdentifier() Get a new identifier.
CompletionStage<Void>	purgeContent(IRI identifier) Purge the content from its corresponding datastore.
CompletionStage<Void>	setContent(BinaryMetadata metadata, InputStream stream) Set the content for a binary object.
default CompletionStage<MessageDigest>	setContent(BinaryMetadata metadata, InputStream stream, MessageDigest algorithm) Set the content for a binary object using a digest algorithm.
Set<String>	supportedAlgorithms() Get a list of supported algorithms.

Methods inherited from interface org.trellisldp.api.RetrievalService

get

Method Detail

setContent

CompletionStage<Void> setContent(BinaryMetadata metadata,
                                 InputStream stream)

Set the content for a binary object.

Parameters:

metadata - the binary metadata

stream - the content

Returns:

the new completion stage

setContent

default CompletionStage<MessageDigest> setContent(BinaryMetadata metadata,
                                                  InputStream stream,
                                                  MessageDigest algorithm)

Set the content for a binary object using a digest algorithm.

Parameters:

metadata - the binary metadata

stream - the context

algorithm - the digest algorithm

Returns:

the new completion stage containing the server-computed digest.

Implementation Requirements:

The default implementation will compute a digest while processing the InputStream.

purgeContent

CompletionStage<Void> purgeContent(IRI identifier)

Purge the content from its corresponding datastore.

Parameters:

identifier - the binary object identifier

Returns:

a new completion stage that, when the stage completes normally, indicates that the binary data were successfully deleted from the corresponding persistence layer. In the case of an unsuccessful 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.

calculateDigest

CompletionStage<MessageDigest> calculateDigest(IRI identifier,
                                               MessageDigest algorithm)

Calculate the digest for a binary object.

Parameters:

identifier - the identifier

algorithm - the algorithm

Returns:

the new completion stage containing a computed digest for the binary resource

API Note:

As per RFC 3230, the digest value is calculated over the entire resource, not just the HTTP payload.

supportedAlgorithms

Set<String> supportedAlgorithms()

Get a list of supported algorithms.

Returns:

the supported digest algorithms

generateIdentifier

String generateIdentifier()

Get a new identifier.

Returns:

a new identifier