com.sdl.delivery.deployer.api.binarystorage

Interface BinaryStorage

All Superinterfaces:

BinaryStorageBase

public interface BinaryStorage
extends BinaryStorageBase

Storage able to store binary (streams) that can be referenced by a single String-based id.

Field Summary

Fields inherited from interface com.sdl.delivery.deployer.api.binarystorage.BinaryStorageBase

INSTANCE, LOG

Method Summary

Modifier and Type	Method and Description
boolean	clear() Wipe out all the binaries currently stored.
boolean	delete(String... ids) Delete the binaries stored under the given ids.
Consumer<File>	fileCleaner() Removes file in storage.
Optional<InputStream>	get(String id) Get the binary stored with the given id as an option.
String	getBasePath()
Set<String>	getBinaryIds() Get all ids.
Set<String>	getBinaryIds(Predicate<String> filter) Gets a set of ids, accepted by predicate, referring to binaries currently stored.
default String	getBinaryPath(String binaryId)
String	getId() Get the Binary Storage Id.
default URI	getResolvedUri(URI uriToResolve) Resolve uri with taking care of authority for UNC paths.
Set<String>	listFolder(String pathRelativeToBasePath) Get all folders which are sub-folders of provided relative path.
default void	move(Path source, Path target) Moves one Path in storage to another.
void	removeFolder(File folder, boolean doLocking) Remove folder in storage.
default boolean	renameTo(File source, File target) Rename source in storage.
default void	unzip(File zipArchive, File targetLocation) Unzip archive in storage.

Methods inherited from interface com.sdl.delivery.deployer.api.binarystorage.BinaryStorageBase

contains, createDirectories, fileReader, fileWriter, flushWriter, folderFileReader, get, getWriter, put

Method Detail

getId

String getId()

Get the Binary Storage Id.

Returns:

The Binary Storage Id.

get

Optional<InputStream> get(String id)

Get the binary stored with the given id as an option. id is something like this: tcm_0-146-60.Content.zip -> /deployer/binary-storage/tcm_0-146-60.Content.zip

Parameters:

id - The given id.

Returns:

The binary stored.

getBinaryIds

Set<String> getBinaryIds()

Get all ids. referring to binaries currently stored.

Returns:

All the ids.

listFolder

Set<String> listFolder(String pathRelativeToBasePath)

Get all folders which are sub-folders of provided relative path.

Parameters:

pathRelativeToBasePath - Relative path to the base path.

Returns:

list of folder names which are placed in provided relative path to the base path

getBinaryIds

Set<String> getBinaryIds(Predicate<String> filter)

Gets a set of ids, accepted by predicate, referring to binaries currently stored.

Parameters:

filter - Predicate to do filtering.

Returns:

All the ids, which are accepted by predicate.

delete

boolean delete(String... ids)

Delete the binaries stored under the given ids. In case one given id.

Parameters:

ids - The given ids.

Returns:

true if the binaries were successfully deleted, false otherwise.

clear

boolean clear()

Wipe out all the binaries currently stored.

Returns:

true if all the binaries were successfully deleted, false otherwise.

getBasePath

String getBasePath()

Returns:

base path.

getBinaryPath

default String getBinaryPath(String binaryId)

Returns:

binary path.

fileCleaner

Consumer<File> fileCleaner()

Removes file in storage.

Returns:

lambda of file remover.

move

default void move(Path source,
                  Path target)
           throws IOException

Moves one Path in storage to another.

Parameters:

source - initial source path.

target - target path.

Throws:

IOException - move is failed.

removeFolder

void removeFolder(File folder,
                  boolean doLocking)
           throws IOException

Remove folder in storage.

Parameters:

folder - to remove.

doLocking - locking flag.

Throws:

IOException - remove is failed.

unzip

default void unzip(File zipArchive,
                   File targetLocation)
            throws IOException

Unzip archive in storage.

Parameters:

zipArchive - archive to unzip.

targetLocation - unzip to target folder.

Throws:

IOException - failed unzipping.

renameTo

default boolean renameTo(File source,
                         File target)

Rename source in storage.

Parameters:

source - file or folder to rename.

target - target file or folder.

Returns:

true if renaming succeed.

getResolvedUri

default URI getResolvedUri(URI uriToResolve)

Resolve uri with taking care of authority for UNC paths.

Parameters:

uriToResolve - uri to resolve

Returns:

resolve uri