com.communote.server.core.crc

Interface RepositoryConnector

All Superinterfaces:

Serializable

All Known Subinterfaces:

MetadataRepositoryConnector

All Known Implementing Classes:

FilesystemConnector

public interface RepositoryConnector
extends Serializable

Connector to a repository which can store attachments

Author:

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

Method Summary

Modifier and Type	Method and Description
void	clearContent() Remove all content from the repository of this connector.
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.
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.
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.

Method Detail

clearContent

void clearContent()
           throws ContentRepositoryException

Remove all content from the repository of this connector.

Throws:

ContentRepositoryException - in case deleting the content failed

deleteContent

void deleteContent(ContentId contentId)
            throws ContentRepositoryException

Delete the content with the given ContentId.

Parameters:

contentId - The ContentId for the content to delete.

Throws:

ContentRepositoryException - in case deleting the content failed

getConfiguration

RepositoryConnectorConfiguration getConfiguration()

Returns:

the configuration of the connector

getContent

AttachmentTO getContent(ExtendedContentId contentId)
                 throws ContentRepositoryException

Returns a ContentTO that is associated with the given ContentId.

Parameters:

contentId - The ContentId for the ContentTO to be read.

Returns:

The read ContentTO.

Throws:

ContentRepositoryException - in case reading the content failed

getRepositorySize

long getRepositorySize()

Returns:

the current repository size in bytes

getRepositorySizeLimit

long getRepositorySizeLimit()

Returns:

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

getRepositorySizeLimitRatio

float getRepositorySizeLimitRatio()

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

Returns:

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

getRepositorySizeLimitRatio

float getRepositorySizeLimitRatio(long sizeOfNewDataToStore)

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

Parameters:

sizeOfNewDataToStore - size of data in bytes

Returns:

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

removeConnector

void removeConnector()
              throws ContentRepositoryException

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

Throws:

ContentRepositoryException

storeContent

ContentId storeContent(AttachmentTO contentTo)
                throws ContentRepositoryException

Store the given ContentTO and return a ContentId for it.

Parameters:

content - The ContentTO to store.

Returns:

A ContentId object containing the ID for the stored ContentTO.

Throws:

ContentRepositoryException - in case storing the content failed