Package org.alfresco.repo.content.filestore

Class FileContentStore

  • All Implemented Interfaces:
    EventListener, ContentStore, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.ApplicationListener<org.springframework.context.ApplicationEvent>
    @AlfrescoPublicApi
public class FileContentStore
extends AbstractContentStore
implements org.springframework.context.ApplicationContextAware, org.springframework.context.ApplicationListener<org.springframework.context.ApplicationEvent>
    Provides a store of node content directly to the file system. The writers are generated using information from the simple content context.

    The file names obey, as they must, the URL naming convention as specified in the ContentStore interface.
    The protocols handled are:

    • store: These URLs can be generated by this implementation and are file references within the root directory.
    • spoof: These URLs are never generated by the implementation but represent spoofed binary text stream data.
    Author:
    Derek Hulley

    • Constructor Detail

      • FileContentStore

        public FileContentStore​(org.springframework.context.ApplicationContext context,
                        String rootDirectoryStr)
        Public constructor for programmatic use.
        Parameters:
        context - application context through which events can be published
        rootDirectoryStr - the root under which files will be stored. The directory will be created if it does not exist.
        See Also:
        FileContentStore(File)

      • FileContentStore

        public FileContentStore​(org.springframework.context.ApplicationContext context,
                        File rootDirectory)
        Public constructor for programmatic use.
        Parameters:
        context - application context through which events can be published
        rootDirectory - the root under which files will be stored. The directory will be created if it does not exist.

      • FileContentStore

        public FileContentStore​(org.springframework.context.ApplicationContext context,
                        File rootDirectory,
                        Map<String,​Serializable> extendedEventParams)

    • Method Detail

      • setApplicationContext

        public void setApplicationContext​(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException
        Specified by:
        setApplicationContext in interface org.springframework.context.ApplicationContextAware
        Throws:
        org.springframework.beans.BeansException

      • setAllowRandomAccess

        public void setAllowRandomAccess​(boolean allowRandomAccess)
        Stores may optionally produce readers and writers that support random access. Switch this off for this store by setting this to false.

        This switch is primarily used during testing to ensure that the system has the ability to spoof random access in cases where the store is unable to produce readers and writers that allow random access. Typically, stream-based access would be an example.

        Parameters:
        allowRandomAccess - true to allow random access, false to have it faked

      • setReadOnly

        public void setReadOnly​(boolean readOnly)
        File stores may optionally be declared read-only. This is useful when configuring a store, possibly temporarily, to act as a source of data but to preserve it against any writes.
        Parameters:
        readOnly - true to force the store to only allow reads.

      • setFileContentUrlProvider

        public void setFileContentUrlProvider​(FileContentUrlProvider fileContentUrlProvider)

      • isWriteSupported

        public boolean isWriteSupported()
        Specified by:
        isWriteSupported in interface ContentStore
        Returns:
        Returns true always

      • getWriterInternal

        public ContentWriter getWriterInternal​(ContentReader existingContentReader,
                                       String newContentUrl)
        Returns a writer onto a location based on the date.
        Overrides:
        getWriterInternal in class AbstractContentStore
        Parameters:
        existingContentReader - the existing content reader
        newContentUrl - the new content url
        Returns:
        Returns a writer onto a location based on the date

      • createNewFileStoreUrl

        public static String createNewFileStoreUrl()
        Creates a new content URL. This must be supported by all stores that are compatible with Alfresco.
        Returns:
        Returns a new and unique content URL

      • onApplicationEvent

        public void onApplicationEvent​(org.springframework.context.ApplicationEvent event)
        Specified by:
        onApplicationEvent in interface org.springframework.context.ApplicationListener<org.springframework.context.ApplicationEvent>

      • setDeleteEmptyDirs

        public void setDeleteEmptyDirs​(boolean deleteEmptyDirs)
        Configure the FileContentStore to delete empty parent directories upon deleting a content URL.
        Parameters:
        deleteEmptyDirs - the deleteEmptyDirs to set