com.communote.server.core.storing

Class ResourceStoringManagementBase

java.lang.Object

com.communote.server.core.storing.ResourceStoringManagementBase

All Implemented Interfaces:

ResourceStoringManagement

Direct Known Subclasses:

ResourceStoringManagementImpl

@Transactional(propagation=REQUIRED)
public abstract class ResourceStoringManagementBase
extends Object
implements ResourceStoringManagement

Spring Service base class for com.communote.server.service.storing.ResourceStoringManagement, provides access to all services and entities referenced by this service.

Author:

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

See Also:

ResourceStoringManagement

Constructor Summary

Constructors

Constructor and Description
ResourceStoringManagementBase()

Method Summary

Modifier and Type	Method and Description
void	deleteAttachment(Long attachmentId) Deletes an attachment.
void	deleteOrphanedAttachments(Collection<Long> attachmentIds) Deletes all provided attachments that are not connected to a note.
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
protected abstract void	handleDeleteAttachment(Long attachmentId) Performs the core logic for deleteAttachment(Long)
protected abstract void	handleDeleteOrphanedAttachments(Collection<Long> attachmentIds) Performs the core logic for deleteOrphanedAttachments(java.util.Collection)
protected abstract AttachmentTO	handleGetAttachment(ContentId contentId) Performs the core logic for getAttachment(com.communote.server.core.crc.vo.ContentId)
protected abstract AttachmentTO	handleGetAttachment(Long attachmentId) Performs the core logic for getAttachment(Long)
protected abstract <T> Collection<T>	handleGetAttachmentsOfNote(Long noteId, Collection<Long> attachmentIdsToFilter, Converter<Attachment,T> converter) Return the attachments of a note converted with the help of the provided converter
protected abstract Attachment	handleStoreAttachment(AttachmentTO attachment) Performs the core logic for storeAttachment(com.communote.server.core.vo.content.AttachmentTO)
protected abstract Attachment	handleStoreCopyOfAttachment(Attachment contentResource) Performs the core logic for storeCopyOfAttachment(Attachment)
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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.communote.server.core.storing.ResourceStoringManagement

addAttachmentStoringPreProcessor, assertReadAccess, assertWriteAccess, deleteOrphanedAttachments, getNoteOfAttachment, getNoteOfAttachment, migrateContentTypeEmptyAttachments, removeAttachmentStoringPreProcessor

Constructor Detail

ResourceStoringManagementBase

public ResourceStoringManagementBase()

Method Detail

deleteAttachment

public void deleteAttachment(Long attachmentId)
                      throws AttachmentStillAssignedException,
                             AuthorizationException

Deletes an attachment.

Specified by:

deleteAttachment in interface ResourceStoringManagement

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

public void deleteOrphanedAttachments(Collection<Long> attachmentIds)
                               throws AuthorizationException

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

Specified by:

deleteOrphanedAttachments in interface ResourceStoringManagement

Parameters:

attachmentIds - the IDs of the attachments to delete

Throws:

AuthorizationException

getAttachment

@Transactional(readOnly=true)
public 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.

Specified by:

getAttachment in interface ResourceStoringManagement

Throws:

ContentRepositoryException

AuthorizationException

getAttachment

@Transactional(readOnly=true)
public AttachmentTO getAttachment(Long attachmentId)
                                                         throws ContentRepositoryException,
                                                                AuthorizationException,
                                                                AttachmentNotFoundException

Description copied from interface: ResourceStoringManagement

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

Specified by:

getAttachment in interface ResourceStoringManagement

Parameters:

attachmentId - the ID of the attachment

Throws:

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

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

getAttachmentsOfNote

@Transactional(readOnly=true)
public <T> Collection<T> getAttachmentsOfNote(Long noteId,
                                                                            Collection<Long> attachmentIdsToFilter,
                                                                            Converter<Attachment,T> converter)
                                                                     throws AuthorizationException,
                                                                            NotFoundException

Description copied from interface: ResourceStoringManagement

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

Specified by:

getAttachmentsOfNote in interface ResourceStoringManagement

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:

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

NotFoundException - in case the note does not exist

handleDeleteAttachment

protected abstract void handleDeleteAttachment(Long attachmentId)
                                        throws AttachmentStillAssignedException,
                                               AuthorizationException

Performs the core logic for deleteAttachment(Long)

Throws:

AttachmentStillAssignedException

AuthorizationException

handleDeleteOrphanedAttachments

protected abstract void handleDeleteOrphanedAttachments(Collection<Long> attachmentIds)
                                                 throws AuthorizationException

Performs the core logic for deleteOrphanedAttachments(java.util.Collection)

Throws:

AuthorizationException

handleGetAttachment

protected abstract AttachmentTO handleGetAttachment(ContentId contentId)
                                             throws ContentRepositoryException,
                                                    AuthorizationException

Performs the core logic for getAttachment(com.communote.server.core.crc.vo.ContentId)

Throws:

ContentRepositoryException

AuthorizationException

handleGetAttachment

protected abstract AttachmentTO handleGetAttachment(Long attachmentId)
                                             throws ContentRepositoryException,
                                                    AuthorizationException,
                                                    AttachmentNotFoundException

Performs the core logic for getAttachment(Long)

Throws:

AttachmentNotFoundException

ContentRepositoryException

AuthorizationException

handleGetAttachmentsOfNote

protected abstract <T> Collection<T> handleGetAttachmentsOfNote(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:

Attachments of the given notes.

Throws:

NotFoundException - in case the note does not exist

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

handleStoreAttachment

protected abstract Attachment handleStoreAttachment(AttachmentTO attachment)
                                             throws AuthorizationException

Performs the core logic for storeAttachment(com.communote.server.core.vo.content.AttachmentTO)

Throws:

AuthorizationException

handleStoreCopyOfAttachment

protected abstract Attachment handleStoreCopyOfAttachment(Attachment contentResource)
                                                   throws AuthorizationException

Performs the core logic for storeCopyOfAttachment(Attachment)

Throws:

AuthorizationException

storeAttachment

public Attachment storeAttachment(AttachmentTO attachment)
                           throws AuthorizationException

Description copied from interface: ResourceStoringManagement

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.

Specified by:

storeAttachment in interface ResourceStoringManagement

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

public Attachment storeCopyOfAttachment(Attachment contentResource)
                                 throws AuthorizationException

Description copied from interface: ResourceStoringManagement

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

Specified by:

storeCopyOfAttachment in interface ResourceStoringManagement

Throws:

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