org.flowable.content.engine.impl.fs

Class FileSystemContentStorage

java.lang.Object

org.flowable.content.engine.impl.fs.FileSystemContentStorage

All Implemented Interfaces:

ContentStorage

public class FileSystemContentStorage
extends Object
implements ContentStorage

Note that this implementation of the ContentStorage interface doesn't do anything with the passed metadata, nor returns it when requested!

Author:

Frederik Heremans, Joram Barrez

Constructor Summary

Constructors

Constructor and Description
FileSystemContentStorage(File contentFolderRoot, int blockSize, int depth)

Method Summary

Modifier and Type	Method and Description
protected ContentObject	createContentObject(InputStream contentStream)
ContentObject	createContentObject(InputStream contentStream, ContentObjectStorageMetadata metaData) Reads the given InputStream and stores it.
ContentObject	createContentObject(InputStream contentStream, Map<String,Object> metaData) Deprecated.
void	deleteContentObject(String id) Deletes the object the given id.
protected BigInteger	fetchNewId()
ContentObject	getContentObject(String id)
String	getContentStoreName()
protected File	getFileForId(String id, boolean shouldExist)
protected File	getFirstAvailableFolder(int maxRetries)
protected File	getMaxChild(File file)
Map<String,Object>	getMetaData()
protected ContentObject	updateContentObject(String id, InputStream contentStream)
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileSystemContentStorage

public FileSystemContentStorage(File contentFolderRoot,
                                int blockSize,
                                int depth)

Parameters:

contentFolderRoot - root folder where all content will be stored in

blockSize - max size of a single folder's children

depth - depth of the tree created to store content in

See Also:

PathConverter

Method Detail

createContentObject

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

Deprecated.

Specified by:

createContentObject in interface ContentStorage

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

public ContentObject createContentObject(InputStream contentStream,
                                         ContentObjectStorageMetadata metaData)

Description copied from interface: ContentStorage

Reads the given InputStream and stores it.

Specified by:

createContentObject in interface ContentStorage

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

createContentObject

protected ContentObject createContentObject(InputStream contentStream)

getContentObject

public ContentObject getContentObject(String id)

Specified by:

getContentObject in interface ContentStorage

Returns:

a ContentObject with the given id.

getMetaData

public Map<String,Object> getMetaData()

Specified by:

getMetaData in interface ContentStorage

Returns:

Returns the metadata that was passed when creating the ContentObject

updateContentObject

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

Deprecated.

Description copied from interface: ContentStorage

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

Specified by:

updateContentObject in interface ContentStorage

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.

updateContentObject

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

Description copied from interface: ContentStorage

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

Specified by:

updateContentObject in interface ContentStorage

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.

updateContentObject

protected ContentObject updateContentObject(String id,
                                            InputStream contentStream)

deleteContentObject

public void deleteContentObject(String id)

Description copied from interface: ContentStorage

Deletes the object the given id.

Specified by:

deleteContentObject in interface ContentStorage

getContentStoreName

public String getContentStoreName()

Specified by:

getContentStoreName in interface ContentStorage

getFileForId

protected File getFileForId(String id,
                            boolean shouldExist)

Returns:

a file reference for the given id, checking for existence based on the given flag.

fetchNewId

protected BigInteger fetchNewId()

getFirstAvailableFolder

protected File getFirstAvailableFolder(int maxRetries)

getMaxChild

protected File getMaxChild(File file)