com.communote.server.core.storing

Interface ResourceStoringManagement

All Known Implementing Classes:

ResourceStoringManagementBase, ResourceStoringManagementImpl

public interface ResourceStoringManagement

Service interface for attachment handling

Author:

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

Method Summary

Modifier and Type	Method and Description
void	addAttachmentStoringPreProcessor(AttachmentStoringPreProcessor processor) Method to add a new processor to the list of processors.
void	assertReadAccess(Long attachmentId) Assert that the current user has read access to the attachment
void	assertWriteAccess(Long attachmentId) Assert that the current user has access to edit the attachment
void	deleteAttachment(Long attachmentId) Deletes an attachment.
void	deleteOrphanedAttachments(Collection<Long> attachmentIds) Deletes all provided attachments that are not connected to a note.
int	deleteOrphanedAttachments(Date upperUploadDate) Remove all attachments which are not connected to a note and which are older than the given date.
AttachmentTO	getAttachment(ContentId contentId) Returns an attachment with the delivered content id.
AttachmentTO	getAttachment(Long attachmentId) Get an attachment by the given ID.
<T> Collection<T>	getAttachmentsOfNote(Long noteId, Collection<Long> attachmentIdsToFilter, Converter<Attachment,T> converter) Return the attachments of a note converted with the help of the provided converter
Long	getNoteOfAttachment(ContentId contentId) Get the note the given attachment is assigned to.
Long	getNoteOfAttachment(Long attachmentId) Get the note the given attachment is assigned to.
void	migrateContentTypeEmptyAttachments() Migrate the attachments with an empty content type
void	removeAttachmentStoringPreProcessor(AttachmentStoringPreProcessor processor) Method to remove a new processor from the list of registered processors.
Attachment	storeAttachment(AttachmentTO attachment) Store the attachment in the repository and return the created entity.
Attachment	storeCopyOfAttachment(Attachment contentResource) Create a copy of a stored attachment.

Method Detail

addAttachmentStoringPreProcessor

void addAttachmentStoringPreProcessor(AttachmentStoringPreProcessor processor)

Method to add a new processor to the list of processors.

Parameters:

processor - The processor.

assertReadAccess

void assertReadAccess(Long attachmentId)
               throws AuthorizationException,
                      AttachmentNotFoundException

Assert that the current user has read access to the attachment

Parameters:

attachmentId - the ID of the attachment

Throws:

AuthorizationException - in case the user has no read access

AttachmentNotFoundException - in case the attachment does not exist

assertWriteAccess

void assertWriteAccess(Long attachmentId)
                throws AuthorizationException,
                       AttachmentNotFoundException

Assert that the current user has access to edit the attachment

Parameters:

attachmentId - the ID of the attachment

Throws:

AuthorizationException - in case the user has no read access

AttachmentNotFoundException - in case the attachment does not exist

deleteAttachment

void deleteAttachment(Long attachmentId)
               throws AttachmentStillAssignedException,
                      AuthorizationException

Deletes an attachment.

Parameters:

attachmentId - the ID of attachment to delete

Throws:

AttachmentStillAssignedException - in case the attachment cannot be deleted because it is still assigned to the note

AuthorizationException - Thrown, when the current user is not allowed to remove the given attachment.

deleteOrphanedAttachments

int deleteOrphanedAttachments(Date upperUploadDate)
                       throws AuthorizationException

Remove all attachments which are not connected to a note and which are older than the given date.

Parameters:

upperUploadDate - Attachments must be older than this date.

Returns:

The number of removed attachments.

Throws:

AuthorizationException - in case the current user is not the internal system user

deleteOrphanedAttachments

void deleteOrphanedAttachments(Collection<Long> attachmentIds)
                        throws AuthorizationException

Deletes all provided attachments that are not connected to a note.

Parameters:

attachmentIds - the IDs of the attachments to delete

Throws:

AuthorizationException

getAttachment

AttachmentTO getAttachment(ContentId contentId)
                    throws ContentRepositoryException,
                           AuthorizationException

Returns an attachment with the delivered content id. This method checks if the current user has read access to the note the attachment belongs to.

Throws:

ContentRepositoryException

AuthorizationException

getAttachment

AttachmentTO getAttachment(Long attachmentId)
                    throws ContentRepositoryException,
                           AuthorizationException,
                           AttachmentNotFoundException

Get an attachment by the given ID. This method checks if the current user has read access to the note the attachment belongs to.

Parameters:

attachmentId - the ID of the attachment

Throws:

AuthorizationException - in case the current user has no access to the attachment. This is the case if the attachment was not yet published and the current user is not the uploader or the attachment is published and the current user has no access to the note of the attachment.

AttachmentNotFoundException - in case the attachment does not exist

ContentRepositoryException - in case the attachment data cannot be read from the content repository were it is stored

getAttachmentsOfNote

<T> Collection<T> getAttachmentsOfNote(Long noteId,
                                       Collection<Long> attachmentIdsToFilter,
                                       Converter<Attachment,T> converter)
                                throws AuthorizationException,
                                       NotFoundException

Return the attachments of a note converted with the help of the provided converter

Type Parameters:

T - The target type of the conversion

Parameters:

noteId - the ID of the note

attachmentIdsToFilter - optional collection of attachment IDs to filter the result by only adding those attachments whose ID is in the collection. If omitted all attachments will be considered.

converter - the converter to convert the found attachments

Returns:

Collection of all attachments for the given note.

Throws:

NotFoundException - in case the note does not exist

AuthorizationException - in case the current user has no read access to the note

getNoteOfAttachment

Long getNoteOfAttachment(ContentId contentId)
                  throws AuthorizationException

Get the note the given attachment is assigned to.

Parameters:

contentId - the content ID of the attachment

Returns:

the ID of the note or null if the attachment does not exists or is not is not yet published and thus not connected to a note

Throws:

AuthorizationException - in case the current user has no access to the note

getNoteOfAttachment

Long getNoteOfAttachment(Long attachmentId)
                  throws AuthorizationException

Get the note the given attachment is assigned to.

Parameters:

attachmentId - the ID of the attachment

Returns:

the ID of the note or null if the attachment does not exists or is not is not yet published and thus not connected to a note

Throws:

AuthorizationException - in case the current user has no access to the note

migrateContentTypeEmptyAttachments

void migrateContentTypeEmptyAttachments()

Migrate the attachments with an empty content type

removeAttachmentStoringPreProcessor

void removeAttachmentStoringPreProcessor(AttachmentStoringPreProcessor processor)

Method to remove a new processor from the list of registered processors.

Parameters:

processor - The processor.

storeAttachment

Attachment storeAttachment(AttachmentTO attachment)
                    throws AuthorizationException

Store the attachment in the repository and return the created entity. The uploader of attachment will be the current user or in case the current user is the internal system user, the user identified by the uploaderId.

Parameters:

attachment - TO containing the details of the attachment to store.

Returns:

The stored attachment.

Throws:

AuthorizationException - in case the current user is not the internal system or an authenticated Communote user

storeCopyOfAttachment

Attachment storeCopyOfAttachment(Attachment contentResource)
                          throws AuthorizationException

Create a copy of a stored attachment. The copy will be returned.

Throws:

AuthorizationException - in case the current user is not the internal system or an authenticated Communote user