org.activiti.content.storage.api

Interface ContentStorage

public interface ContentStorage

Storage for reading and writing content.

Author:

Frederik Heremans

Method Summary

Modifier and Type	Method and Description
ContentObject	createContentObject(InputStream contentStream, Long lengthHint)
void	deleteContentObject(String id) Deletes the object the given id.
ContentObject	getContentObject(String id)
ContentObject	updateContentObject(String id, InputStream contentStream, Long lengthHint) Update the content with the given id to the content present in the given stream.

Method Detail

createContentObject

ContentObject createContentObject(InputStream contentStream,
                                  Long lengthHint)

Parameters:

lengthHint - hint about the stream length. If length is unknown, pass in null or a negative number.

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.

updateContentObject

ContentObject updateContentObject(String id,
                                  InputStream contentStream,
                                  Long lengthHint)

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

Parameters:

lengthHint - hint about the stream length. If length is unknown, pass in null or a negative number.

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

deleteContentObject

void deleteContentObject(String id)

Deletes the object the given id.

Throws:

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

ContentStorageException - When an error occurred while deleting the content.