org.flowable.content.api

Interface ContentStorage

public interface ContentStorage

Storage for reading and writing content.

Author:

Frederik Heremans, Joram Barrez

Method Summary

Modifier and Type	Method and Description
default ContentObject	createContentObject(InputStream contentStream, ContentObjectStorageMetadata metaData) Reads the given InputStream and stores it.
ContentObject	createContentObject(InputStream contentStream, Map<String,Object> metaData) Deprecated. use createContentObject(InputStream, ContentObjectStorageMetadata) instead
void	deleteContentObject(String id) Deletes the object the given id.
ContentObject	getContentObject(String id)
String	getContentStoreName()
Map<String,Object>	getMetaData()
default ContentObject	updateContentObject(String id, InputStream contentStream, ContentObjectStorageMetadata metaData) Update the content with the given id to the content present in the given stream.
ContentObject	updateContentObject(String id, InputStream contentStream, Map<String,Object> metaData) Deprecated. use updateContentObject(String, InputStream, ContentObjectStorageMetadata) instead

Method Detail

createContentObject

@Deprecated
ContentObject createContentObject(InputStream contentStream,
                                              Map<String,Object> metaData)

Deprecated. use createContentObject(InputStream, ContentObjectStorageMetadata) instead

Parameters:

contentStream -

metaData - A key-value collection that can be used to change the way the content is stored.

Returns:

reads the given InputStream and stores it. Returns a ContentObject with a unique id generated - which can be used for reading the content again.

createContentObject

default ContentObject createContentObject(InputStream contentStream,
                                          ContentObjectStorageMetadata metaData)

Reads the given InputStream and stores it.

Parameters:

contentStream - the content stream that should be stored

metaData - additional data that can be used to change the way the content is stored

Returns:

a ContentObject with a unique id generated - which can be used for reading the content again

updateContentObject

@Deprecated
ContentObject updateContentObject(String id,
                                              InputStream contentStream,
                                              Map<String,Object> metaData)

Deprecated. use updateContentObject(String, InputStream, ContentObjectStorageMetadata) instead

Update the content with the given id to the content present in the given stream.

Parameters:

id -

contentStream -

metaData - A key-value collection that can be used to change the way the content is stored.

Returns:

Returns a ContentObject with a unique id generated - which can br used for reading the content again.

Throws:

ContentStorageException - When an exception occurred while updating the content and the content is not updated.

updateContentObject

default ContentObject updateContentObject(String id,
                                          InputStream contentStream,
                                          ContentObjectStorageMetadata metaData)

Update the content with the given id to the content present in the given stream.

Parameters:

id - the id of the content being updated

contentStream - the content stream that should be updated

metaData - additional data that can be used to change the way the content is stored

Returns:

Returns a ContentObject with a unique id generated - which can br used for reading the content again.

Throws:

ContentStorageException - When an exception occurred while updating the content and the content is not updated.

getContentObject

ContentObject getContentObject(String id)

Returns:

a ContentObject with the given id.

Throws:

ContentNotFoundException - When the content with the given id does not exist

getMetaData

Map<String,Object> getMetaData()

Returns:

Returns the metadata that was passed when creating the ContentObject

deleteContentObject

void deleteContentObject(String id)

Deletes the object the given id.

Parameters:

id -

Throws:

ContentNotFoundException - When the content with the given id does not exist

ContentStorageException - When an error occurred while deleting the content.

getContentStoreName

String getContentStoreName()