org.trellisldp.file

Class FileBinaryService

java.lang.Object

org.trellisldp.file.FileBinaryService

All Implemented Interfaces:

BinaryService, RetrievalService<Binary>

public class FileBinaryService
extends Object
implements BinaryService

A BinaryService implementation that stores LDP-NR resources as files on a local filesystem.

This service supports the following digest algorithms:

• MD5
• MD2
• SHA
• SHA-1
• SHA-256
• SHA-384
• SHA-512

When running under JDK 9+, the following additional digest algorithms are supported:

• SHA3-256
• SHA3-384
• SHA3-512

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIG_FILE_BINARY_BASE_PATH The configuration key controlling the base filesystem path for the binary service.
static String	CONFIG_FILE_BINARY_HIERARCHY The configuration key controlling the levels of hierarchy in a binary storage layout.
static String	CONFIG_FILE_BINARY_LENGTH The configuration key controlling the length of each level of hierarchy in a filesystem layout.

Constructor Summary

Constructors

Constructor and Description
FileBinaryService() Create a File-based Binary service.
FileBinaryService(IdentifierService idService) Create a File-based Binary service.
FileBinaryService(IdentifierService idService, String basePath, int hierarchy, int length) Create a File-based Binary service.

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<Binary>	get(IRI identifier) Get a resource by the given 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.
Set<String>	supportedAlgorithms() Get a list of supported algorithms.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.trellisldp.api.BinaryService

setContent

Field Detail

CONFIG_FILE_BINARY_BASE_PATH

public static final String CONFIG_FILE_BINARY_BASE_PATH

The configuration key controlling the base filesystem path for the binary service.

See Also:

Constant Field Values

CONFIG_FILE_BINARY_HIERARCHY

public static final String CONFIG_FILE_BINARY_HIERARCHY

The configuration key controlling the levels of hierarchy in a binary storage layout.

See Also:

Constant Field Values

CONFIG_FILE_BINARY_LENGTH

public static final String CONFIG_FILE_BINARY_LENGTH

The configuration key controlling the length of each level of hierarchy in a filesystem layout.

See Also:

Constant Field Values

Constructor Detail

FileBinaryService

@Inject
public FileBinaryService()

Create a File-based Binary service.

FileBinaryService

public FileBinaryService(IdentifierService idService)

Create a File-based Binary service.

Parameters:

idService - an identifier service

FileBinaryService

public FileBinaryService(IdentifierService idService,
                         String basePath,
                         int hierarchy,
                         int length)

Create a File-based Binary service.

Parameters:

idService - an identifier service

basePath - the base file path

hierarchy - the levels of hierarchy

length - the length of each level of hierarchy

Method Detail

get

public CompletionStage<Binary> get(IRI identifier)

Description copied from interface: RetrievalService

Get a resource by the given identifier.

Specified by:

get in interface RetrievalService<Binary>

Parameters:

identifier - the resource identifier

Returns:

the resource

purgeContent

public CompletionStage<Void> purgeContent(IRI identifier)

Description copied from interface: BinaryService

Purge the content from its corresponding datastore.

Specified by:

purgeContent in interface BinaryService

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.

setContent

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

Description copied from interface: BinaryService

Set the content for a binary object.

Specified by:

setContent in interface BinaryService

Parameters:

metadata - the binary metadata

stream - the content

Returns:

the new completion stage

calculateDigest

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

Description copied from interface: BinaryService

Calculate the digest for a binary object.

Specified by:

calculateDigest in interface BinaryService

Parameters:

identifier - the identifier

algorithm - the algorithm

Returns:

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

supportedAlgorithms

public Set<String> supportedAlgorithms()

Description copied from interface: BinaryService

Get a list of supported algorithms.

Specified by:

supportedAlgorithms in interface BinaryService

Returns:

the supported digest algorithms

generateIdentifier

public String generateIdentifier()

Description copied from interface: BinaryService

Get a new identifier.

Specified by:

generateIdentifier in interface BinaryService

Returns:

a new identifier