Package org.trellisldp.spi

Interface BinaryService

public interface BinaryService

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	BinaryService.MultipartUpload	A multipart upload container
static interface	BinaryService.Resolver	A blob resolver, used by the BinaryService

Method Summary

Modifier and Type	Method	Description
default java.util.Optional<java.lang.String>	calculateDigest(java.lang.String partition, org.apache.commons.rdf.api.IRI identifier, java.lang.String algorithm)	Calculate the digest for a binary object
java.util.Optional<java.lang.String>	digest(java.lang.String algorithm, java.io.InputStream stream)	Get the digest for an input stream
default java.lang.Boolean	exists(java.lang.String partition, org.apache.commons.rdf.api.IRI identifier)	Test whether a binary object exists at the given URI
default java.util.Optional<java.io.InputStream>	getContent(java.lang.String partition, org.apache.commons.rdf.api.IRI identifier)	Get the content of the binary object
java.util.function.Supplier<java.lang.String>	getIdentifierSupplier(java.lang.String partition)	An identifier supplier
java.util.Optional<BinaryService.Resolver>	getResolver(org.apache.commons.rdf.api.IRI identifier)	Get the resolver for the given identifier
java.util.Optional<BinaryService.Resolver>	getResolverForPartition(java.lang.String partition)	Get the default resolver for the given partition
default void	purgeContent(java.lang.String partition, org.apache.commons.rdf.api.IRI identifier)	Purge the content from its corresponding datastore
default void	setContent(java.lang.String partition, org.apache.commons.rdf.api.IRI identifier, java.io.InputStream stream)	Set the content for a binary object
default void	setContent(java.lang.String partition, org.apache.commons.rdf.api.IRI identifier, java.io.InputStream stream, java.util.Map<java.lang.String,java.lang.String> metadata)	Set the content for a binary object
java.util.Set<java.lang.String>	supportedAlgorithms()	Get a list of supported algorithms

Method Detail

getContent

default java.util.Optional<java.io.InputStream> getContent(java.lang.String partition,
                                                           org.apache.commons.rdf.api.IRI identifier)

Get the content of the binary object

Parameters:

partition - the partition to use

identifier - an identifier used for locating the binary object

Returns:

the content

exists

default java.lang.Boolean exists(java.lang.String partition,
                                 org.apache.commons.rdf.api.IRI identifier)

Test whether a binary object exists at the given URI

Parameters:

partition - the partition to use

identifier - the binary object identifier

Returns:

whether the binary object exists

setContent

default void setContent(java.lang.String partition,
                        org.apache.commons.rdf.api.IRI identifier,
                        java.io.InputStream stream)

Set the content for a binary object

Parameters:

partition - the partition to use

identifier - the binary object identifier

stream - the content

setContent

default void setContent(java.lang.String partition,
                        org.apache.commons.rdf.api.IRI identifier,
                        java.io.InputStream stream,
                        java.util.Map<java.lang.String,java.lang.String> metadata)

Set the content for a binary object

Parameters:

partition - the partition to use

identifier - the binary object identifier

stream - the content

metadata - any user metadata

purgeContent

default void purgeContent(java.lang.String partition,
                          org.apache.commons.rdf.api.IRI identifier)

Purge the content from its corresponding datastore

Parameters:

partition - the partition to use

identifier - the binary object identifier

calculateDigest

default java.util.Optional<java.lang.String> calculateDigest(java.lang.String partition,
                                                             org.apache.commons.rdf.api.IRI identifier,
                                                             java.lang.String algorithm)

Calculate the digest for a binary object

Parameters:

partition - the partition to use

identifier - the identifier

algorithm - the algorithm

Returns:

the digest

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

supportedAlgorithms

java.util.Set<java.lang.String> supportedAlgorithms()

Get a list of supported algorithms

Returns:

the supported digest algorithms

getResolver

java.util.Optional<BinaryService.Resolver> getResolver(org.apache.commons.rdf.api.IRI identifier)

Get the resolver for the given identifier

Parameters:

identifier - the identifier

Returns:

a binary object resolver

getResolverForPartition

java.util.Optional<BinaryService.Resolver> getResolverForPartition(java.lang.String partition)

Get the default resolver for the given partition

Parameters:

partition - the partition name

Returns:

a binary object resolver

digest

java.util.Optional<java.lang.String> digest(java.lang.String algorithm,
                                            java.io.InputStream stream)

Get the digest for an input stream

Parameters:

algorithm - the algorithm to use

stream - the input stream

Returns:

a string representation of the digest

Note: the digest likely uses the base64 encoding, but the specific encoding is defined for each algorithm at https://www.iana.org/assignments/http-dig-alg/http-dig-alg.xhtml

getIdentifierSupplier

java.util.function.Supplier<java.lang.String> getIdentifierSupplier(java.lang.String partition)

An identifier supplier

Parameters:

partition - the partition to use

Returns:

a supplier of identifiers for new resources