Package com.atlassian.confluence.api.impl.service.content

Class AttachmentServiceImpl

java.lang.Object

com.atlassian.confluence.api.impl.service.content.AttachmentServiceImpl

All Implemented Interfaces:

AttachmentService

public class AttachmentServiceImpl
extends Object
implements AttachmentService

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.confluence.api.service.content.AttachmentService

AttachmentService.AttachmentFinder, AttachmentService.Validator

Field Summary

Fields inherited from interface com.atlassian.confluence.api.service.content.AttachmentService

COMMENT_METADATA_KEY, FILE_SIZE, LABELS_METADATA_KEY, MEDIA_TYPE_METADATA_KEY

Constructor Summary

Constructors

Constructor	Description
AttachmentServiceImpl(PermissionManager permissionManager, ContentEntityManager contentEntityManager, FileUploadManager fileUploadManager, AttachmentManagerInternal attachmentManager, ContentFactory contentFactory, AttachmentContentTypeApiSupport binding, FinderProxyFactory finderProxyFactory, ContentTrashService trashService)

Method Summary

Modifier and Type	Method	Description
PageResponse<Content>	addAttachments(ContentId containerId, ContentStatus containerStatus, Collection<AttachmentUpload> uploads)	Add one or more attachments to a piece of Content.
PageResponse<Content>	addAttachments(ContentId containerId, ContentStatus containerStatus, Collection<AttachmentUpload> uploads, boolean allowDuplicated, Expansions expansions)	Add one or more attachments to a piece of Content.
PageResponse<Content>	addAttachments(ContentId containerId, Collection<AttachmentUpload> uploads)	Add one or more attachments to a piece of Content.
void	delete(Content attachmentContent)	Moves an Attachment to trash.
AttachmentService.AttachmentFinder	find(Expansion... expansions)	Creates an attachment finder for locating attachments.
void	moveAttachment(ContentId attachmentId, ContentId contentId, ContentId newContentId, String newName)	Move an attachment to a different content entity object and/or give it a new name.
void	removeAttachment(ContentId contentId, ContentId attachmentId)	Trashes an attachment by attachmentId
void	removeAttachmentVersion(ContentId contentId, ContentId attachmentId, int version)	removes a version of an attachment from page by attachmentId and version
Content	update(Content updatedContent)	Updates the non-data parts of an Attachment Content instance.
Content	updateData(ContentId attachmentId, AttachmentUpload upload)	Updates the data part of an Attachment Content instance.
com.atlassian.confluence.api.impl.service.content.AttachmentServiceImpl.ValidatorImpl	validator()	Provides a validator for validating actions on the AttachmentService and checking permissions related to attachments on Content

Methods inherited from class java.lang.Object

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

Constructor Details

AttachmentServiceImpl

public AttachmentServiceImpl(PermissionManager permissionManager,
 ContentEntityManager contentEntityManager,
 FileUploadManager fileUploadManager,
 AttachmentManagerInternal attachmentManager,
 ContentFactory contentFactory,
 AttachmentContentTypeApiSupport binding,
 FinderProxyFactory finderProxyFactory,
 ContentTrashService trashService)

Method Details

addAttachments

public PageResponse<Content> addAttachments(ContentId containerId,
 Collection<AttachmentUpload> uploads)
                                     throws ServiceException

Description copied from interface: AttachmentService

Add one or more attachments to a piece of Content.

Specified by:

addAttachments in interface AttachmentService

Parameters:

containerId - the id of the content to attach to

uploads - the attachments being uploaded

Returns:

the attachments added

Throws:

ServiceException

addAttachments

public PageResponse<Content> addAttachments(ContentId containerId,
 ContentStatus containerStatus,
 Collection<AttachmentUpload> uploads)
                                     throws ServiceException

Description copied from interface: AttachmentService

Add one or more attachments to a piece of Content.

Specified by:

addAttachments in interface AttachmentService

Parameters:

containerId - the id of the content to attach to

containerStatus - the status of the container, specifically allows adding attachments to drafts

uploads - the attachments being uploaded

Returns:

the attachments added

Throws:

ServiceException

addAttachments

public PageResponse<Content> addAttachments(ContentId containerId,
 ContentStatus containerStatus,
 Collection<AttachmentUpload> uploads,
 boolean allowDuplicated,
 Expansions expansions)
                                     throws ServiceException

Description copied from interface: AttachmentService

Add one or more attachments to a piece of Content.

Specified by:

addAttachments in interface AttachmentService

Parameters:

containerId - the id of the content to attach to

containerStatus - the status of the container, specifically allows adding attachments to drafts

uploads - the attachments being uploaded

expansions - the expansions to apply to the values returned after uploaded

Returns:

the attachments added

Throws:

ServiceException

find

public AttachmentService.AttachmentFinder find(Expansion... expansions)

Description copied from interface: AttachmentService

Creates an attachment finder for locating attachments.

Currently an attachment finder requires a Content container id, unless the attachment is being requested by its id via the "withId" method.

For example, to locate an attachment in a given page with a particular filename:

 

 Content attachment = attachmentService.find()
      .withContainerId(pageId)
      .withFilename("myfile.txt")
      .fetchOneOrNull();
 
 

Specified by:

find in interface AttachmentService

Parameters:

expansions - the expansions to apply to the values returned from a fetch

Returns:

an AttachmentFinder

removeAttachment

public void removeAttachment(ContentId contentId,
 ContentId attachmentId)
                      throws ServiceException

Description copied from interface: AttachmentService

Trashes an attachment by attachmentId

Specified by:

removeAttachment in interface AttachmentService

Parameters:

attachmentId - the id of the attachment to trash

Throws:

ServiceException - if the attachment cannot be found, or cannot be deleted

removeAttachmentVersion

public void removeAttachmentVersion(ContentId contentId,
 ContentId attachmentId,
 int version)
                             throws ServiceException

Description copied from interface: AttachmentService

removes a version of an attachment from page by attachmentId and version

Specified by:

removeAttachmentVersion in interface AttachmentService

Parameters:

contentId - the id of the page to remove the attachment from

attachmentId - the id of the attachment to remove

version - the version of the attachment to remove

Throws:

ServiceException - if the attachment cannot be found, or cannot be deleted

update

public Content update(Content updatedContent)
               throws ServiceException

Description copied from interface: AttachmentService

Updates the non-data parts of an Attachment Content instance.

This method can be used to update the container, filename, media-type and comment of an Attachment.

Specified by:

update in interface AttachmentService

Parameters:

updatedContent - the attachment to update, must include an id

Returns:

the updated attachment as stored in the database

Throws:

ServiceException

updateData

public Content updateData(ContentId attachmentId,
 AttachmentUpload upload)
                   throws ServiceException

Description copied from interface: AttachmentService

Updates the data part of an Attachment Content instance.

Specified by:

updateData in interface AttachmentService

Parameters:

attachmentId - the id of the attachment to update

upload - the new content of the Attachment

Returns:

the updated attachment as stored in the database

Throws:

ServiceException

moveAttachment

public void moveAttachment(ContentId attachmentId,
 ContentId contentId,
 ContentId newContentId,
 String newName)
                    throws ServiceException

Description copied from interface: AttachmentService

Move an attachment to a different content entity object and/or give it a new name.

Specified by:

moveAttachment in interface AttachmentService

Parameters:

attachmentId - ID for the attachment to be moved.

contentId - ID for the new content entity object that attachment is on.

newContentId - ID for the new content entity object that attachment should be on.

newName - Name of the new attachment (if being changed).

Throws:

ServiceException

delete

public void delete(Content attachmentContent)
            throws ServiceException

Description copied from interface: AttachmentService

Moves an Attachment to trash. Before Confluence 5.8 this used to remove the attachment without trashing it.

Specified by:

delete in interface AttachmentService

Parameters:

attachmentContent - the content to trash

Throws:

ServiceException - if the content cannot be found, or cannot be deleted

validator

public com.atlassian.confluence.api.impl.service.content.AttachmentServiceImpl.ValidatorImpl validator()

Description copied from interface: AttachmentService

Provides a validator for validating actions on the AttachmentService and checking permissions related to attachments on Content

Specified by:

validator in interface AttachmentService

Returns:

an attachmentService Validator