org.alfresco.repo.content.filestore
Class FileContentStore

java.lang.Object
  extended by org.alfresco.repo.content.AbstractContentStore
      extended by org.alfresco.repo.content.filestore.FileContentStore
All Implemented Interfaces:
java.util.EventListener, ContentStore, org.springframework.context.ApplicationContextAware, org.springframework.context.ApplicationListener

public class FileContentStore
extends AbstractContentStore
implements org.springframework.context.ApplicationContextAware, org.springframework.context.ApplicationListener

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.


Nested Class Summary
 
Nested classes/interfaces inherited from interface org.alfresco.repo.content.ContentStore
ContentStore.ContentUrlHandler
 
Field Summary
static java.lang.String STORE_PROTOCOL
          store is the new prefix for file content URLs
 
Fields inherited from interface org.alfresco.repo.content.ContentStore
NEW_CONTENT_CONTEXT, PROTOCOL_DELIMITER
 
Constructor Summary
FileContentStore(org.springframework.context.ApplicationContext context, java.io.File rootDirectory)
          Public constructor for programmatic use.
FileContentStore(org.springframework.context.ApplicationContext context, java.lang.String rootDirectoryStr)
          Public constructor for programmatic use.
 
Method Summary
static java.lang.String createNewFileStoreUrl()
          Creates a new content URL.
 boolean delete(java.lang.String contentUrl)
          Attempts to delete the content.
 boolean exists(java.lang.String contentUrl)
          Performs a direct check against the file for its existence.
 org.alfresco.service.cmr.repository.ContentReader getReader(java.lang.String contentUrl)
          This implementation requires that the URL start with FileContentStore.STORE_PROTOCOL.
 java.lang.String getRootLocation()
          Get the location where the store is rooted.
 long getSpaceFree()
          Get the filesystem's free space.
 long getSpaceTotal()
          Get the filesystem's total space.
 long getSpaceUsed()
          Performs a full, deep size calculation
 void getUrls(java.util.Date createdAfter, java.util.Date createdBefore, ContentStore.ContentUrlHandler handler)
          Gets the urls.
 org.alfresco.service.cmr.repository.ContentWriter getWriterInternal(org.alfresco.service.cmr.repository.ContentReader existingContentReader, java.lang.String newContentUrl)
          Returns a writer onto a location based on the date.
 boolean isWriteSupported()
          Check if the store supports write requests.
 void onApplicationEvent(org.springframework.context.ApplicationEvent event)
           
 void setAllowRandomAccess(boolean allowRandomAccess)
          Stores may optionally produce readers and writers that support random access.
 void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
           
 void setDeleteEmptyDirs(boolean deleteEmptyDirs)
          Configure the FileContentStore to delete empty parent directories upon deleting a content URL.
 void setReadOnly(boolean readOnly)
          File stores may optionally be declared read-only.
 java.lang.String toString()
           
 
Methods inherited from class org.alfresco.repo.content.AbstractContentStore
getContentUrlParts, getTotalSize, getUrls, getWriter, getWriter, isContentUrlSupported, isValidContentUrl
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

STORE_PROTOCOL

public static final java.lang.String STORE_PROTOCOL
store is the new prefix for file content URLs

See Also:
ContentStore.PROTOCOL_DELIMITER, Constant Field Values
Constructor Detail

FileContentStore

public FileContentStore(org.springframework.context.ApplicationContext context,
                        java.lang.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.FileContentStore(File)

FileContentStore

public FileContentStore(org.springframework.context.ApplicationContext context,
                        java.io.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.
Method Detail

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

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.

isWriteSupported

public boolean isWriteSupported()
Description copied from interface: ContentStore
Check if the store supports write requests.

Specified by:
isWriteSupported in interface ContentStore
Returns:
Returns true always

exists

public boolean exists(java.lang.String contentUrl)
Performs a direct check against the file for its existence.

Specified by:
exists in interface ContentStore
Overrides:
exists in class AbstractContentStore
Parameters:
contentUrl - the path to the content
Returns:
Returns true if the content exists, otherwise false if the content doesn't exist or if the URL is not applicable to this store.
See Also:
ContentReader.exists()

getSpaceUsed

public long getSpaceUsed()
Performs a full, deep size calculation

Specified by:
getSpaceUsed in interface ContentStore
Overrides:
getSpaceUsed in class AbstractContentStore
Returns:
Returns -1 always

getSpaceFree

public long getSpaceFree()
Get the filesystem's free space.

Specified by:
getSpaceFree in interface ContentStore
Overrides:
getSpaceFree in class AbstractContentStore
Returns:
Returns the root directory partition's free space

getSpaceTotal

public long getSpaceTotal()
Get the filesystem's total space.

Specified by:
getSpaceTotal in interface ContentStore
Overrides:
getSpaceTotal in class AbstractContentStore
Returns:
Returns the root directory partition's total space

getRootLocation

public java.lang.String getRootLocation()
Description copied from class: AbstractContentStore
Get the location where the store is rooted. The format of the returned value will depend on the specific implementation of the store.

Specified by:
getRootLocation in interface ContentStore
Overrides:
getRootLocation in class AbstractContentStore
Returns:
Returns the canonical path to the root directory

getReader

public org.alfresco.service.cmr.repository.ContentReader getReader(java.lang.String contentUrl)
This implementation requires that the URL start with FileContentStore.STORE_PROTOCOL.

Specified by:
getReader in interface ContentStore
Parameters:
contentUrl - the path to where the content is located
Returns:
Returns a read-only content accessor for the given URL. There may be no content at the given URL, but the reader must still be returned.
See Also:
ContentStore.exists(String), ContentReader.exists(), EmptyContentReader

getWriterInternal

public org.alfresco.service.cmr.repository.ContentWriter getWriterInternal(org.alfresco.service.cmr.repository.ContentReader existingContentReader,
                                                                           java.lang.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

getUrls

public void getUrls(java.util.Date createdAfter,
                    java.util.Date createdBefore,
                    ContentStore.ContentUrlHandler handler)
Gets the urls.

Specified by:
getUrls in interface ContentStore
Overrides:
getUrls in class AbstractContentStore
Parameters:
createdAfter - the created after date
createdBefore - the created before dat6e
handler - the handler

delete

public boolean delete(java.lang.String contentUrl)
Attempts to delete the content. The actual deletion is optional on the interface so it just returns the success or failure of the underlying delete.

Specified by:
delete in interface ContentStore
Overrides:
delete in class AbstractContentStore
Parameters:
contentUrl - the URL of the content to delete
Returns:
Returns true if the content was deleted (either by this or another operation), otherwise false. If the content no longer exists, then true is returned.
Throws:
java.lang.UnsupportedOperationException - if the store is read-only
See Also:
FileContentStore.setReadOnly(boolean)

createNewFileStoreUrl

public static java.lang.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

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


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.