com.sdl.delivery.deployer.api.binarystorage

Interface BinaryStorageBase

All Known Subinterfaces:

BinaryStorage

public interface BinaryStorageBase

Base interface for working with binary storage. Contains default methods and lambdas for accessing content on file system.

Field Summary

Fields

Modifier and Type	Field and Description
static BinaryStorageBase	INSTANCE Default instance of BinaryStorageBase.
static org.slf4j.Logger	LOG Logger for default implementations.

Method Summary

Modifier and Type	Method and Description
default boolean	contains(String id) Checks if binary exists within storage.
default void	createDirectories(Path... directories) Create directories on file system.
default Function<File,byte[]>	fileReader() Constructs reader function that reads content from a file as array of bytes.
default BiConsumer<File,byte[]>	fileWriter() Constructs writer function that writes array of bytes to a file.
default BiConsumer<Writer,File>	flushWriter() Flushes writer to the file.
default BiFunction<File,String,String>	folderFileReader() Reads content from file in directory as a String.
default Optional<InputStream>	get(File file) Get the binary stored with the given id as an option.
default BiFunction<File,String,Writer>	getWriter() Constructs a function that returns writer for a given outputFile possibly using charsetName when non-null.
boolean	put(String id, InputStream stream) Store the given binary referenced by the given id.

Field Detail

LOG

static final org.slf4j.Logger LOG

Logger for default implementations.

INSTANCE

static final BinaryStorageBase INSTANCE

Default instance of BinaryStorageBase.

Method Detail

put

boolean put(String id,
            InputStream stream)

Store the given binary referenced by the given id.

Parameters:

id - The given id.

stream - The given binary to store.

Returns:

true if binary was put.

get

default Optional<InputStream> get(File file)

Get the binary stored with the given id as an option.

Parameters:

file - The given File.

Returns:

The binary stored.

contains

default boolean contains(String id)

Checks if binary exists within storage.

Parameters:

id - The given id.

Returns:

true if binary could be found, false otherwise.

folderFileReader

default BiFunction<File,String,String> folderFileReader()

Reads content from file in directory as a String.

Returns:

lambda of file reader.

fileReader

default Function<File,byte[]> fileReader()

Constructs reader function that reads content from a file as array of bytes.

Returns:

lambda of file reader. Lambda accepts File and returns byte[] array.

fileWriter

default BiConsumer<File,byte[]> fileWriter()

Constructs writer function that writes array of bytes to a file.

Returns:

lambda of file writer. Lambda accepts File as a destination parameter and byte[] array that should be written to the destination.

getWriter

default BiFunction<File,String,Writer> getWriter()

Constructs a function that returns writer for a given outputFile possibly using charsetName when non-null.

Returns:

lambda that creates an initialized writer.

Lambda arguments:

• File were the writer should writes to;
• String encoding. When non-null used when writing to the output file;
• Writer an initialized writer.

flushWriter

default BiConsumer<Writer,File> flushWriter()

Flushes writer to the file.

Returns:

lambda that flushes writer to the file. Lambda accepts Writer with content and target File.

createDirectories

default void createDirectories(Path... directories)
                        throws IOException

Create directories on file system.

Parameters:

directories - paths to create.

Throws:

IOException - creating is failed.