org.flowable.content.engine.impl.fs

Class SimpleFileSystemContentStorage

java.lang.Object

org.flowable.content.engine.impl.fs.SimpleFileSystemContentStorage

All Implemented Interfaces:

ContentStorage

public class SimpleFileSystemContentStorage
extends Object
implements ContentStorage

(Very) simple implementation of the ContentStorage that relies on the passed metadata to store content. Under a root folder, a division between 'task' and 'process-instance' content is made. New content gets a new UUID assigned and is placed in one of these folders. The id of the returned ContentObject indicates in which folder it is stored.

Author:

Joram Barrez

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	SimpleFileSystemContentStorage.MapBasedContentObjectStorageMetadata

Field Summary

Fields

Modifier and Type	Field and Description
static String	CASE_PREFIX
protected File	caseFolder
protected File	contentFolderRoot
static String	PROCESS_INSTANCE_PREFIX
protected File	processInstanceFolder
static String	TASK_PREFIX
protected File	taskFolder
static String	TYPE_CASE_INSTANCE
static String	TYPE_PROCESS_INSTANCE
static String	TYPE_TASK
static String	TYPE_UNCATEGORIZED
static String	UNCATEGORIZED_PREFIX
protected File	uncategorizedFolder

Constructor Summary

Constructors

Constructor and Description
SimpleFileSystemContentStorage(File contentFolderRoot)

Method Summary

Modifier and Type	Method and Description
ContentObject	createContentObject(InputStream contentStream, ContentObjectStorageMetadata metaData) Reads the given InputStream and stores it.
ContentObject	createContentObject(InputStream contentStream, Map<String,Object> metaData) Deprecated.
protected File	createOrGetFolderBasedOnMetaData(ContentObjectStorageMetadata metaData)
void	deleteContentObject(String id) Deletes the object the given id.
protected String	determineType(ContentObjectStorageMetadata metaData)
protected String	generateContentId(String uuid, ContentObjectStorageMetadata metaData)
protected File	getContentFile(ContentObjectStorageMetadata metaData, String contentId)
protected File	getContentFile(String id)
ContentObject	getContentObject(String id)
String	getContentStoreName()
Map<String,Object>	getMetaData()
protected File	internalCreateOrGetFolder(File parentFolder, String id)
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.
protected File	validateOrCreateFolder(String folderName)
protected void	validateOrCreateSubfolders()

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_TASK

public static final String TYPE_TASK

See Also:

Constant Field Values

TYPE_PROCESS_INSTANCE

public static final String TYPE_PROCESS_INSTANCE

See Also:

Constant Field Values

TYPE_CASE_INSTANCE

public static final String TYPE_CASE_INSTANCE

See Also:

Constant Field Values

TYPE_UNCATEGORIZED

public static final String TYPE_UNCATEGORIZED

See Also:

Constant Field Values

TASK_PREFIX

public static final String TASK_PREFIX

See Also:

Constant Field Values

PROCESS_INSTANCE_PREFIX

public static final String PROCESS_INSTANCE_PREFIX

See Also:

Constant Field Values

CASE_PREFIX

public static final String CASE_PREFIX

See Also:

Constant Field Values

UNCATEGORIZED_PREFIX

public static final String UNCATEGORIZED_PREFIX

See Also:

Constant Field Values

contentFolderRoot

protected File contentFolderRoot

taskFolder

protected File taskFolder

processInstanceFolder

protected File processInstanceFolder

caseFolder

protected File caseFolder

uncategorizedFolder

protected File uncategorizedFolder

Constructor Detail

SimpleFileSystemContentStorage

public SimpleFileSystemContentStorage(File contentFolderRoot)

Method Detail

validateOrCreateSubfolders

protected void validateOrCreateSubfolders()

validateOrCreateFolder

protected File validateOrCreateFolder(String folderName)

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

generateContentId

protected String generateContentId(String uuid,
                                   ContentObjectStorageMetadata metaData)

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.

getContentObject

public ContentObject getContentObject(String id)

Specified by:

getContentObject in interface ContentStorage

Returns:

a ContentObject with the given id.

getContentFile

protected File getContentFile(String id)

getMetaData

public Map<String,Object> getMetaData()

Specified by:

getMetaData in interface ContentStorage

Returns:

Returns the metadata that was passed when creating the ContentObject

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

getContentFile

protected File getContentFile(ContentObjectStorageMetadata metaData,
                              String contentId)

determineType

protected String determineType(ContentObjectStorageMetadata metaData)

createOrGetFolderBasedOnMetaData

protected File createOrGetFolderBasedOnMetaData(ContentObjectStorageMetadata metaData)

internalCreateOrGetFolder

protected File internalCreateOrGetFolder(File parentFolder,
                                         String id)