com.sdl.delivery.deployer.api.binarystorage

Interface BinaryStorageClient

public interface BinaryStorageClient

Binary storage client interface.

Method Summary

Modifier and Type	Method and Description
boolean	containsKey(String binaryId) Check if binary id is available in storage.
Map<String,byte[]>	get(Stream<String> binaryIds) Get map of binary ids to their contents.
InputStream	get(String binaryId) Get Input stream of content from binary storage.
Set<String>	keys() Get all binary ids from storage.
Set<String>	keysStartingWith(String prefix) Get all binary ids with provided prefix.
String	put(String binaryId, byte[] content) Add content for binary id to storage.
boolean	remove(String binaryId) Remove content from storage by binary id.
String	rename(String keyName, String newKeyName) Rename key in Binary Storage.

Method Detail

get

InputStream get(String binaryId)

Get Input stream of content from binary storage.

Parameters:

binaryId - content id.

Returns:

stream of content.

get

Map<String,byte[]> get(Stream<String> binaryIds)

Get map of binary ids to their contents.

Parameters:

binaryIds - content ids.

Returns:

map of ids to content.

put

String put(String binaryId,
           byte[] content)

Add content for binary id to storage.

Parameters:

binaryId - id of content.

content - content to insert to storage.

Returns:

status of operation: OK if succeed.

rename

String rename(String keyName,
              String newKeyName)

Rename key in Binary Storage.

Parameters:

keyName - previous key name.

newKeyName - new key name.

remove

boolean remove(String binaryId)

Remove content from storage by binary id.

Parameters:

binaryId - content id.

Returns:

true if remove is successful.

containsKey

boolean containsKey(String binaryId)

Check if binary id is available in storage.

Parameters:

binaryId - id of content.

Returns:

true if content is available in storage.

keys

Set<String> keys()

Get all binary ids from storage.

Returns:

all content ids.

keysStartingWith

Set<String> keysStartingWith(String prefix)

Get all binary ids with provided prefix.

Parameters:

prefix - binary id should start from this prefix.

Returns:

all ids starting with prefix.