com.communote.server.core.crc

Class FilesystemConnector

java.lang.Object

com.communote.server.core.crc.FilesystemConnector

All Implemented Interfaces:

MetadataRepositoryConnector, RepositoryConnector, Serializable

public class FilesystemConnector
extends Object
implements MetadataRepositoryConnector

A class for the ContentRepositoryConnector to use a file system.

Author:

Communote GmbH - http://www.communote.com/

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_FILESYSTEM_CONNECTOR Id for default file system connector.

Constructor Summary

Constructors

Constructor and Description
FilesystemConnector(RepositoryConnectorConfiguration connectorConfiguration) Constructor for a new FilesystemConnector, based on the given FilesystemConfiguration.

Method Summary

Modifier and Type	Method and Description
void	clearContent() Deletes all files from the repository.
void	deleteContent(ContentId contentId) Delete the content with the given ContentId.
RepositoryConnectorConfiguration	getConfiguration()
AttachmentTO	getContent(ExtendedContentId contentId) Returns a ContentTO that is associated with the given ContentId.
ContentMetadata	getMetadata(ContentId contentId) Return the ContentMetadata that is associated with the given ContentId.
protected String	getPath()
long	getRepositorySize()
long	getRepositorySizeLimit()
float	getRepositorySizeLimitRatio() Gets the ratio of the current repository size to the repository size limit.
float	getRepositorySizeLimitRatio(long sizeOfNewDataToStore) Gets the ratio of the current repository size plus sizeOfNewDataToStore to the repository size limit.
protected void	prepareStorageDirectory() Create the directory returned by getPath() if it does not yet exist.
void	removeConnector() Callback that is invoked if a connector is removed.
ContentId	storeContent(AttachmentTO contentTo) Store the given ContentTO and return a ContentId for it.
void	updateMetadata(ContentMetadata metadata) Update the metadata of existing content with the provided metadata.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_FILESYSTEM_CONNECTOR

public static final String DEFAULT_FILESYSTEM_CONNECTOR

Id for default file system connector.

See Also:

Constant Field Values

Constructor Detail

FilesystemConnector

public FilesystemConnector(RepositoryConnectorConfiguration connectorConfiguration)
                    throws IOException

Constructor for a new FilesystemConnector, based on the given FilesystemConfiguration.

Parameters:

connectorConfiguration - The configuration for this connector.

Throws:

IOException - in case the the directory for storing the content cannot be created or exists and is not a directory or cannot be accessed

Method Detail

clearContent

public void clearContent()
                  throws ContentRepositoryException

Deletes all files from the repository.

Specified by:

clearContent in interface RepositoryConnector

Throws:

ContentRepositoryException - Exception.

deleteContent

public void deleteContent(ContentId contentId)
                   throws ContentRepositoryException

Delete the content with the given ContentId.

Specified by:

deleteContent in interface RepositoryConnector

Parameters:

contentId - The ContentId for the content to delete.

Throws:

ContentRepositoryException - in case deleting the content failed

getConfiguration

public RepositoryConnectorConfiguration getConfiguration()

Specified by:

getConfiguration in interface RepositoryConnector

Returns:

the configuration of the connector

getContent

public AttachmentTO getContent(ExtendedContentId contentId)
                        throws ContentRepositoryException

Returns a ContentTO that is associated with the given ContentId.

Specified by:

getContent in interface RepositoryConnector

Parameters:

contentId - The ContentId for the ContentTO to be read.

Returns:

The read ContentTO.

Throws:

ContentRepositoryException - in case reading the content failed

getMetadata

public ContentMetadata getMetadata(ContentId contentId)

Return the ContentMetadata that is associated with the given ContentId.

Specified by:

getMetadata in interface MetadataRepositoryConnector

Parameters:

contentId - The ContentId for the ContentTO to be read.

Returns:

The read ContentMetadata.

getPath

protected String getPath()

Returns:

the path to the directory for storing content

getRepositorySize

public long getRepositorySize()

Specified by:

getRepositorySize in interface RepositoryConnector

Returns:

the current repository size in bytes

getRepositorySizeLimit

public long getRepositorySizeLimit()

Specified by:

getRepositorySizeLimit in interface RepositoryConnector

Returns:

the repository size limit in bytes. 0 if there is no limit.

getRepositorySizeLimitRatio

public float getRepositorySizeLimitRatio()

Description copied from interface: RepositoryConnector

Gets the ratio of the current repository size to the repository size limit. If there is no size limit 0 is returned.

Specified by:

getRepositorySizeLimitRatio in interface RepositoryConnector

Returns:

the ratio of current size to the repository size limit. 0 if there are no limits.

getRepositorySizeLimitRatio

public float getRepositorySizeLimitRatio(long sizeOfNewDataToStore)

Description copied from interface: RepositoryConnector

Gets the ratio of the current repository size plus sizeOfNewDataToStore to the repository size limit. If there is no size limit 0 is returned.

Specified by:

getRepositorySizeLimitRatio in interface RepositoryConnector

Parameters:

sizeOfNewDataToStore - size of data in bytes

Returns:

the ratio of current size to the repository size limit. 0 if there are no limits.

prepareStorageDirectory

protected void prepareStorageDirectory()
                                throws IOException

Create the directory returned by getPath() if it does not yet exist.

Throws:

IOException - in case the directory cannot be created or exists and is not a directory or cannot be accessed

removeConnector

public void removeConnector()

Callback that is invoked if a connector is removed. Can be used for cleanup operations.

Specified by:

removeConnector in interface RepositoryConnector

storeContent

public ContentId storeContent(AttachmentTO contentTo)
                       throws ContentRepositoryException

Store the given ContentTO and return a ContentId for it.

Specified by:

storeContent in interface RepositoryConnector

Returns:

A ContentId object containing the ID for the stored ContentTO.

Throws:

ContentRepositoryException - in case storing the content failed

updateMetadata

public void updateMetadata(ContentMetadata metadata)
                    throws ContentRepositoryException

Update the metadata of existing content with the provided metadata. The ContentId of the content to update is contained in the according metadata field.

Specified by:

updateMetadata in interface MetadataRepositoryConnector

Parameters:

metadata - The ContentMetadata to update.

Throws:

ContentRepositoryException - in case the metadata cannot be updated.